Get request status

GET

{owner}

{app}

requests

{request_id}

status

Get request status

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

import requests

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

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

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

print(response.text)

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

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

{
  "status": "IN_QUEUE",
  "request_id": "<string>",
  "response_url": "<string>",
  "status_url": "<string>",
  "cancel_url": "<string>",
  "queue_position": 123,
  "logs": [
    {
      "message": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "labels": {}
    }
  ],
  "metrics": {
    "inference_time": 123
  },
  "error": "<string>",
  "error_type": "<string>"
}

{
  "status": "IN_QUEUE",
  "request_id": "<string>",
  "response_url": "<string>",
  "status_url": "<string>",
  "cancel_url": "<string>",
  "queue_position": 123,
  "logs": [
    {
      "message": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "labels": {}
    }
  ],
  "metrics": {
    "inference_time": 123
  },
  "error": "<string>",
  "error_type": "<string>"
}

{
  "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.

Query Parameters

logs

enum<string>

Set to 1 to include runner logs in the response. Logs are not available for all models.

Available options:

1,

0

Response

The request is complete.

The state of a queue request.

status

enum<string>

required

COMPLETED is the final state. A failed or cancelled request also has the status COMPLETED.

Available options:

IN_QUEUE,

IN_PROGRESS,

COMPLETED

request_id

string

required

response_url

string<uri> | null

The URL of the result.

status_url

string<uri> | null

cancel_url

string<uri> | null

queue_position

integer

The number of requests in front of this request. Present only when the status is IN_QUEUE.

logs

object[] | null

The runner logs. The value is null unless you send logs=1.

Hide child attributes

logs.message

string

required

logs.timestamp

string<date-time>

required

logs.labels

object

metrics

object

Present when the status is COMPLETED. Empty in other states.

Hide child attributes

metrics.inference_time

number

The run time on the runner, in seconds.

error

string

The error message. Present only when the request failed.

error_type

string

The error category. Present only when the request failed. See Request Error Types.

⌘I

Get request status

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

import requests

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

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

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

print(response.text)

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

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

{
  "status": "IN_QUEUE",
  "request_id": "<string>",
  "response_url": "<string>",
  "status_url": "<string>",
  "cancel_url": "<string>",
  "queue_position": 123,
  "logs": [
    {
      "message": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "labels": {}
    }
  ],
  "metrics": {
    "inference_time": 123
  },
  "error": "<string>",
  "error_type": "<string>"
}

{
  "status": "IN_QUEUE",
  "request_id": "<string>",
  "response_url": "<string>",
  "status_url": "<string>",
  "cancel_url": "<string>",
  "queue_position": 123,
  "logs": [
    {
      "message": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "labels": {}
    }
  ],
  "metrics": {
    "inference_time": 123
  },
  "error": "<string>",
  "error_type": "<string>"
}

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

{
  "status": "NOT_FOUND"
}

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

Queue API

Synchronous API

Get request status

Authorizations

Path Parameters

Query Parameters

Response