Skip to main content
POST
/
v1
/
agents
/
create
Create Agent
curl --request POST \
  --url https://api.clarm.com/v1/agents/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "steps": [
    "<string>"
  ],
  "instructions": "<string>",
  "documents": []
}
'
{
  "id": 123,
  "name": "<string>",
  "description": "<string>",
  "steps": [
    "<string>"
  ],
  "instructions": "<string>",
  "collections": [
    123
  ]
}
Create a new agent (AI persona) with specific instructions and document access permissions.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required
​
description
string
required
​
steps
string[]
required
​
instructions
string
required
​
documents
integer[]

Response

Successful Response

Response model for agent retrieval

​
id
integer
required
​
name
string
required
​
description
string
required
​
steps
string[] | null
required
​
instructions
string | null
required
​
collections
integer[]
required