agents

Preview Agent

Preview agent response without saving to database.

post/api/agents/preview

Request

The document declares no server URL.
Auth
HTTP bearer
TypeScript
https://skmtc.dev/xorbitsai/apis/xagent/docs/api/agents/preview/post.ts
A function with typed inputs. Its response is checked against the schema.

instructionsstring nullable

System instructions/prompt

execution_modestring nullable

Execution mode: flash, balanced, think, or auto

modelsobject nullable

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

knowledge_basesstring[]

Knowledge base names

skillsstring[]

Skill names

tool_categoriesstring[]

Tool category names

messagestring required

User message to preview

Successful Response

responsestring required

statusstring required

May 1, 2026c9eb29ec9a1b Revision changes
- info
  the request property default value changed from react to balanced