HeyGenConfig
HeyGen avatar/video configuration
Usage profiles
| Usage | Fields and validation |
|---|---|
| In requests | View fields |
In requests
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
enabled | boolean | Optional | Whether this configuration is enabled. |
avatarId | string | Optional | Identifier of the HeyGen avatar used for the session. |
version | string | Optional | Version of the resource represented by this message. |
quality | string | Optional | Video-quality setting requested for the HeyGen avatar. |
videoEncoding | string | Optional | Video codec requested for the HeyGen avatar stream. |
voice | HeyGenVoiceSettings | Optional | Voice configuration used by the HeyGen avatar. |
knowledgeId | string | Optional | Identifier of the HeyGen knowledge resource associated with the avatar. |
knowledgeBase | string | Optional | Knowledge text supplied to the HeyGen avatar configuration. |
disableIdleTimeout | boolean | Optional | Whether HeyGen’s session idle timeout is disabled. |
activityIdleTimeout | number (double) or string (NaN, Infinity, -Infinity) | Optional | HeyGen activity idle timeout, in seconds. |
Where used
| Reference | Relationship |
|---|---|
| Create a voice session (in progress) | POST /api/v1/llm/create-daily-session |
| SocayoAgentConfig | Nested in model |
Download the public reference contract.
Document: DOC-API-MODEL-hey-gen-config.