Responses

Cancel a background response

Stop a queued or running background response; it ends with status cancelled and is not billed for unfinished work. Cancelling again, or cancelling a finished response, returns it unchanged.

post/responses/{response_id}/cancel

Request

  • Base URL
    https://api.openscale.so/v1
  • URL
    https://api.openscale.so/v1/responses/{response_id}/cancel
  • Auth
    HTTP bearer

Response

The response.

idstring required
object'response' required
created_atinteger required
status'completed' | 'incomplete' | 'failed' | 'in_progress' | 'queued' | 'cancelled' required
model'deepseek/deepseek-v4.1-flash' | 'z-ai/glm-5.3-flash' | 'deepseek/deepseek-v4.1-flash-1017' | 'deepseek/deepseek-v4.1-flash-0910' | 'z-ai/glm-5.3-flash-0828' | 'deepseek/deepseek-v4.1-flash:fast' | 'deepseek/deepseek-v4.1-flash-1017:fast' | 'deepseek/deepseek-v4.1-flash-0910:fast' required
service_tier'default' | 'priority'

The tier that served the response: priority in fast mode.

Example response

{
  "id": "resp_example",
  "output": [
    {
      "id": "msg_example"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.