Skip to content
Status Service
/
Endpoints

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

Get Request Status

Request

Retrieves the current status of an asynchronous request.

Behavior

  • Under normal operation, this endpoint returns 200 OK, regardless of whether the request is in progress, completed, or has failed at the job level.
  • The status field in the response (IN_PROGRESS, COMPLETED, ERROR, UNKNOWN) indicates the state of the job.
  • When the job fails (status=ERROR), details of the failure are provided in the error object, but the HTTP status remains 200.

Other Possible Responses

  • 404 NOT_FOUND – Returned when the specified request_id does not exist or has expired.

  • 5XX – Returned when the Status Service itself experiences an internal error. For real-time updates, check Bria's Status Page. You can also contact our Support.

  • When status=COMPLETED, result may also include:

    • seed – Deterministic seed used for generation (if supported by the endpoint).
    • prompt – Original prompt provided by the user (if applicable).
    • refined_prompt – System-enhanced version of the input prompt (if applicable).
Path
request_idstringrequired

Unique identifier of the request.

curl -i -X GET \
  'https://engine.prod.bria-api.com/v2/status/{request_id}'

Responses

The status field indicates whether the request completed successfully or failed.

Bodyapplication/json
One of:
resultobjectrequired
result.​image_urlstringrequired
result.​seedinteger

Deterministic generation seed (returned only for endpoints that support reproducible outputs).

result.​promptstring

Original prompt sent by the user (returned only if applicable).

result.​refined_promptstring

Refined version of the input prompt (returned only if applicable and supported by the endpoint).

statusstringrequired
Value"COMPLETED"
request_idstringrequired
Response
application/json
{
  "status": "COMPLETED",
  "result": {
    "image_url": "https://example.com/generated_image.png"
  },
  "request_id": "123456"
}