KosmoKrator ai
Use the HeyGen CLI from KosmoKrator to call HeyGen tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.
HeyGen can be configured headlessly with `kosmokrator integrations:configure heygen`.
# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash
# Configure and verify this integration.
kosmokrator integrations:configure heygen --set access_token="$HEYGEN_ACCESS_TOKEN" --enable --read allow --write ask --json
kosmokrator integrations:doctor heygen --json
kosmokrator integrations:status --json
Authentication type: Bearer token bearer_token. Configure credentials once, then use the same stored profile from
scripts, coding CLIs, Lua code mode, and the MCP gateway.
| Key | Env var | Type | Required | Label |
|---|---|---|---|---|
access_token | HEYGEN_ACCESS_TOKEN | Secret secret | yes | Access Token |
url | HEYGEN_URL | URL url | no | API Base URL |
Use the generic call form when another coding CLI or script needs a stable universal interface.
kosmo integrations:call heygen.heygen_list_videos '{
"limit": 1,
"offset": 1
}' --jsonUse the provider shortcut form for shorter human-facing commands.
kosmo integrations:heygen heygen_list_videos '{
"limit": 1,
"offset": 1
}' --jsonThese commands return structured output for coding agents that need to inspect capabilities before choosing a function.
kosmo integrations:docs heygen --json
kosmo integrations:docs heygen.heygen_list_videos --json
kosmo integrations:schema heygen.heygen_list_videos --json
kosmo integrations:search "HeyGen" --json
kosmo integrations:list --jsonEvery function below can be called headlessly. The generic form is stable across all integrations; the provider shortcut is shorter but specific to HeyGen.
heygen.heygen_list_videosread List generated videos from HeyGen. Returns video IDs, statuses, and metadata. Use limit and offset for pagination.
kosmo integrations:call heygen.heygen_list_videos '{"limit":1,"offset":1}' --jsonkosmo integrations:heygen heygen_list_videos '{"limit":1,"offset":1}' --jsonheygen.heygen_get_videoread Get the status and details of a specific HeyGen video. Returns the video status (pending, processing, completed, failed), download URL when ready, and metadata.
kosmo integrations:call heygen.heygen_get_video '{"video_id":"example_video_id"}' --jsonkosmo integrations:heygen heygen_get_video '{"video_id":"example_video_id"}' --jsonheygen.heygen_create_videowrite Generate a new AI video on HeyGen. Provide video_inputs defining scenes (avatar, voice, script), optional dimensions, and test mode. Returns a video_id to track generation progress.
kosmo integrations:call heygen.heygen_create_video '{"video_inputs":"example_video_inputs","dimension":"example_dimension","test":true}' --jsonkosmo integrations:heygen heygen_create_video '{"video_inputs":"example_video_inputs","dimension":"example_dimension","test":true}' --jsonheygen.heygen_list_avatarsread List all available talking avatars from HeyGen. Returns avatar IDs, names, preview images, and supported styles. Use avatar IDs when creating videos.
kosmo integrations:call heygen.heygen_list_avatars '{}' --jsonkosmo integrations:heygen heygen_list_avatars '{}' --jsonheygen.heygen_list_voicesread List all available voices from HeyGen. Returns voice IDs, display names, supported languages, gender, and preview audio URLs. Use voice IDs when creating videos.
kosmo integrations:call heygen.heygen_list_voices '{}' --jsonkosmo integrations:heygen heygen_list_voices '{}' --jsonheygen.heygen_get_current_userread Get the current authenticated HeyGen user's account information, including plan details, remaining credits, and usage statistics.
kosmo integrations:call heygen.heygen_get_current_user '{}' --jsonkosmo integrations:heygen heygen_get_current_user '{}' --jsonheygen.heygen_list_templatesread List available video templates from HeyGen. Returns template IDs, names, thumbnails, and metadata. Use limit and offset for pagination.
kosmo integrations:call heygen.heygen_list_templates '{"limit":1,"offset":1}' --jsonkosmo integrations:heygen heygen_list_templates '{"limit":1,"offset":1}' --jsonUse these parameter tables when building CLI payloads without calling integrations:schema first.
heygen.heygen_list_videosList generated videos from HeyGen. Returns video IDs, statuses, and metadata. Use limit and offset for pagination.
readkosmo integrations:schema heygen.heygen_list_videos --json| Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | no | Maximum number of videos to return (default: 10, max: 100). |
offset | integer | no | Number of videos to skip for pagination (default: 0). |
heygen.heygen_get_videoGet the status and details of a specific HeyGen video. Returns the video status (pending, processing, completed, failed), download URL when ready, and metadata.
readkosmo integrations:schema heygen.heygen_get_video --json| Parameter | Type | Required | Description |
|---|---|---|---|
video_id | string | yes | The unique identifier of the video to retrieve. |
heygen.heygen_create_videoGenerate a new AI video on HeyGen. Provide video_inputs defining scenes (avatar, voice, script), optional dimensions, and test mode. Returns a video_id to track generation progress.
writekosmo integrations:schema heygen.heygen_create_video --json| Parameter | Type | Required | Description |
|---|---|---|---|
video_inputs | array | yes | Array of video input objects. Each defines a scene with properties like character (avatar_id, voice_id), voice_settings, script, and background. Example: [{"character":{"avatar_id":"...","voice_id":"..."},"script":"Hello world"}] |
dimension | array | no | Video dimensions as an object with width and height. Example: {"width": 1920, "height": 1080}. Defaults to 1920x1080 if omitted. |
test | boolean | no | Set to true to generate a test (preview) video. Defaults to false. |
heygen.heygen_list_avatarsList all available talking avatars from HeyGen. Returns avatar IDs, names, preview images, and supported styles. Use avatar IDs when creating videos.
readkosmo integrations:schema heygen.heygen_list_avatars --json| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
heygen.heygen_list_voicesList all available voices from HeyGen. Returns voice IDs, display names, supported languages, gender, and preview audio URLs. Use voice IDs when creating videos.
readkosmo integrations:schema heygen.heygen_list_voices --json| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
heygen.heygen_get_current_userGet the current authenticated HeyGen user's account information, including plan details, remaining credits, and usage statistics.
readkosmo integrations:schema heygen.heygen_get_current_user --json| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
heygen.heygen_list_templatesList available video templates from HeyGen. Returns template IDs, names, thumbnails, and metadata. Use limit and offset for pagination.
readkosmo integrations:schema heygen.heygen_list_templates --json| Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | no | Maximum number of templates to return (default: 10, max: 100). |
offset | integer | no | Number of templates to skip for pagination (default: 0). |
Headless calls still follow the integration read/write permission policy. Configure read/write defaults
with integrations:configure. Add --force only for trusted automation that should bypass that policy.