Skip to main content
POST
/
api
/
v1
/
llm
/
responses
/
{response_id}
/
cancel
Typescript (SDK)
import { SDK } from "@meetkai/mka1";

const sdk = new SDK({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await sdk.llm.responses.cancel({
    responseId: "resp_cancel123",
  });

  console.log(result);
}

run();
{
  "id": "resp_cancel123",
  "object": "response",
  "created_at": 1735689600,
  "status": "cancelled",
  "error": null,
  "incomplete_details": null,
  "background": false,
  "instructions": null,
  "max_output_tokens": null,
  "max_tool_calls": 30,
  "metadata": {},
  "model": "meetkai:functionary-urdu-mini-pak",
  "output": [],
  "output_text": "",
  "parallel_tool_calls": true,
  "previous_response_id": null,
  "reasoning": {
    "effort": null,
    "summary": null
  },
  "service_tier": "auto",
  "store": true,
  "text": {
    "format": {
      "type": "text"
    },
    "verbosity": "medium"
  },
  "tool_choice": "auto",
  "tools": [],
  "truncation": "auto",
  "usage": {
    "input_tokens": 0,
    "input_tokens_details": {
      "cached_tokens": 0
    },
    "output_tokens": 0,
    "output_tokens_details": {
      "reasoning_tokens": 0
    },
    "total_tokens": 0
  },
  "user": null
}

Authorizations

​
Authorization
string
header
required

Authenticate with your MKA1 API key at the API gateway: Authorization: Bearer <mka1-api-key>. For multi-user server-side integrations, also send X-On-Behalf-Of to identify the end user making the request.

Headers

​
X-On-Behalf-Of
string

Optional external user identifier for multi-user server-side integrations. Use this when acting on behalf of one of your end users.

Path Parameters

​
response_id
string
required

The unique identifier of the response, formatted as 'resp_' or 'resp-' followed by alphanumeric characters.

Pattern: ^resp[-_][a-zA-Z0-9]+$

Response

200 - application/json

The response object after cancellation.

​
id
string
required
​
object
any
required
​
created_at
number
required
​
status
enum<string>
required

The overall status of the response generation. 'completed' means successfully finished, 'failed' means error occurred, 'in_progress' means currently processing, 'cancelled' means user-cancelled, 'queued' means waiting to start, 'incomplete' means partial completion.

Available options:
completed,
failed,
in_progress,
cancelled,
queued,
incomplete
​
error
object
required
​
incomplete_details
object
required
​
background
boolean
required
​
instructions
required
​
max_output_tokens
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
Example:

null

​
max_tool_calls
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
​
metadata
object
required
​
model
string
required
​
output
object[]
required

A message input item with a role and content. Represents a single turn in the conversation from a user, assistant, system, or developer.

​
parallel_tool_calls
boolean
required
​
previous_response_id
string | null
required
​
store
boolean
required
​
text
object
required
​
tool_choice
required
Available options:
none,
auto,
required
​
tools
object[]
required
​
truncation
enum<string>
required
Available options:
auto,
disabled
​
usage
object
required
​
user
string | null
required
​
conversation
object
​
output_text
string
​
prompt
object
​
prompt_cache_key
string
​
reasoning
object
​
safety_identifier
string
​
service_tier
enum<string>
Available options:
auto,
default,
flex,
priority
​
temperature
number
Required range: 0 <= x <= 2
​
top_logprobs
integer
Required range: 0 <= x <= 20
​
top_p
number
Required range: 0 <= x <= 1