Skip to main content
POST
/
v1
/
agents
Create agent
curl --request POST \
  --url http://localhost:8080/v1/agents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "external_id": "user-123",
  "name": "Alice's Assistant",
  "metadata": {}
}
EOF
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_id": "<string>",
  "name": "<string>",
  "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

API key with mk_ or rk_ prefix

Body

application/json
​
external_id
string
required
Example:

"user-123"

​
name
string
required
Example:

"Alice's Assistant"

​
metadata
object

Response

201 - application/json

Agent created

​
id
string<uuid>
​
external_id
string
​
name
string
​
tenant_id
string<uuid>
​
metadata
object
​
created_at
string<date-time>