{"openapi":"3.0.4","info":{"title":"Fal Queue API","version":"1.0.0","description":"The Fal Queue API."},"paths":{"/{endpoint_id}":{"post":{"parameters":[{"name":"X-Fal-Queue-Priority","in":"header","required":false,"schema":{"type":"string","description":"The priority of the request.","enum":["low","normal","high"]}},{"name":"fal_webhook","in":"query","required":false,"schema":{"type":"string","description":"The webhook to call when the request is completed."}},{"name":"endpoint_id","in":"path","required":true,"schema":{"type":"string","description":"Endpoint ID"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"responses":{"200":{"description":"The request status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueStatus"}}}}}}},"/{endpoint_id}/requests/{request_id}/status":{"get":{"parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string","description":"Request ID"}},{"name":"logs","in":"query","required":false,"schema":{"type":"number","description":"Whether to include logs (`1`) in the response or not (`0`)."}},{"name":"endpoint_id","in":"path","required":true,"schema":{"type":"string","description":"Endpoint ID"}}],"responses":{"200":{"description":"The request status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueueStatus"}}}}}}},"/{endpoint_id}/requests/{request_id}":{"get":{"parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string","description":"Request ID"}},{"name":"endpoint_id","in":"path","required":true,"schema":{"type":"string","description":"Endpoint ID"}}],"responses":{"200":{"description":"Result of the request.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}}}}},"/{endpoint_id}/requests/{request_id}/cancel":{"put":{"parameters":[{"name":"request_id","in":"path","required":true,"schema":{"type":"string","description":"Request ID"}},{"name":"endpoint_id","in":"path","required":true,"schema":{"type":"string","description":"Endpoint ID"}}],"responses":{"200":{"description":"The request was cancelled.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the request was cancelled successfully."}}}}}}}}}},"servers":[{"url":"https://queue.fal.run"}],"security":[{"apiKeyAuth":[]}],"components":{"securitySchemes":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Fal Key"}},"schemas":{"QueueStatus":{"type":"object","properties":{"status":{"type":"string","enum":["IN_QUEUE","IN_PROGRESS","COMPLETED"]},"request_id":{"type":"string","description":"The request id."},"response_url":{"type":"string","description":"The response url."},"status_url":{"type":"string","description":"The status url."},"cancel_url":{"type":"string","description":"The cancel url."},"logs":{"type":"object","description":"The logs.","additionalProperties":true},"metrics":{"type":"object","description":"The metrics.","additionalProperties":true},"queue_position":{"type":"integer","description":"The queue position."}},"required":["status","request_id"]}}}}