Skip to main content
POST
/
agents
Create agent
curl --request POST \
  --url https://api.getarbol.com/v1/agents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "primaryLanguage": "<string>",
  "systemPrompt": "<string>",
  "greeting": "<string>",
  "supportedLanguages": [
    "<string>"
  ],
  "model": "<string>",
  "maxCallDurationSeconds": 300,
  "status": "ACTIVE",
  "voiceConfigs": [
    {}
  ],
  "toolAssignments": [
    {}
  ],
  "metadata": {}
}
'
{
  "id": "<string>",
  "name": "<string>",
  "primaryLanguage": "<string>",
  "status": "ACTIVE",
  "systemPrompt": "<string>",
  "greeting": "<string>",
  "model": "<string>",
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Use your API key from the Arbol dashboard. Go to Settings > API Keys to generate one.

Body

application/json
name
string
required
Required string length: 1 - 100
primaryLanguage
string
required
systemPrompt
string
required
Required string length: 1 - 10000
greeting
string
required
Required string length: 1 - 1000
supportedLanguages
string[]
model
string
maxCallDurationSeconds
integer
default:300
Required range: 60 <= x <= 3600
status
enum<string>
Available options:
ACTIVE,
PAUSED,
INACTIVE
voiceConfigs
object[]
toolAssignments
object[]
metadata
object

Response

Created agent

id
string
name
string
primaryLanguage
string
status
enum<string>
Available options:
ACTIVE,
PAUSED,
INACTIVE
systemPrompt
string
greeting
string
model
string
metadata
object
createdAt
string<date-time>
updatedAt
string<date-time>