Skip to main content
POST
/
api
/
agents
Create Agent
curl --request POST \
  --url https://api.example.com/api/agents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "instructions": "<string>",
  "execution_mode": "balanced",
  "models": {},
  "knowledge_bases": [
    "<string>"
  ],
  "skills": [
    "<string>"
  ],
  "tool_categories": [
    "<string>"
  ],
  "suggested_prompts": [
    "<string>"
  ],
  "logo_base64": "<string>"
}
'
{
  "id": 123,
  "user_id": 123,
  "name": "<string>",
  "description": "<string>",
  "instructions": "<string>",
  "execution_mode": "<string>",
  "models": {},
  "knowledge_bases": [
    "<string>"
  ],
  "skills": [
    "<string>"
  ],
  "tool_categories": [
    "<string>"
  ],
  "suggested_prompts": [
    "<string>"
  ],
  "logo_url": "<string>",
  "status": "<string>",
  "published_at": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "widget_enabled": true,
  "allowed_domains": [
    "<string>"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.xagent.run/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Request model for creating a new agent.

​
name
string
required

Agent name

Required string length: 1 - 200
​
description
string | null

Agent description

​
instructions
string | null

System instructions/prompt

​
execution_mode
string | null
default:balanced

Execution mode: flash, balanced, or think

​
models
Models · object

Model config: {general, small_fast, visual, compact}

​
knowledge_bases
string[]

Knowledge base names

​
skills
string[]

Skill names

​
tool_categories
string[]

Tool category names

​
suggested_prompts
string[]

Suggested prompt examples for users

​
logo_base64
string | null

Logo image as base64 data URL

Response

Successful Response

Response model for agent data.

​
id
integer
required
​
user_id
integer
required
​
name
string
required
​
description
string | null
required
​
instructions
string | null
required
​
execution_mode
string
required
​
models
Models · object
required
​
knowledge_bases
string[]
required
​
skills
string[]
required
​
tool_categories
string[]
required
​
suggested_prompts
string[]
required
​
logo_url
string | null
required
​
status
string
required
​
published_at
string | null
required
​
created_at
string
required
​
updated_at
string
required
​
widget_enabled
boolean
required
​
allowed_domains
string[]
required