XOxorbitsai
agents

Create Agent

Changed on

Create a new custom agent.

post/api/agents

Request

Request body

namestring required

Agent name

descriptionstring nullable

Agent description

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

suggested_promptsstring[]

Suggested prompt examples for users

logo_base64string nullable

Logo image as base64 data URL

Response

Successful Response

idinteger required
user_idinteger required
namestring required
descriptionstring nullable required
instructionsstring nullable required
execution_modestring required
modelsobject nullable required
knowledge_basesstring[] required
skillsstring[] required
tool_categoriesstring[] required
suggested_promptsstring[] required
logo_urlstring nullable required
statusstring required
published_atstring nullable required
created_atstring required
updated_atstring required
widget_enabledboolean required
allowed_domainsstring[] required
share_enabledboolean required
share_updated_atstring nullable required

Changes

  • 33e4ba4936adRevision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • c9eb29ec9a1bRevision changes
    • info

      the request property default value changed from react to balanced

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status