POST
/
responses
/
{responseId}
/
cancel
Cancel a response
curl --request POST \
  --url https://your_salambo_base_url/api/v1/responses/{responseId}/cancel \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "object": "<string>",
  "created_at": 123,
  "model": "<string>",
  "output": [
    {}
  ],
  "background": true,
  "run_id": "<string>",
  "completed_at": 123,
  "error": {
    "message": "<string>",
    "code": "<string>"
  },
  "metadata": {}
}

Authorizations

Authorization
string
header
required

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

Path Parameters

responseId
string
required

Response

Response state after cancellation.

id
string
required
object
string
required
Allowed value: "response"
created_at
integer
required
model
string
required
status
enum<string>
required
Available options:
queued,
in_progress,
completed,
failed,
cancelled,
incomplete
output
object[]
required
background
boolean
run_id
string
completed_at
integer | null
error
object
metadata
object