Section ID:
Values of
Section ID:
DOC-API-MODEL-schema-phip2o3ju4#overview
SocayoAgentConfig
Socayo-specific agent configuration (bundled)
Meaning and usage
Section ID: DOC-API-MODEL-schema-phip2o3ju4#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-phip2o3ju4#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
In requests
Section ID: DOC-API-MODEL-schema-phip2o3ju4#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-phip2o3ju4#field-conversationkeySection ID: DOC-API-MODEL-schema-phip2o3ju4#request-field-conversationkeyconversationKey | string | Required in requests | Conversation thread identifier associated with the voice session. Minimum length: 1. |
Section ID: DOC-API-MODEL-schema-phip2o3ju4#field-useridSection ID: DOC-API-MODEL-schema-phip2o3ju4#request-field-useriduserId | string | Required in requests | Identifier of the user associated with the operation. Minimum length: 1. |
Section ID: DOC-API-MODEL-schema-phip2o3ju4#field-providerSection ID: DOC-API-MODEL-schema-phip2o3ju4#request-field-providerprovider | string (AGENT_PROVIDER_PIPECAT_CLOUD, AGENT_PROVIDER_CEREBRIUM) or integer (int32) | Optional; explicit presence | Backend provider to use for session orchestration; defaults to PIPECAT_CLOUD |
Section ID: DOC-API-MODEL-schema-phip2o3ju4#field-ttsSection ID: DOC-API-MODEL-schema-phip2o3ju4#request-field-ttstts | TTSConfig | Optional | Bundled sub-configs Speech-synthesis configuration supplied to the Socayo agent. |
Section ID: DOC-API-MODEL-schema-phip2o3ju4#field-heygenSection ID: DOC-API-MODEL-schema-phip2o3ju4#request-field-heygenheygen | HeyGenConfig | Optional | HeyGen avatar and voice configuration for the Socayo agent. |
Section ID: DOC-API-MODEL-schema-phip2o3ju4#field-transportSection ID: DOC-API-MODEL-schema-phip2o3ju4#request-field-transporttransport | TransportConfig | Optional | Audio transport settings used by the Socayo agent. |
Section ID: DOC-API-MODEL-schema-phip2o3ju4#field-extrasSection ID: DOC-API-MODEL-schema-phip2o3ju4#request-field-extrasextras | Map from string to JSON value | Optional | Optional extras for forward-compat |
Values of provider
Section ID: DOC-API-MODEL-schema-phip2o3ju4#request-values-provider
Hosting backend used to deploy or start a voice agent.
| Value | No. | Form | Meaning |
|---|---|---|---|
AGENT_PROVIDER_PIPECAT_CLOUD | 0 | Canonical | Use the Pipecat Cloud hosting backend. |
AGENT_PROVIDER_CEREBRIUM | 1 | Canonical | Use the Cerebrium hosting backend. |
DOC-API-MODEL-schema-phip2o3ju4#validation
Request validation
Section ID: DOC-API-MODEL-schema-phip2o3ju4#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
Section ID: DOC-API-MODEL-schema-phip2o3ju4#where-used
| Reference | Relationship |
|---|---|
| Create a voice session (in progress) | POST /api/v1/llm/create-daily-session |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-phip2o3ju4