Skip to content
Async & Webhooks
/
Status Service
/Endpoints/
Get Request Status

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.
  • When status=COMPLETED, result includes image_url for images or video_url for videos, or structured_prompt based on the original endpoint.

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).
    • structured_prompt – The detailed JSON structured prompt used for V2 generation.
Path
request_idstringrequired

Unique identifier of the request.

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

Responses

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

Bodyapplication/json
One of:
resultImageResult (object) or VideoResult (object)required
One of:
statusstringrequired
Value:"COMPLETED"
request_idstringrequired
Response
{
  "status": "COMPLETED",
  "result": {
    "image_url": "https://bria-datasets.s3.us-east-1.amazonaws.com/api_doc/fibo/new_year_2026.png",
    "seed": "123456",
    "structured_prompt": "{\"short_description\": \"A photorealistic, high-resolution rendering of balloon lettering spelling out \\\"HAPPY NEW YEAR 2026\\\" against a pristine white backdrop. The balloons are meticulously crafted with a metallic, reflective surface, showcasing a vibrant color palette of Pantone Bran, Crocus, and Deja vu blue. The composition is perfectly aligned and balanced, emphasizing the celebratory message with natural, soft lighting that creates subtle, elegant reflections and shadows.\",\"objects\": [{\"description\": \"A cluster of individual balloon letters forming the word \\\"HAPPY\\\". Each letter is inflated and has a smooth, highly reflective metallic surface, catching and distorting the ambient light. The letters are arranged horizontally, slightly overlapping to create a cohesive word.\",\"location\": \"top-left to center\",\"relationship\": \"Part of the main textual display, positioned above 'NEW YEAR'.\",\"relative_size\": \"large within frame\",\"shape_and_color\": \"Irregular letter shapes, primarily Pant…" 
  },
  "request_id": "123456"
}