Generate > Text to Image

Text to Image

Generate media with the capability-specific input contract.

POST/api/app/v1/generate/image/text_to_image

Examples

curl -X POST https://api.medux.io/api/app/v1/generate/image/text_to_image \
  -H 'Authorization: Bearer $MEDUX_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"aspect_ratio":"ASPECT_RATIO","clarity":"CLARITY","image_file_ids":["FILE_ID"],"model_id":"MODEL_ID","prompt":"PROMPT","quantity":1,"title":"Demo title"}'

Auth Requirements

Authentication is required via Authorization header.

Preconditions

Choose an available model and enter a prompt.

Provide a non-empty prompt and up to eight image_file_ids. Choose a supported quantity; Seedream 5.0 Pro returns one image.

Read generation_options from the model catalog; only listed parameter values are accepted.

Use clarity for output resolution. Estimate credits with the same parameters before submission.

Request

Body

application/json

Authorizationstringrequired

Bearer token or API key.

Location: HEADER

aspect_ratiostringoptional

No description provided.

Location: BODY

claritystringoptional

No description provided.

Location: BODY

image_file_idsarray<string>optional

No description provided.

Location: BODY

model_idstringoptional

No description provided.

Location: BODY

promptstringrequired

No description provided.

Location: BODY

quantityint32optional

No description provided.

Location: BODY

titlestringoptional

No description provided.

Location: BODY

Response

application/json

codeint32optional

response code enums:
.. 0: ok
.. 12: invalid input
.. 1410: invalid model
.. 1409: paid plan required
.. 1401: insufficient credits
.... 1401 ~ 1499 是 media
.. 13: unauthenticated
.. 1404: provider error
.. 99: server error

Available options: 0 12 1410 1409 1401 13 1404 99

Location: RESPONSE

data.assetobjectoptional

No description provided.

Location: RESPONSE

data.paid_plan_requiredobjectoptional

No description provided.

Location: RESPONSE

data.taskobjectoptional

No description provided.

Location: RESPONSE

messagestringoptional

No description provided.

Available options: ok invalid input invalid model paid plan required insufficient credits unauthenticated provider error server error

Location: RESPONSE

MCP Tool

This endpoint is also available through the Medux-hosted remote MCP service.

Text to Image

Generate images from a non-empty prompt and optional image references. Inspect the model catalog and estimate credits before submitting.

Invocation Example

Generate one product image from my prompt using Seedream 4.0.

medux_image_generate_text_to_imageResult: image

model_idseedream-4-0quantity1prompt{prompt}

Check the selected model's input limits and account availability before submitting.

On this page