Sociaro

ideogram/ideogram-3-reframe

Ideogram 3.0 Reframe: extends your image to a new resolution, the source pixels kept in the centre and the new area filled in.

Billed per image the generator produces.

Submit and poll on `POST /v1/ideogram/generations`, or send it to the Jobs API (`POST /v2/jobs`, one image per job).

Ideogram 3.0 on this gateway: ideogram/ideogram-3 · ideogram/ideogram-3-inpaint · ideogram/ideogram-3-reframe (this page) · ideogram/ideogram-3-remix · ideogram/ideogram-3-replace-background · ideogram/ideogram-3-transparent.

Slugideogram/ideogram-3-reframe
Kindimage
Vendorideogram
EndpointPOST /v1/ideogram/generations

Charged per job from what the generator reports it rendered — your Logs show the exact figure for each one; see balance and billing.

Calling it

curl https://api.sociaro.com/v1/ideogram/generations \
  -H "Authorization: Bearer $SOCIARO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "model": "ideogram/ideogram-3-reframe",
        "input": {"resolution": "1536x640", "image": "https://your-cdn.example.com/photo.png"}
      }'

# then poll the job id it returns:
curl https://api.sociaro.com/v1/ideogram/generations/JOB_ID \
  -H "Authorization: Bearer $SOCIARO_API_KEY"

Parameters

Ideogram 3.0 Reframe — extend an image to a new shape

FieldTypeRequiredDefaultValuesWhat it does
input.resolutionstringyes—one of the model's sizes, e.g. 1024x1024The exact output size, from the model's own list (the `/v2/models` schema lists them all). Cannot be combined with `aspect_ratio`. Does not change the price.
input.num_imagesintegerno11–8Images generated per request, each billed. Fixed at 1 on `/v2/jobs`.
input.seedintegernorandom0–2147483647The same seed and request reproduce the same picture.
input.rendering_speedstringnodefaultturbo · default · qualitySets the price per image (see below).
input.style_presetstringno—one of Ideogram's presets, e.g. watercolorA named look (the `/v2/models` schema lists all 62). Cannot be combined with `style_codes` or style references.
input.color_paletteobjectno—{"name": preset} or {"members": [...]}A preset (ember, fresh, jungle, magic, melon, mosaic, pastel, ultramarine) or your own hex colours, each with an optional weight 0.05–1.
input.style_codesstring[]no—8-character hex codesStyle codes from earlier Ideogram images. A list.
input.imagestringyes—a public https urlThe source image, JPEG, PNG or WEBP. Urls only: no base64. Up to 25 MB.
input.style_reference_imagesstring[]no—1–10 public https urlsImages whose style is copied, JPEG, PNG or WEBP, up to 25 MB each. Does not change the price.

Anything not listed here is refused rather than ignored, so a typo fails loudly instead of quietly producing something else.

Worked example

curl https://api.sociaro.com/v1/ideogram/generations \
  -H "Authorization: Bearer $SOCIARO_API_KEY" -H "Content-Type: application/json" \
  -d '{"model": "ideogram/ideogram-3-reframe", "input": {"image": "https://example.com/portrait.png", "resolution": "1536x640"}}'

curl https://api.sociaro.com/v1/ideogram/generations/{job_id} -H "Authorization: Bearer $SOCIARO_API_KEY"

Submit and poll. Send ideogram/ideogram-3-reframe to POST /v1/ideogram/generations and poll GET /v1/ideogram/generations/{job_id} until status is completed. On /v1 the results are in media_urls (media_url is the first), links on our domain valid for one hour; on the Jobs API poll GET /v2/jobs/{id} and read outputs[0].url, a permanent link on our CDN, with num_images fixed at 1.

Files are urls. image, style_reference_images take public https urls; the gateway fetches them itself and sends them on. A url it cannot fetch, a file over the size limit or a file that is not JPEG, PNG or WEBP is a 400 naming the field.

async and webhook_url are refused: use the callback options of the job.

How it is billed. Per image the generator produced, including one withheld after its own safety check (not delivered, still billed). A request the generator refuses, and a job that fails without producing anything, is not billed.

rendering_speed per image
turbo $0.03
default $0.06
quality $0.09

How a job runs

Generation takes longer than a request should wait, so it goes in three moves: submit, then poll, then collect.

# 1. submit — the model id plus the fields above
curl -sS https://api.sociaro.com/v1/alibaba/generations \
  -H "Authorization: Bearer $SOCIARO_API_KEY" -H "Content-Type: application/json" \
  -d '{ "model": "…", "prompt": "…" }'
# -> { "job_id": "<id>", "status": "submitted" }

# 2. poll every 3-5 s for images, 5-10 s for video
curl -sS https://api.sociaro.com/v1/alibaba/generations/<id> \
  -H "Authorization: Bearer $SOCIARO_API_KEY"
# -> { "job_id": "…", "status": "processing" }
# -> { "job_id": "…", "status": "completed", "model": "…",
#      "media_url": "https://api.sociaro.com/v1/media/<media_id>" }
# -> { "job_id": "…", "status": "failed", "model": "…", "error": { "code": …, "message": … } }

# 3. collect within the hour — the opaque id IS the credential, no header needed
curl -sSL "https://api.sociaro.com/v1/media/<media_id>" -o out.mp4

Use the job_id verbatim as the path segment when polling: the two names are the same value. Which submit and poll URL this model uses is at the top of this page, under Calling it.

Reading the poll

status is one of processing · completed · failed. Only completed carries media_url, only failed carries error.

Gate on status, never on the poll's HTTP code. A poll-time failure is HTTP 200 with status: "failed" and an error object of { "code", "message" }, plus provider_code when the generator supplied one — on every failure branch, including one where the result could not be delivered. A submit-time rejection is different: it comes back as its own HTTP status with the reason in the body.

code is ours and stable; message is the generator's. Match on code: it comes from a small fixed set, and provider_failed still means what it always meant. A rejection of what you sent — a size out of range, an unusable input — additionally sets code: "invalid_request", because that is a different thing for your code to do. message now carries the generator's own sentence, and provider_code its own code (OutputVideoSensitiveContentDetected.PolicyViolation, IPInfringementSuspect), so a moderated generation, a copyright refusal and a broken renderer are finally distinguishable. Treat provider_code as informational: the vendors change these strings without telling us, so branch on ours.

message is variable text, capped at 400 characters. It used to be a single fixed 43-character sentence, so if you compare it by equality or keep it in a narrower column, that needs changing — match on code, and on provider_code when you need the finer distinction.

Two things that text is not. It does not name the generator behind the model: the names of the services and hosts that actually run your job are substituted out before you see it, so do not parse it for one. What it does not hide is a name you already have — the halves of the model id you called (alibaba, bytedance, wan, qwen, seedance, seedream, happyhorse) stay as written, because blanking those would garble the message exactly where it is useful: Model alibaba/wan-2-7-image not found has to survive intact. And the text can quote your own request back: a moderation message often contains the fragment it objected to. That is why we do not write it into our own logs, and why forwarding or storing a failed poll's message is your decision to make rather than something to do by default.

Collecting the result

media_url points at our host, not the generator's. It is a capability: the opaque id is the credential, so no Authorization header is needed and anyone holding the link can fetch it. It expires within the hour — download rather than store the link.

Several images are not optional extras. An Alibaba image model asked for more than one picture (n above 1) is charged for the number of pictures the generator reports making, and every link it returns is delivered, never fewer than that number: media_urls lists all of them in the generator's order (present on every image result, even a single one) and media_url is the first. Each has its own link and its own expiry. If any one of them cannot be delivered the job is reported failed and nothing is charged — unlike a still or a layer, an image you paid for is never left out.

Rules the gateway adds

Two fields are ours and never reach the generator:

Field Notes
model which model to run
user your own end-user id. Recorded against this job's spend so you can attribute cost per end user, and stripped before the request leaves us, so the generator never sees it. Validated BEFORE the job is created, so a rejection is free: a string of at most 128 characters, no control characters, valid UTF-8. Omitting it, or sending null, is fine and simply records no end user

An unknown field is always a 400. Most generators reject one themselves; some accept it, ignore it, render something other than what you asked for and bill you — so we refuse it for you. Either way you get 400 unknown field(s): [...] naming the offender, never a surprise render.

Ranges and enums are the generator's own and we do not re-validate most of them, so an out-of-range value comes back as its rejection, in its wording and with its numbers. The one thing we DO check ourselves is resolution, because an unsupported tier is silently ignored rather than refused: you would ask for the higher tier, be handed a lower one, and be charged. The tiers on this page are read from what the vendor prices, so they change when the vendor publishes one.

Authentication

Authorization: Bearer <your-api-key> on submit and on poll. The key must be valid AND granted this model — 403 otherwise.

One deliberate exception on poll: a key that is over budget may still poll and collect a job it already submitted, so work you have already paid for is never stranded by a budget that ran out mid-generation. While the key is over budget the gateway cannot read its model list at all, so the per-model grant is not re-checked on those polls — a grant revoked after submit still collects that job. Ownership is always enforced: a job can only be polled by the key that created it, and submit is always refused in that state.