Siro Agents API
The Agents API from Siro — 3 operation(s) for agents.
The Agents API from Siro — 3 operation(s) for agents.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/siro-agents-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
version: 1.0.0
title: Swagger Agents API
servers:
- url: https://api.siro.ai/
description: Siro API Gateway
tags:
- name: Agents
paths:
/v1/agents/run:
post:
summary: Issues a query to the Siro AI platform.
description: Executes a Siro AI agent with the given query and context. Supports streaming responses.
requestBody:
content:
application/json:
schema:
type: object
properties:
sessionId:
type: string
liveKitSessionId:
type: string
userQuery:
type: string
queryType:
type: string
enum:
- CHAT
- VOICE
- REPORT
queryEntrypoint:
type: string
enum:
- GENERIC
- ASK_SIRO
- CUSTOMER_PROFILE
- MANAGER_CHAT
- SCORECARDS
- FILM_ROOM
- SINGLE_RECORDING
- RE_ENGAGE
- UNIVERSAL_CHAT
- REP_CHAT
- DEBRIEF_CALL
- HALFTIME_LIVE_COACHING
- HALFTIME_REPORT
- ROLE_PLAY
- CONFIGURABLE_ROLE_PLAY
initialContext:
anyOf:
- type: object
properties:
data:
type: object
properties:
account:
type:
- object
- 'null'
properties:
id:
type: string
description: Customer ID
name:
type:
- string
- 'null'
description: Customer name
crmUrl:
type: string
description: URL to this customer in the linked CRM
customerType:
type: string
enum:
- ACCOUNT
- LEAD
- OPPORTUNITY
- ENGAGEMENT
- CONTACT
- DMS_OPPORTUNITY
lastActivityAt:
type:
- string
- 'null'
description: Last activity date
createdAt:
type: string
format: date-time
description: Date the Customer record was created in Siro
updatedAt:
type: string
format: date-time
description: Date the Customer record was last updated in Siro
closedAt:
type:
- string
- 'null'
format: date-time
description: Date the Customer was closed (applicable to Opportunities)
emailAddress:
type:
- string
- 'null'
description: Customer email addresses
phoneNumber:
type:
- string
- 'null'
description: Customer phone numbers
externalId:
type:
- string
- 'null'
description: Customer external ID
amount:
type:
- number
- 'null'
description: Dollar amount associated with a Customer deal
disposition:
type:
- string
- 'null'
description: 'Disposition for the Customer deal: "WON" | "LOST" | "OPEN"'
recordingId:
type:
- string
- 'null'
description: ID of the most recent recording linked to this customer
lastRecordingDate:
type:
- string
- 'null'
format: date-time
description: Datetime of the most recent recording linked to this customer
numRecordings:
type:
- number
- 'null'
description: Total number of recordings linked to this customer
matchingSource:
type:
- string
- 'null'
enum:
- DIRECT
- FUZZY
- NOT_FOUND
description: Source of matching
accountId:
type:
- string
- 'null'
description: Account ID
opportunityAccountName:
type:
- string
- 'null'
description: Account Name associated with the Opportunity
contactId:
type:
- string
- 'null'
description: Contact ID
opportunityContactName:
type:
- string
- 'null'
description: Contact Name associated with the Opportunity
opportunityId:
type:
- string
- 'null'
description: Opportunity ID
engagementId:
type:
- string
- 'null'
description: Engagement ID
opportunity:
type:
- object
- 'null'
properties:
id:
type: string
externalId:
type: string
description: The ID of the opportunity in the external system (e.g. Salesforce)
name:
type:
- string
- 'null'
description: The name of the opportunity
amount:
type: number
description: The dollar amount of the opportunity
closedAt:
type: string
description: The closure date of the opportunity
disposition:
type: string
description: '"WON" | "LOST" | "OPEN"'
createdAt:
type: string
description: The date the opportunity was created
updatedAt:
type: string
description: The date the opportunity was last updated
recordingId:
type: string
description: The ID of the recording associated to the opportunity
accountId:
type: string
organizationId:
type: string
account: {}
opportunityUsers:
type: array
items: {}
required:
- id
- externalId
- createdAt
- updatedAt
- organizationId
description: Opportunity
opportunities:
type:
- object
- 'null'
properties:
data:
type: array
items:
type: object
properties:
id:
type: string
externalId:
type: string
description: The ID of the opportunity in the external system (e.g. Salesforce)
name:
type:
- string
- 'null'
description: The name of the opportunity
amount:
type: number
description: The dollar amount of the opportunity
closedAt:
type: string
description: The closure date of the opportunity
disposition:
type: string
description: '"WON" | "LOST" | "OPEN"'
createdAt:
type: string
description: The date the opportunity was created
updatedAt:
type: string
description: The date the opportunity was last updated
recordingId:
type: string
description: The ID of the recording associated to the opportunity
accountId:
type: string
organizationId:
type: string
account: {}
opportunityUsers:
type: array
items: {}
required:
- id
- externalId
- createdAt
- updatedAt
- organizationId
cursor:
type:
- string
- 'null'
required:
- data
description: Optional first page of related opportunities for Accounts or Contacts
opportunityUsers:
type:
- array
- 'null'
items: {}
description: Users associated with the opportunity
contactAccount:
type:
- object
- 'null'
properties:
id:
type: string
name:
type:
- string
- 'null'
description: The name of the account
externalId:
type:
- string
- 'null'
description: The ID of the account in the external system (e.g. Salesforce)
required:
- id
description: Contact Account
address:
type:
- string
- 'null'
description: Address
organizationId:
type: string
description: Organization ID
integrationConnectionId:
type:
- string
- 'null'
description: Integration Connection ID
integrationPlatform:
type:
- string
- 'null'
enum:
- MERGE
- SIRO_CUSTOM_INPUT
- SERVICE_TITAN
- COMPANY_CAM
- INGAGE
- LEAD_PERFECTION
- SPOTIO
description: Integration Platform
integrationName:
type:
- string
- 'null'
description: Integration Name
required:
- id
- createdAt
- updatedAt
- organizationId
lead:
type:
- object
- 'null'
properties:
id:
type: string
description: Customer ID
name:
type:
- string
- 'null'
description: Customer name
crmUrl:
type: string
description: URL to this customer in the linked CRM
customerType:
type: string
enum:
- ACCOUNT
- LEAD
- OPPORTUNITY
- ENGAGEMENT
- CONTACT
- DMS_OPPORTUNITY
lastActivityAt:
type:
- string
- 'null'
description: Last activity date
createdAt:
type: string
format: date-time
description: Date the Customer record was created in Siro
updatedAt:
type: string
format: date-time
description: Date the Customer record was last updated in Siro
closedAt:
type:
- string
- 'null'
format: date-time
description: Date the Customer was closed (applicable to Opportunities)
emailAddress:
type:
- string
- 'null'
description: Customer email addresses
phoneNumber:
type:
- string
- 'null'
description: Customer phone numbers
externalId:
type:
- string
- 'null'
description: Customer external ID
amount:
type:
- number
- 'null'
description: Dollar amount associated with a Customer deal
disposition:
type:
- string
- 'null'
description: 'Disposition for the Customer deal: "WON" | "LOST" | "OPEN"'
recordingId:
type:
- string
- 'null'
description: ID of the most recent recording linked to this customer
lastRecordingDate:
type:
- string
- 'null'
format: date-time
description: Datetime of the most recent recording linked to this customer
numRecordings:
type:
- number
- 'null'
description: Total number of recordings linked to this customer
matchingSource:
type:
- string
- 'null'
enum:
- DIRECT
- FUZZY
- NOT_FOUND
description: Source of matching
accountId:
type:
- string
- 'null'
description: Account ID
opportunityAccountName:
type:
- string
- 'null'
description: Account Name associated with the Opportunity
contactId:
type:
- string
- 'null'
description: Contact ID
opportunityContactName:
type:
- string
- 'null'
description: Contact Name associated with the Opportunity
opportunityId:
type:
- string
- 'null'
description: Opportunity ID
engagementId:
type:
- string
- 'null'
description: Engagement ID
opportunity:
type:
- object
- 'null'
properties:
id:
type: string
externalId:
type: string
description: The ID of the opportunity in the external system (e.g. Salesforce)
name:
type:
- string
- 'null'
description: The name of the opportunity
amount:
type: number
description: The dollar amount of the opportunity
closedAt:
type: string
description: The closure date of the opportunity
disposition:
type: string
description: '"WON" | "LOST" | "OPEN"'
createdAt:
type: string
description: The date the opportunity was created
updatedAt:
type: string
description: The date the opportunity was last updated
recordingId:
type: string
description: The ID of the recording associated to the opportunity
accountId:
type: string
organizationId:
type: string
account: {}
opportunityUsers:
type: array
items: {}
required:
- id
- externalId
- createdAt
- updatedAt
- organizationId
description: Opportunity
opportunities:
type:
- object
- 'null'
properties:
data:
type: array
items:
type: object
properties:
id:
type: string
externalId:
type: string
description: The ID of the opportunity in the external system (e.g. Salesforce)
name:
type:
- string
- 'null'
description: The name of the opportunity
amount:
type: number
description: The dollar amount of the opportunity
closedAt:
type: string
description: The closure date of the opportunity
disposition:
type: string
description: '"WON" | "LOST" | "OPEN"'
createdAt:
type: string
description: The date the opportunity was created
updatedAt:
type: string
description: The date the opportunity was last updated
recordingId:
type: string
description: The ID of the recording associated to the opportunity
accountId:
type: string
organizationId:
type: string
account: {}
opportunityUsers:
type: array
items: {}
required:
- id
- externalId
- createdAt
- updatedAt
- organizationId
cursor:
type:
- string
- 'null'
required:
- data
description: Optional first page of related opportunities for Accounts or Contacts
opportunityUsers:
type:
- array
- 'null'
items: {}
description: Users associated with the opportunity
contactAccount:
type:
- object
- 'null'
properties:
id:
type: string
name:
type:
- string
- 'null'
description: The name of the account
externalId:
type:
- string
- 'null'
description: The ID of the account in the external system (e.g. Salesforce)
required:
- id
description: Contact Account
address:
type:
- string
- 'null'
description: Address
organizationId:
type: string
description: Organization ID
integrationConnectionId:
type:
- string
- 'null'
description: Integration Connection ID
integrationPlatform:
type:
- string
- 'null'
enum:
- MERGE
- SIRO_CUSTOM_INPUT
- SERVICE_TITAN
- COMPANY_CAM
- INGAGE
- LEAD_PERFECTION
- SPOTIO
description: Integration Platform
integrationName:
type:
- string
- 'null'
description: Integration Name
required:
- id
- createdAt
- updatedAt
- organizationId
contacts:
type: array
items:
type: object
properties:
id:
type: string
description: Customer ID
name:
type:
- string
- 'null'
description: Customer name
crmUrl:
type: string
description: URL to this customer in the linked CRM
customerType:
type: string
enum:
- ACCOUNT
- LEAD
- OPPORTUNITY
- ENGAGEMENT
- CONTACT
- DMS_OPPORTUNITY
lastActivityAt:
type:
- string
- 'null'
description: Last activity date
createdAt:
type: string
format: date-time
description: Date the Customer record was created in Siro
# --- truncated at 32 KB (89 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/siro/refs/heads/main/openapi/siro-agents-api-openapi.yml