Cancel a request - fal

PUT

/

{owner}

/

{app}

/

requests

/

{request_id}

/

cancel

Cancel a request

curl --request PUT \
  --url https://queue.fal.run/{owner}/{app}/requests/{request_id}/cancel \
  --header 'Authorization: <api-key>'

import requests

url = "https://queue.fal.run/{owner}/{app}/requests/{request_id}/cancel"

headers = {"Authorization": "<api-key>"}

response = requests.put(url, headers=headers)

print(response.text)

const options = {method: 'PUT', headers: {Authorization: '<api-key>'}};

fetch('https://queue.fal.run/{owner}/{app}/requests/{request_id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "status": "OK"
}

{
  "status": "CANCELLATION_REQUESTED"
}

{
  "status": "ALREADY_COMPLETED"
}

{
  "detail": "<string>",
  "type": "<string>"
}

{
  "status": "NOT_FOUND"
}

{
  "detail": "<string>",
  "type": "<string>"
}

Authorizations

Authorization

string

header

required

Send your fal API key in the Authorization header with the Key prefix, for example Authorization: Key $FAL_KEY. Public models also accept requests without a key. See Authentication.

Path Parameters

owner

string

required

The owner of the model, for example blackforestlabs. Use the same value as in the submit request.

app

string

required

The model app name, for example flux-3-max. Do not add the endpoint path. The status_url, response_url, and cancel_url fields contain the correct URL.

request_id

string<uuid>

required

The request ID that the submit response returned.

Response

fal removed the request from the queue.

status

enum<string>

required

Available options:

OK,

CANCELLATION_REQUESTED,

ALREADY_COMPLETED,

NOT_FOUND

⌘I

Cancel a request

curl --request PUT \
  --url https://queue.fal.run/{owner}/{app}/requests/{request_id}/cancel \
  --header 'Authorization: <api-key>'

import requests

url = "https://queue.fal.run/{owner}/{app}/requests/{request_id}/cancel"

headers = {"Authorization": "<api-key>"}

response = requests.put(url, headers=headers)

print(response.text)

const options = {method: 'PUT', headers: {Authorization: '<api-key>'}};

fetch('https://queue.fal.run/{owner}/{app}/requests/{request_id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "status": "OK"
}

{
  "status": "CANCELLATION_REQUESTED"
}

{
  "status": "ALREADY_COMPLETED"
}

{
  "detail": "<string>",
  "type": "<string>"
}

{
  "status": "NOT_FOUND"
}

{
  "detail": "<string>",
  "type": "<string>"
}