agentIdstringrequired
clientEnvstringrequired
Upsert the JSON Schema for a config page
put
https://api.dev.poly.ai/v1/agents/{agentId}/real-time-configs/{clientEnv}/schema
Path Parameters
Body
application/json
Body
application/json
UpdateConfigSchemaBody
The JSON Schema definition to apply to a config page.
schemaobjectrequired
JSON Schema (Draft 7) definition
Response
application/json
Response
application/json
Successful response
GetConfigPageResponse
A single config page for one environment.
clientEnvstringrequired
Environment (sandbox, pre-release, live)
variablesobject
Config key-value pairs
schemaobject
JSON Schema (Draft 7) definition
lastUpdatedstring
ISO 8601 timestamp of last update
put/v1/agents/{agentId}/real-time-configs/{clientEnv}/schema
Authentication
Path Parameters
Body
{
"schema": {}
}
application/json
Update config variables for an environment
patch
https://api.dev.poly.ai/v1/agents/{agentId}/real-time-configs/{clientEnv}/variables
Path Parameters
agentIdstringrequired
clientEnvstringrequired
Body
application/json
Body
application/json
UpdateConfigVariablesBody
Variables to shallow-merge into an environment’s config page.
variablesobjectrequired
Key-value pairs to merge into the existing config
Response
application/json
Response
application/json
Successful response
GetConfigPageResponse
A single config page for one environment.
clientEnvstringrequired
Environment (sandbox, pre-release, live)
variablesobject
Config key-value pairs
schemaobject
JSON Schema (Draft 7) definition
lastUpdatedstring
ISO 8601 timestamp of last update
patch/v1/agents/{agentId}/real-time-configs/{clientEnv}/variables
Authentication
Path Parameters
Body
{
"variables": {}
}
application/json
List all connectors for a project
get
https://api.dev.poly.ai/v1/agents/{agentId}/telephony/connectors
Path Parameters
agentIdstringrequired
Response
application/json
Response
application/json
Successful response
GetConnectorsResponse
Every connector in the project.
connectorsarray[object]required
A connector: the voice, language, variant, and environment bundle
that handles incoming calls. Multiple phone numbers can share one
connector.
Show Child Parameters
get/v1/agents/{agentId}/telephony/connectors
Authentication
Path Parameters
application/json
Batch get connectors by ID
post
https://api.dev.poly.ai/v1/agents/{agentId}/telephony/connectors/batch
Path Parameters
agentIdstringrequired
Body
application/json
Body
application/json
BatchGetConnectorsBody
Set of connector IDs to retrieve in a single call.
connectorIdsarray[string]required
List of connector IDs to retrieve
>= 1 items
Response
application/json
Response
application/json
Successful response
BatchGetConnectorsResponse
Result of a batch connector lookup, partitioned into connectors that
were found and IDs that weren’t.
foundarray[object]required
A connector: the voice, language, variant, and environment bundle
that handles incoming calls. Multiple phone numbers can share one
connector.
Show Child Parameters
notFoundarray[string]required
post/v1/agents/{agentId}/telephony/connectors/batch
Authentication
Path Parameters
Body
{
"connectorIds": [
"[]"
]
}
application/json
Batch update connectors
patch
https://api.dev.poly.ai/v1/agents/{agentId}/telephony/connectors/batch
Path Parameters
agentIdstringrequired
Body
application/json
Body
application/json
BatchUpdateConnectorsBody
Ordered list of connector updates.
Each update is applied independently — partial success is possible.
updatesarray[object]required
A single connector update within a batch update request.
>= 1 items
Show Child Parameters
Response
application/json
Response
application/json
Successful response
BatchUpdateConnectorsResponse
Per-connector results from a batch update.
Each entry reports success or failure independently.
resultsarray[object]required
Result of a single connector update within a batch.
Show Child Parameters
patch/v1/agents/{agentId}/telephony/connectors/batch
Authentication
Path Parameters
Body
{
"updates": [
{
"connectorId": "connectorId"
}
]
}
application/json