Skip to main content
POST
/
api
/
agents
/
preview
Preview Agent
curl --request POST \
  --url https://api.example.com/api/agents/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "message": "<string>",
  "instructions": "<string>",
  "execution_mode": "react",
  "models": {},
  "knowledge_bases": [
    "<string>"
  ],
  "skills": [
    "<string>"
  ],
  "tool_categories": [
    "<string>"
  ]
}
'
{
  "response": "<string>",
  "status": "<string>"
}

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 agent preview.

message
string
required

User message to preview

instructions
string | null

System instructions/prompt

execution_mode
string | null
default:react

Execution mode: simple, react, or graph

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

Response

Successful Response

Response model for agent preview.

response
string
required
status
string
required