Sign in
v1
protected
agents

Create Agent

Create a new agent, and the triggers that start it, in one request.

Every trigger is checked before anything is written. If creating one still fails, the triggers already made and the agent are removed again, so the caller never ends up with an agent that silently lacks a schedule or channel.

post/v1/workspaces/{workspace}/agents/

Path parameters

workspacestring required

Slug of the workspace the request acts in

Slug of the workspace the request acts in

Request body

a2ui_enabledboolean nullable

Expose this agent over the A2UI protocol.

agent_type'stateless' | 'stateful'

DEPRECATED — stored and echoed back, but the runtime never reads it, so every agent behaves as 'stateless' regardless of this value. Conversation history does not currently survive across runs. Do not branch on this field.

descriptionstring

Short summary of what the agent does.

instructionstring

System prompt / behavioural instructions for the agent.

model_idstring nullable

UUID of a model instance in this workspace (see GET /v1/model-instances). Null means no model is bound yet and the agent cannot be run.

namestring required

Human-readable agent name (unique per workspace).

planningboolean nullable

Enable explicit planning step before execution.

skill_idsstring[] nullable

UUIDs of skills to attach to the agent.

Response

Successful Response

a2ui_enabledboolean nullable
agent_typestring
descriptionstring nullable
idstring uuid required
instructionstring nullable
is_catalogboolean
model_idstring nullable
namestring required
planningboolean nullable
registry_item_idstring nullable
skillsobject[] nullable
slugstring required
statusstring required
update_availableboolean

Changes

Changed in 2 of the 45 revisions of this API.222

  • 286327d8bd86221See the full diff
    • ▲

      the request property became required

      request-property-became-required

    • ▲

      request property list-of-types was narrowed by removing types null from media type application/json

      request-property-list-of-types-narrowed

    • ●

      removed the request property

      request-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ○

      added the new optional request property

      new-optional-request-property

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d3ad8e1a36811See the full diff
    • ○

      endpoint added

      endpoint-added