Agents API

BatchUpdateResultItem

object

Result of a single connector update within a batch.

connectorIdstringrequired
successbooleanrequired
dataobject

Updated connector (present when success=True)

Show Child Parameters
errorstring

Error message (present when success=False)

Example

ConfigPageResponse

object

A real-time config page for one environment: its JSON Schema
definition plus the current variable values.

clientEnvstringrequired

Environment (sandbox, pre-release, live)

variablesobject

Config key-value pairs

schemaobject

JSON Schema (Draft 7) definition

lastUpdatedstring

ISO 8601 timestamp of last update

Example

ConnectorResponse

object

A connector: the voice, language, variant, and environment bundle
that handles incoming calls. Multiple phone numbers can share one
connector.

connectorIdstringrequired

Unique connector identifier

namestringrequired

Connector display name

accountIdstringrequired

Account this connector belongs to

projectIdstringrequired

Project this connector belongs to

clientEnvstringrequired

Client environment (sandbox, pre-release, live)

variantIdstringrequired

Assigned variant ID (empty string if unassigned)

asrLangCodestringrequired

ASR language code (e.g. en-US)

ttsLangCodestringrequired

TTS language code (e.g. en-US)

voiceNamestringrequired

Google TTS voice name (e.g. en-US-Neural2-A)

disableHandoffbooleanrequired

Whether call handoff is disabled

Example

CreateAgentBody

object
* Additional properties are NOT allowed.
namestringrequired

>= 1 characters<= 100 characters

agentIdstring

Match pattern:^[a-zA-Z0-9-]+$

responseSettingsobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
voiceSettingsobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
llmSettingsobject
* Additional properties are NOT allowed.
Show Child Parameters
experimentalConfigobject
* Additional properties are NOT allowed.
Show Child Parameters
Example

CreateAgentResponse

object
* Additional properties are NOT allowed.
accountIdstringrequired
agentIdstringrequired
agentNamestringrequired
createdAtstringrequired
updatedAtstringrequired
branchCountnumberrequired
Example