Stop an agent - QX Labs Docs

POST

responses

{response_id}

cancel

cURL

curl -X POST https://api.qxlabs.com/v1/responses/resp_8d2c4e6f8a0b1c3d5e7f9a1b3c5d7e9f_4f1a2b3c4d5e/cancel \
  -H "Authorization: Bearer <YOUR_QX_API_KEY>"

from openai import OpenAI

client = OpenAI(base_url="https://api.qxlabs.com/v1", api_key="<YOUR_QX_API_KEY>")

stopped = client.responses.cancel("resp_8d2c4e6f8a0b1c3d5e7f9a1b3c5d7e9f_4f1a2b3c4d5e")
print(stopped.status)

import OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.qxlabs.com/v1", apiKey: "<YOUR_QX_API_KEY>" });

const stopped = await client.responses.cancel("resp_8d2c4e6f8a0b1c3d5e7f9a1b3c5d7e9f_4f1a2b3c4d5e");
console.log(stopped.status);

{
  "id": "resp_8d2c4e6f8a0b1c3d5e7f9a1b3c5d7e9f_4f1a2b3c4d5e",
  "object": "response",
  "status": "cancelled",
  "model": "builtin:qx_agent",
  "conversation": {
    "id": "8d2c4e6f8a0b1c3d5e7f9a1b3c5d7e9f"
  },
  "output": []
}

{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "param": "<string>",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "No turn is running on this conversation.",
    "type": "invalid_request_error",
    "param": null,
    "code": null
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "param": "<string>",
    "code": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Your QX API key. The X-API-Key header works too

Path Parameters

response_id

string

required

The ID of a response of the conversation

Response

The turn was stopped

string

object

string

status

string

model

string

The agent the stopped turn ran

conversation

object

Show child attributes

output

Item · object[]

What the agent did before it stopped, as in a finished response

Show child attributes

cURL

curl -X POST https://api.qxlabs.com/v1/responses/resp_8d2c4e6f8a0b1c3d5e7f9a1b3c5d7e9f_4f1a2b3c4d5e/cancel \
  -H "Authorization: Bearer <YOUR_QX_API_KEY>"

from openai import OpenAI

client = OpenAI(base_url="https://api.qxlabs.com/v1", api_key="<YOUR_QX_API_KEY>")

stopped = client.responses.cancel("resp_8d2c4e6f8a0b1c3d5e7f9a1b3c5d7e9f_4f1a2b3c4d5e")
print(stopped.status)

import OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.qxlabs.com/v1", apiKey: "<YOUR_QX_API_KEY>" });

const stopped = await client.responses.cancel("resp_8d2c4e6f8a0b1c3d5e7f9a1b3c5d7e9f_4f1a2b3c4d5e");
console.log(stopped.status);

{
  "id": "resp_8d2c4e6f8a0b1c3d5e7f9a1b3c5d7e9f_4f1a2b3c4d5e",
  "object": "response",
  "status": "cancelled",
  "model": "builtin:qx_agent",
  "conversation": {
    "id": "8d2c4e6f8a0b1c3d5e7f9a1b3c5d7e9f"
  },
  "output": []
}

{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "param": "<string>",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "No turn is running on this conversation.",
    "type": "invalid_request_error",
    "param": null,
    "code": null
  }
}

{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "param": "<string>",
    "code": "<string>"
  }
}