EXexa
Agent

Cancel a run

Changed on

Cancel a queued or running Agent run immediately without returning any results. You are billed for usage accrued before cancellation. If the run has already reached a terminal status, the API returns the existing run.

post/agent/runs/{id}/cancel

Request

  • Base URL
    https://api.exa.ai
  • URL
    https://api.exa.ai/agent/runs/{id}/cancel
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

idstring required

Agent run ID. New run IDs are returned with the agent_run_ prefix.

Agent run ID.

Response

Agent run

idstring required

Agent run ID. New run IDs are returned with the agent_run_ prefix.

object'agent_run' required
status'queued' | 'running' | 'completed' | 'failed' | 'cancelled' required
createdAtstring date-time required

When the run was created

completedAtstring date-time nullable required

Changes

  • 9fa4de48c6afRevision changes
    • info

      added the required property to the response with the status

  • f21ac0e3acccRevision changes
    • breaking

      the //// response's property type changed from string to no type for status

    • breaking

      the / response's property type changed from integer to number for status

    • breaking

      the / response's property type changed from integer to number for status

    • breaking

      the / response's property type changed from integer to number for status

    • info

      added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 subschema #7 subschema #8 subschema #9 to the //// response property anyOf list for the response status

    • info

      removed the budget_reached enum value from the //// response property for the response status

    • info

      removed the cancelled enum value from the //// response property for the response status

    • info

      removed the error enum value from the //// response property for the response status

    • info

      removed the schema_satisfied enum value from the //// response property for the response status

    • info

      removed the stopped enum value from the //// response property for the response status

    • info

      removed the time_limit_reached enum value from the //// response property for the response status