SocayoAgentConfig
Socayo-specific agent configuration (bundled)
Usage profiles
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
In requests
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
conversationKey | string | Required in requests | Conversation thread identifier associated with the voice session. Minimum length: 1. |
userId | string | Required in requests | Identifier of the user associated with the operation. Minimum length: 1. |
provider | string (AGENT_PROVIDER_PIPECAT_CLOUD, AGENT_PROVIDER_CEREBRIUM) or integer (int32) | Optional | Backend provider to use for session orchestration; defaults to PIPECAT_CLOUD |
tts | TTSConfig | Optional | Bundled sub-configs Speech-synthesis configuration supplied to the Socayo agent. |
heygen | HeyGenConfig | Optional | HeyGen avatar and voice configuration for the Socayo agent. |
transport | TransportConfig | Optional | Audio transport settings used by the Socayo agent. |
extras | Map from string to JSON value | Optional | Optional extras for forward-compat |
Values of provider
Hosting backend used to deploy or start a voice agent.
| Value | No. | Form | Meaning |
|---|---|---|---|
AGENT_PROVIDER_PIPECAT_CLOUD | 1 | Canonical | Use the Pipecat Cloud hosting backend. |
AGENT_PROVIDER_CEREBRIUM | 2 | Canonical | Use the Cerebrium hosting backend. |
Request validation
These rules apply when this value is supplied in a request. Request validation does not guarantee that response fields are present or satisfy the same rules.
| Applies to | Rule | Requirement |
|---|---|---|
conversationKey | Minimum length | 1 |
userId | Minimum length | 1 |
Where used
| Reference | Relationship |
|---|---|
| Create a voice session (in progress) | POST /api/v1/llm/create-daily-session |
Download the public reference contract.
Document: DOC-API-MODEL-socayo-agent-config.