Skip to main content
POST
Create a voice agent

Autorisierungen

Authorization
string
header
erforderlich

Scoped API token. Required scopes are listed on each operation in x-required-scopes.

Body

application/json

Flat JSON object. Unknown top-level keys are ignored. The nested sections are validated exactly as in the settings endpoints; if any value is rejected, nothing is created (HTTP 422). A tools key is rejected: create and enable tools with the Tools endpoints after the agent exists.

name
string
erforderlich

Display name of the agent.

Minimum string length: 1
description
string

Free-text description shown in the dashboard.

prompt
object

Prompt settings. Keys may also be given in dotted form (prompts.user_prompt). Unknown keys return 422.

voice_config
object

Dotted voice settings keys as listed by GET /api/v1/voice_agents/{id}/concerns/voice_config/schema, for example voice_config.response_time_ms. Unknown keys return 422.

knowledge_base
object

Knowledge sources to attach to the agent's prompt.

Antwort

The created voice agent.

id
integer
erforderlich

ID of the voice agent.

name
string | null
erforderlich

Display name of the agent.

description
string
erforderlich

Empty string when no description is set.

created_at
string<date-time>
erforderlich

When the agent was created.

updated_at
string<date-time>
erforderlich

When the agent or its prompt was last changed.

concerns
object
erforderlich

URLs of this agent's settings endpoints.