Skip to main content

List agents

Create an agent

With structured fields

Define payload_schema to enforce specific fields in the AI output payload:
Available field types: text, number, boolean, date, time, datetime. Max 10 fields.

With allowed action types

By default, the AI can return any action type (free-form). Set allowed_actions to constrain it to a specific list — the AI can only return values from this list.
Format: domain.resource.action (snake_case, 3 segments). Max 10 action types. When a run completes, every action’s type is guaranteed to be in this list:
Without allowed_actions, the AI invents action types freely — useful for prototyping but unpredictable in production. Add constraints once you know your action types.
required instructs the AI to always fill the field — it does not guarantee a value. Always validate on your end before processing actions.

Retrieve an agent

Update an agent

Delete an agent

Run an agent

Creates a run and returns immediately. The run is processed asynchronously — poll with refresh or listen via webhook.
Poll for completion:

List runs

Retrieve a run

Dispatch actions with a registry

Use an ActionRegistry to route agent actions to your service objects:
See Registries for the full guide.

Action confirmation

When an agent has confirmation_mode: "confirm", actions require human validation before dispatch.
See Action Confirmation for the full guide.

Agent attributes

AgentRun attributes