Sign in
Agent Runs

Cancel an agent thread's active run

Changed on
post/api/agent-threads/{threadId}/cancel

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header x-sixb-csrf
    • HTTP bearer

Path parameters

threadIdstring required

Request body

runIdstring required

Response

Response for status 202

Changes

  • 784768a1de35Revision changes
    • warning

      added the new run enum value to the /// response property for the response status

    • warning

      added the new step_limit_reached enum value to the /// response property for the response status

  • 2e14e083f140Revision changes
    • info

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

    • info

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