COcooper-square-technologies
Agents

Run an agent

Changed on

Start a new run for an agent.

Runs always execute the agent's live published version, so the agent must be published first with POST /v1/agents/{agent_id}/publish. Unpublished drafts cannot be run.

post/v1/agents/{agent_id}/runs

Request

Path parameters

agent_idstring uuid required

The ID of the agent to run.

Request body

inputsobject

Input values for the run. Keys should match the property names defined in schema.input. Omit the request body when the agent does not require inputs.

Response

Successful Response

idstring uuid required

Unique ID for the accepted run.

agent_idstring uuid required

Unique ID of the agent for this run.

status'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled' | 'skipped' | 'unknown' required

Current execution status for an agent run.

started_atstring date-time nullable

When the run started, if execution began immediately.

Changes

  • 56d428ca479fRevision changes
    • breaking

      the request's body type changed from object to no type

    • warning

      removed the request property

    • info

      added subschema #2 to the request body anyOf list

    • info

      request body became optional

  • c55c2a1636c3Revision changes
    • info

      the endpoint scheme security BearerAuth was added to the API