Cancel Response

Cancel a background response that is in progress. If the response is already completed, failed, or cancelled, this returns the response as-is.

POST /responses/{id}/cancel

Cancel a response

cURL

curl --request POST \
  --url https://api.cloudglue.dev/v1/responses/{id}/cancel \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "response",
  "status": "in_progress",
  "created_at": 123,
  "model": "<string>",
  "instructions": "<string>",
  "output": [
    {
      "type": "message",
      "role": "assistant",
      "content": [
        {
          "type": "output_text",
          "text": "<string>",
          "annotations": [
            {
              "type": "cloudglue_citation",
              "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "start_time": 123,
              "collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "end_time": 123,
              "context": "<string>",
              "relevant_sources": [
                "<string>"
              ],
              "visual_scene_description": [
                "<string>"
              ],
              "scene_text": [
                "<string>"
              ],
              "speech": [
                "<string>"
              ],
              "audio_description": [
                "<string>"
              ]
            }
          ]
        }
      ]
    }
  ],
  "usage": {
    "input_tokens": 123,
    "output_tokens": 123,
    "total_tokens": 123
  },
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string<uuid> · required

The ID of the response to cancel

Response

200

application/json

Response cancelled or current status returned

id · string<uuid>

Unique identifier for the response

object · enum<string>

Object type identifier

Available options: response

status · enum<string>

Current status of the response

Available options: in_progress, completed, failed, cancelled

created_at · integer

Unix timestamp of when the response was created

model · string

The model used for the response

instructions · string | null

The system instructions used

output · object[] | null

The generated output items: assistant message(s), any echoed function_call items, and one cloudglue_query_call per read-only SQL query the agent ran over structured data. Clients should tolerate unknown output-item types.

Option 1

Option 2

Option 3

Show child attributes

usage · object | null

Token usage statistics for the response

Show child attributes

error · object | null

Error details when the response status is 'failed'

Show child attributes