Sign in
agents

Create Agent Run

post/api/v1/agents/{agent_id}/runs

Path parameters

agent_idstring required

Headers

x-api-keystring required

Request body

input_paramsobject required
user_api_keystring nullable

Response

Successful Response

idstring required
agent_idstring required
workspace_idstring required
status'pending' | 'running' | 'completed' | 'failed' required
input_paramsobject required
{"stackTrail":"components:schemas:AgentRunResponse:properties:output:anyOf","oasType":"schema","type":"unknown","title":"Output","nullable":true}
tracked_task_idsstring[] required
container_idstring nullable
container_portinteger nullable
container_hoststring nullable
errorstring nullable
suggested_fixstring nullable
retry_countinteger
started_atstring date-time nullable
completed_atstring date-time nullable
created_bystring required
created_atstring date-time required
trigger_sourcestring nullable
trigger_source_idstring nullable
agent_plan_summarystring nullable
agent_namestring nullable

Changes

Changed in 2 of the 11 revisions of this API.14

  • fd7237c72fae2See the full diff
    • ○

      added the optional property trigger_source to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property trigger_source_id to the response with the 200 status

      response-optional-property-added

  • 653b9ca575a812See the full diff
    • ▲

      the response property node_logs became optional for the status 200

      response-property-became-optional

    • ○

      added the optional property agent_name to the response with the 200 status

      response-optional-property-added

    • ○

      the node_logs response's property default value was added for the status 200

      response-property-default-value-added

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