Queue Size

GET

serverless

apps

{owner}

{name}

queue

Queue Size

curl --request GET \
  --url https://api.fal.ai/v1/serverless/apps/{owner}/{name}/queue \
  --header 'Authorization: <api-key>'

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

fetch('https://api.fal.ai/v1/serverless/apps/{owner}/{name}/queue', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "queue_size": 5
}

{
  "error": {
    "type": "authorization_error",
    "message": "Authentication required"
  }
}

{
  "error": {
    "type": "authorization_error",
    "message": "Access denied"
  }
}

{
  "error": {
    "type": "not_found",
    "message": "Resource not found"
  }
}

{
  "error": {
    "type": "rate_limited",
    "message": "Rate limit exceeded"
  }
}

{
  "error": {
    "type": "server_error",
    "message": "An unexpected error occurred"
  }
}

Authorizations

Authorization

string

header

required

API key must be prefixed with "Key ", e.g. Authorization: Key YOUR_API_KEY

Path Parameters

owner

string

required

Username of the app owner

Example:

"user_123"

name

string

required

Application name

Example:

"my-app"

Response

Successfully retrieved queue information

Status of the app queue

queue_size

integer

required

Current number of requests in the queue

Required range: x >= 0

Example:

5

Flush queueFlushes all pending requests from an application's queue. **Authentication:** Required via API key **Idempotency:** - Optional `Idempotency-Key` header prevents duplicate flushes on retries - Responses cached for 10 minutes per unique key **Use Cases:** - Clear stuck or outdated requests from the queue - Reset queue state during development or testing - Cancel all pending requests for an application **Important:** - This operation is irreversible - All pending requests in the queue will be cancelled - Requests already being processed will not be affected

⌘I

Queue Size

curl --request GET \
  --url https://api.fal.ai/v1/serverless/apps/{owner}/{name}/queue \
  --header 'Authorization: <api-key>'

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

fetch('https://api.fal.ai/v1/serverless/apps/{owner}/{name}/queue', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "queue_size": 5
}

{
  "error": {
    "type": "authorization_error",
    "message": "Authentication required"
  }
}

{
  "error": {
    "type": "authorization_error",
    "message": "Access denied"
  }
}

{
  "error": {
    "type": "not_found",
    "message": "Resource not found"
  }
}

{
  "error": {
    "type": "rate_limited",
    "message": "Rate limit exceeded"
  }
}

{
  "error": {
    "type": "server_error",
    "message": "An unexpected error occurred"
  }
}