Skip to main content
POST
/
api
/
v1
/
agents
Add agent
curl --request POST \
  --url http://localhost:3000/api/v1/agents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "role": "<string>",
  "model": "<string>",
  "allowedTools": [
    "<string>"
  ],
  "systemPrompt": "<string>",
  "skills": [
    "<string>"
  ],
  "maxTurns": 1,
  "identity": {
    "displayName": "<string>",
    "title": "<string>",
    "company": "<string>",
    "email": "<string>",
    "bio": "<string>",
    "timezone": "<string>",
    "avatar": "<string>",
    "responsibilities": [
      "<string>"
    ],
    "tone": "<string>",
    "personality": "<string>",
    "socials": {}
  },
  "reportsTo": "<string>",
  "browserProfile": "<string>"
}
'
{
  "ok": true,
  "data": {
    "added": true
  }
}

Authorizations

Authorization
string
header
required

API key passed as a Bearer token. Configure via the apiKeys field in polpo.json or the POLPO_API_KEY environment variable.

Body

application/json
name
string
required
Minimum string length: 1
role
string
model
string
allowedTools
string[]
systemPrompt
string
skills
string[]
maxTurns
integer
Required range: x > 0
identity
object
reportsTo
string
browserProfile
string

Response

201 - application/json

Agent added

ok
boolean
required
data
object
required