Cancel Invocation — POST /api/v1/agents/invocations/{invocation_id}/cancel
Cancel Invocation
Cancel an invocation cooperatively, exactly as its pipeline run is cancelled.
Endpoint: POST /api/v1/agents/invocations/{invocation_id}/cancel
Authentication: Send a signed-in user’s access token in Authorization: Bearer <access token>, or an API key in X-API-Key: <API key>.
- Your role must be QA engineer or higher.
- You must have access to this agent invocation.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Default | Description |
|---|---|---|---|---|---|
invocation_id | path | yes | string (uuid) | ||
X-API-Key | header | no | string or null | API key, as an alternative to the access token (see Authentication). |
Request body
Section titled “Request body”No request body.
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
202 | Successful Response | AgentInvocationResponse (application/json) |
422 | Validation Error | HTTPValidationError (application/json) |
Errors this endpoint returns, read from its source code:
409, with messages such as “Invocation has already been cancelled”, “Invocation has already finished”
It can also return 401 if your credential is missing or expired, 403 if your credential does not allow this request, and 404 if the item does not exist or you cannot see it. Your role, your project membership and the key’s scope decide what a credential allows. See Errors and retries.
More details
Section titled “More details”- Group: Agent Invocations
- Operation ID:
cancel_invocation_api_v1_agents_invocations__invocation_id__cancel_post - Source code:
backend/app/routers/agent_invoke.py, line 948 - Specification: OpenAPI JSON