AGagentarea
v1
protected
task-definitions

Run Task Definition

Changed on

Run a saved task now with its agent, text and parameters; the run acts as the agent.

parameters in the body are merged over the saved ones for this run only.

post/v1/workspaces/{workspace}/task-definitions/{definition_id}/run

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Path parameters

definition_idstring uuid required
workspacestring required

Slug of the workspace the request acts in

Request body

parametersobject nullable

Merged over the saved task's own parameters for this run only.

Response

Successful Response

agent_idstring uuid required
created_atstring date-time required
created_bystring nullable
descriptionstring required
end_user_idstring nullable
errorstring nullable
execution_idstring nullable
failure_reasonstring nullable
idstring uuid required
metadataobject nullable
parametersobject required
scheduled_atstring date-time nullable
statusstring required
total_costnumber nullable
total_tokensinteger nullable

Changes