Ideogram v3 Reframe

Endpoint

POST https://api.roasos.com/v1/reframe/ideogram-v3

Send your API key as a bearer token. The key needs the scope api:write. Every paid request also needs an Idempotency-Key header.

The envelope fields quote_only, quote_id, webhook_url and wait_timeout_seconds behave the same on each model endpoint. Refer to Jobs and Quotes and credits.

Good at

Take one product shot to every placement size you need. The price is per IMAGE, and num_images multiplies it.

$0.03 with TURBO, $0.06 with BALANCED, $0.09 with QUALITY. In credits: 1, 1 and 2 for one image. Four images at QUALITY cost 5 credits, not 8, because roasOS rounds the whole request one time and not each image. Quote the request you mean to send.

This is the one reframe lane that returns an image, so its job reports the image kind.

Pricing

The unit is one image. Pricing key: ideogram-v3.

The credits come from the roasOS pricing table. No other field changes the price. To get the exact price of your request, send it with quote_only: true first.

Modes

• reframe

Provider endpoints: fal-ai/ideogram/v3/reframe.

Request fields

The schema is strict. A field that is not in this table gets 400 unsupported_option. The field names are the roasOS role names. One role has one name in every family.

Media

This endpoint accepts these media roles:

• image_url — first frame (or the single source image)

Every other role is refused: avatar_id, elements, product_id, product_images, references, reference_images, end_image_url, scene_id, scene_image, video_urls, video_url, audio_urls, audio_url, voice_id. A refused role gets 400 unsupported_option.

Prompt

None. This model takes no prompt.

rendering_speed is required and has no default here, although the provider defaults it to BALANCED — in the middle of a threefold price spread. Choose it deliberately.

Not exposed

These catalog entries describe omitted inputs, pinned values and source constraints. They do not imply that the provider accepts every listed field.

• rendering_speed — pinned to required, with no default: fal defaults it to BALANCED across a 3x spread.
• image_urls — not accepted by this public endpoint.
• style — not accepted by this public endpoint.
• style_codes — not accepted by this public endpoint.
• style_preset — not accepted by this public endpoint.
• color_palette — not accepted by this public endpoint.
• sync_mode — not accepted by this public endpoint.
• num_images — pinned to fal accepts 1-8; this door admits and delivers 1-4.

Result

The result kind is image. Always present: nothing. Present when the run makes it: avatar_id, full_body_url, images, portrait_url, provider_seed, reference_sheet, url.

{
  "data": {
    "id": "gen_…",
    "kind": "video",
    "model": "ideogram-v3",
    "status": "completed",
    "result": {
      "avatar_id": "00000000-0000-4000-8000-000000000000",
      "full_body_url": "https://cdn.roasos.com/workspaces/ws_01/full_body_url",
      "images": [
        "https://cdn.roasos.com/workspaces/ws_01/images-1.png"
      ],
      "portrait_url": "https://cdn.roasos.com/workspaces/ws_01/portrait_url",
      "provider_seed": 0,
      "reference_sheet": "https://cdn.roasos.com/workspaces/ws_01/reference_sheet",
      "url": "https://cdn.roasos.com/workspaces/ws_01/result"
    }
  }
}

The files are immutable objects on https://cdn.roasos.com. A result URL is a valid media input for your next request.

Example

The three steps are always the same: quote, run, poll.

# 1. Quote. Nothing is spent.
curl -X POST https://api.roasos.com/v1/reframe/ideogram-v3 \
  -H "Authorization: Bearer roasos_sk_live_..." \
  -H "Idempotency-Key: 0f1c9e2a-ideogram-v3-0001" \
  -H "Content-Type: application/json" \
  -d '{"quote_only":true,"image_size":"square_hd","image_url":"https://cdn.roasos.com/workspaces/ws_01/uploads/image_url.png","rendering_speed":"TURBO"}'
# 200 { "data": { "kind": "quote", "quote_id": "q_7Hk...", "credits": 1, "expires_at": "...",
#        "confirmation": { "model": "ideogram-v3", "example": "1_image_turbo" } } }

# 2. Run. Same body, same Idempotency-Key, quote_id in place of quote_only.
curl -X POST https://api.roasos.com/v1/reframe/ideogram-v3 \
  -H "Authorization: Bearer roasos_sk_live_..." \
  -H "Idempotency-Key: 0f1c9e2a-ideogram-v3-0001" \
  -H "Content-Type: application/json" \
  -d '{"quote_id":"q_7Hk...","image_size":"square_hd","image_url":"https://cdn.roasos.com/workspaces/ws_01/uploads/image_url.png","rendering_speed":"TURBO"}'
# 201 { "data": { "id": "gen_...", "status": "queued", "credits_reserved": 1 } }

# 3. Poll, then read the result.
curl https://api.roasos.com/v1/jobs/gen_.../status -H "Authorization: Bearer roasos_sk_live_..."
curl https://api.roasos.com/v1/jobs/gen_.../result -H "Authorization: Bearer roasos_sk_live_..."

Today

The endpoint is POST /v1/reframe/ideogram-v3.

It is not live yet. The route answers 501 model_endpoint_not_implemented. The live completion-intent validator has no branch for an ideogram reframe, so a completed job could not be recorded after the caller was charged. The lane opens with the migration that admits it, and not before.

See also

• llms.txt for this model — the same facts as one plain-text file for an agent.
• GET https://api.roasos.com/v1/catalog/ideogram-v3 — the machine-readable form: enums, defaults, limits and prices. Refer to the API reference.
• Jobs — how to poll a job and read its result.
• Provider endpoints: fal-ai/ideogram/v3/reframe.