agentsMessages

Cancel Agent Run

Cancel runs associated with an agent. If run_ids are passed in, cancel those in particular.

Note to cancel active runs associated with an agent, redis is required.

Authentication

AuthorizationBearer

Header authentication of the form Bearer <token>

Path parameters

agent_idstringRequiredformat: "^agent-[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"=42 characters

The ID of the agent in the format ‘agent-<uuid4>’

Request

This endpoint expects an object.
run_idslist of strings or nullOptional
Optional list of run IDs to cancel

Response

Successful Response

Errors