Skip to content
KataraKatara documentation

Cancel a background response

POST
/responses/{response_id}/cancel
curl --request POST \
  --url https://api.katara.com/v1/responses/example/cancel \
  --header 'Authorization: Bearer <token>'

A background request runs to completion before it is answered, so no stored response is ever still running. A stored one is refused with response_not_cancellable, under the same rule as reading it.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
response_id
required
string
/^resp_[A-Za-z0-9_-]{1,120}$/

The id of a stored response.

Responses

Section titled “Responses”

400

Section titled “400”

The response has already finished (response_not_cancellable, param null).

Media typeapplication/json
object
error
required
object
type
string
code
required

Stable error code.

string
message
required

Explanation for the caller.

string
param
string | null
Examplegenerated
{
  "error": {
    "type": "example",
    "code": "example",
    "message": "example",
    "param": "example"
  }
}

404

Section titled “404”

The response is missing, expired, deleted or someone else’s (response_not_found).

Media typeapplication/json
object
error
required
object
type
string
code
required

Stable error code.

string
message
required

Explanation for the caller.

string
param
string | null
Examplegenerated
{
  "error": {
    "type": "example",
    "code": "example",
    "message": "example",
    "param": "example"
  }
}