Sign in

v1

latestOpenAPI 3.1.0raw.githubusercontent.com2025-06-20101018.4 KB
agent

Create Agent

Create an agent.

post/v1/agent

Request body

avatar_idstring required

The ID of the avatar to use.

system_promptstring required

The system prompt to use.

namestring nullable

The agent name.

languagestring nullable

The language to use.

greetingstring nullable

What to say at the start of the session.

max_session_length_minutesinteger nullable

The maximum session length in minutes.

capabilitiesDeveloperAgentCapability[]

The agent capabilities.

Example request

{
  "avatar_id": "01234567-89ab-cdef-0123-456789abcdef",
  "system_prompt": "You are a helpful assistant.",
  "name": "John Doe",
  "language": "en",
  "greeting": "Hello!",
  "max_session_length_minutes": 30,
  "capabilities": [
    "webcam_vision"
  ]
}

Response

Successful Response

avatar_idstring required

The ID of the avatar to use.

system_promptstring required

The system prompt to use.

namestring nullable

The agent name.

languagestring nullable

The language to use.

greetingstring nullable

What to say at the start of the session.

max_session_length_minutesinteger nullable

The maximum session length in minutes.

capabilitiesDeveloperAgentCapability[]

The agent capabilities.

idstring required

The unique identifier (ID) of the agent.

Example response

{
  "avatar_id": "01234567-89ab-cdef-0123-456789abcdef",
  "system_prompt": "You are a helpful assistant.",
  "name": "John Doe",
  "language": "en",
  "greeting": "Hello!",
  "max_session_length_minutes": 30,
  "capabilities": [
    "webcam_vision"
  ],
  "id": "01234567-89ab-cdef-0123-456789abcdef"
}