Skip to content

Generate Structured Prompt - Lite

Request

Creates a new detailed, machine-readable structured prompt in JSON format for the speed-optimized Fibo Lite Pipeline.

This endpoint uses Bria's standard FIBO-VLM bridge (open-source, available on Hugging Face) to generate the prompt. It only returns the JSON string and does not generate an image.

Why use this endpoint?

This endpoint decouples the "intent translation" step from the "image generation" step, giving you maximum flexibility.

  • It's Optional: The same structured prompt generation happens automatically behind the scenes when using /v2/image/generate/lite.
  • Control & Auditability: Allows for a "human-in-the-loop" to inspect, programmatically edit, or version the JSON before generating an image (e.g., for a custom UI).
  • Consistency & Automation: Generate one structured_prompt and pass it to /v2/image/generate/lite multiple times to create consistent, auditable variations.
  • Local Deployment Support: This bridge is designed to pair seamlessly with the Fibo Lite text-to-image model. This combination enables fully local, on-prem deployment and unlocks Fibo Lite's faster inference speeds. Contact support@bria.ai for more information.

The resulting structured_prompt can be used as input for the /v2/image/generate/lite endpoint.

Input Combination Rules

The request body must use exactly one of the following combinations:

  • Text Only: prompt
  • Image Only: images
  • Image and Text: images and prompt
  • Structured Prompt and Text: structured_prompt and prompt

** API Access **

You can register and access the API Token through Bria's platform by clicking here.

Headers
api_tokenstringrequired
Bodyapplication/json
promptstring

Text-based instruction. Can be used alone to create a new prompt, or as a refinement command with an images or structured_prompt.

imagesArray of strings, <= 1 items

Publicly available URL or Base64-encoded image. Currently supports a single image. Supported formats: JPEG, JPG, PNG, WEBP.

structured_promptstring

A string containing the structured prompt in JSON format. Use a structured_prompt from a previous generation's response.

seedinteger

Seed for deterministic generation. Uses a random seed if omitted. This parameter is optional.

syncboolean

Response mode. This parameter is optional.

  • false (default): Asynchronous. Returns 202 with a status_url to poll.
  • true: Synchronous. Holds the connection and returns 200 with the final result.
Default:false
webhook_urlstring, (uri)

Optional URL for receiving the result via webhook when the async job completes. See Webhooks.

ip_signalboolean

If true, returns a warning for potential IP content in the prompt parameter. This parameter is optional.

Default:false
prompt_content_moderationboolean

If true, returns 422 on input prompt moderation failure in the prompt parameter. This parameter is optional.

Default:true
visual_input_content_moderationboolean

If true, returns 422 on visual input moderation failure. This parameter is optional.

Default:true
POST
/structured_prompt/generate/lite
curl -i -X POST \
  https://engine.prod.bria-api.com/v2/structured_prompt/generate/lite \
  -H 'Content-Type: application/json' \
  -H 'api_token: string' \
  -d '{
    "prompt": "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."
  }'

Responses

Successful operation (Synchronous Success)

Bodyapplication/json
resultobjectrequired
request_idstringrequired
warningstring

Returned only when ip_signal = true and the prompt field included IP content.

Response
{ "result": { "seed": 0, "structured_prompt": "string" }, "request_id": "string", "warning": "string" }