POST
/
v1
/
agent
cURL
curl https://api.bey.dev//v1/agent \
    -H 'Content-Type: application/json' \
    -H "x-api-key: $BEY_API_KEY" \
    -d '{
      "avatar_id": "01234567-89ab-cdef-0123-456789abcdef",
      "system_prompt": "You are a helpful assistant."
    }'
{
  "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"
}

Authorizations

x-api-key
string
header
required

Your Beyond Presence API Key.

Body

application/json

Request model for creating an agent.

Response

201
application/json

Successful Response

Response model for the agent.