Skip to content
Status Service
/
Workflow

Overview

The Status Service provides progress tracking for asynchronous requests. This functionality is supported exclusively for V2 endpoints.

Register and get API Access

Workflow

  1. Submit a request with sync=false (default behavior).
  2. The API returns a status_url and a request_id.
  3. Continuously poll the status_url (or use the /status/{request_id} endpoint) until the status field indicates a terminal state.

Status Values

  • IN_PROGRESS – The request has been accepted and is currently being processed.
    Continue polling until the status changes to either COMPLETED or an error state.

  • COMPLETED – The request was successfully processed.
    The response includes the result.image_url containing the generated image.
    For some endpoints, additional optional fields (seed, prompt, refined_prompt) may be included.

  • ERROR – A processing error occurred in the pipeline.
    The response includes an error object with details about the failure. Polling should be stopped.

  • UNKNOWN – An unexpected internal error occurred (equivalent to an HTTP 500 in asynchronous workflows).
    This status should not occur under normal circumstances. If it does, contact Support. and provide the request_id.

Download OpenAPI description
status.json
status.yaml
Languages
Servers

https://engine.prod.bria-api.com/v2/

Endpoints

Operations