Skip to main content
POST
/
v1
/
chat
/
completions
/
{id}
/
cancel
Cancel an in-flight chat completion
curl --request POST \
  --url https://api.aurous-labs.com/v1/chat/completions/{id}/cancel \
  --header 'X-Api-Key: <api-key>'
{
  "id": "cmp_01HXMQ7Z3K8Y2ABCDEFGHJKM",
  "created": 1731948000,
  "model": "aurous-grow-2.0-pro",
  "choices": [
    {
      "index": 0,
      "message": {
        "content": {},
        "tool_calls": [
          {
            "id": "call_01HXM...",
            "function": {
              "name": "get_weather",
              "arguments": "{\"city\":\"Tokyo\"}"
            }
          }
        ]
      }
    }
  ],
  "usage": {
    "prompt_tokens": 200,
    "completion_tokens": 600,
    "total_tokens": 850,
    "credits_charged": 0.2856,
    "breakdown": {
      "input_credits": 0.0006,
      "output_credits": 0.27,
      "model": "aurous-grow-2.0-pro",
      "pricing_version": 7,
      "reasoning_credits": 0.015
    },
    "reasoning_tokens": 50
  },
  "status": "completed",
  "error": {
    "code": "chat_provider_unavailable",
    "type": "server_error",
    "message": "Provider request failed."
  }
}

Authorizations

​
X-Api-Key
string
header
required

Your team API key (starts with al_live_).

Headers

​
Aurous-Version
string

Optional API version pin (YYYY-MM-DD). Defaults to your team's pinned version, or the system default 2026-05-15 for unauthenticated requests.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-05-15"

Path Parameters

​
id
string
required

Opaque chat completion id (cmp_).

Example:

"cmp_01HXMQ7Z3K8Y2ABCDEFGHJKM"

Response

Cancelled (or already-completed if a race occurred during cancel).

​
id
string
required

Opaque chat-completion id.

Example:

"cmp_01HXMQ7Z3K8Y2ABCDEFGHJKM"

​
object
enum<string>
required
Available options:
chat.completion
​
created
number
required

Unix timestamp (seconds).

Example:

1731948000

​
model
string
required

Aurous model slug used.

Example:

"aurous-grow-2.0-pro"

​
choices
object[]
required

Always exactly 1 entry in v1.0.

​
usage
object
required
​
status
enum<string>
required

Aurous extension: terminal state of the chat completion. completed is the normal happy path. in_progress means the request is still being processed (only possible when polling GET /:id during a streamed request). failed means the provider or platform errored — see error for the typed reason. cancelled means a cancel was requested or the client disconnected.

Available options:
completed,
in_progress,
failed,
cancelled
Example:

"completed"

​
error
object

Aurous extension: present only when status is failed or cancelled (in addition to the main error response when applicable). Echoes the typed error envelope shape so customers can branch on error.code without parsing string messages.

Example:
{
  "code": "chat_provider_unavailable",
  "type": "server_error",
  "message": "Provider request failed."
}