Section ID:
DOC-API-MODEL-schema-pd3vbf0eel#overview
HeyGenConfig
HeyGen avatar/video configuration
Meaning and usage
Section ID: DOC-API-MODEL-schema-pd3vbf0eel#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-pd3vbf0eel#fields
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
In requests
Section ID: DOC-API-MODEL-schema-pd3vbf0eel#request
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-pd3vbf0eel#field-enabledSection ID: DOC-API-MODEL-schema-pd3vbf0eel#request-field-enabledenabled | boolean | Optional | Whether this configuration is enabled. |
Section ID: DOC-API-MODEL-schema-pd3vbf0eel#field-avataridSection ID: DOC-API-MODEL-schema-pd3vbf0eel#request-field-avataridavatarId | string | Optional | Identifier of the HeyGen avatar used for the session. |
Section ID: DOC-API-MODEL-schema-pd3vbf0eel#field-versionSection ID: DOC-API-MODEL-schema-pd3vbf0eel#request-field-versionversion | string | Optional | Version of the resource represented by this message. |
Section ID: DOC-API-MODEL-schema-pd3vbf0eel#field-qualitySection ID: DOC-API-MODEL-schema-pd3vbf0eel#request-field-qualityquality | string | Optional | See meaning below. |
Section ID: DOC-API-MODEL-schema-pd3vbf0eel#field-videoencodingSection ID: DOC-API-MODEL-schema-pd3vbf0eel#request-field-videoencodingvideoEncoding | string | Optional | See meaning below. |
Section ID: DOC-API-MODEL-schema-pd3vbf0eel#field-voiceSection ID: DOC-API-MODEL-schema-pd3vbf0eel#request-field-voicevoice | HeyGenVoiceSettings | Optional | Voice configuration used by the HeyGen avatar. |
Section ID: DOC-API-MODEL-schema-pd3vbf0eel#field-knowledgeidSection ID: DOC-API-MODEL-schema-pd3vbf0eel#request-field-knowledgeidknowledgeId | string | Optional | Identifier of the HeyGen knowledge resource associated with the avatar. |
Section ID: DOC-API-MODEL-schema-pd3vbf0eel#field-knowledgebaseSection ID: DOC-API-MODEL-schema-pd3vbf0eel#request-field-knowledgebaseknowledgeBase | string | Optional | Knowledge text supplied to the HeyGen avatar configuration. |
Section ID: DOC-API-MODEL-schema-pd3vbf0eel#field-disableidletimeoutSection ID: DOC-API-MODEL-schema-pd3vbf0eel#request-field-disableidletimeoutdisableIdleTimeout | boolean | Optional | Whether HeyGen’s session idle timeout is disabled. |
Section ID: DOC-API-MODEL-schema-pd3vbf0eel#field-activityidletimeoutSection ID: DOC-API-MODEL-schema-pd3vbf0eel#request-field-activityidletimeoutactivityIdleTimeout | number (double) or string (NaN, Infinity, -Infinity) | Optional | See meaning below. |
quality
Video-quality setting requested for the HeyGen avatar.
"high" | "medium" | "low"
videoEncoding
Video codec requested for the HeyGen avatar stream.
"H264" | "VP8"
activityIdleTimeout
HeyGen activity idle timeout, in seconds.
seconds
Where used
Section ID: DOC-API-MODEL-schema-pd3vbf0eel#where-used
| Reference | Relationship |
|---|---|
| Create a voice session (in progress) | POST /api/v1/llm/create-daily-session |
Models containing this value
| Model | Relationship |
|---|---|
| SocayoAgentConfig | Nested in model |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-pd3vbf0eel