Mesh APIImages

Generate Image

View as Markdown

OpenAI-compatible image generation endpoint.

Note: The image response may not render in GitBook’s “Test it” panel. To view the generated image, try this endpoint with Postman, curl, or another HTTP client.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
promptstringRequired
modelstring or nullOptional
nintegerOptional1-10Defaults to 1
qualitystringOptionalDefaults to auto
response_formatenumOptionalDefaults to url
sizestringOptionalDefaults to auto
aspect_ratiostring or nullOptional
resolutionstring or nullOptional
output_formatenum or nullOptional
output_compressioninteger or nullOptional0-100
backgroundenum or nullOptional
moderationenum or nullOptional
partial_imagesinteger or nullOptional0-3
imagestring or list of strings or nullOptional
seedinteger or nullOptional-1-2147483647
sequential_image_generationenum or nullOptional
sequential_image_generation_optionsmap from strings to any or nullOptional
guidance_scaledouble or nullOptional1-10
watermarkboolean or nullOptional
optimize_prompt_optionsmap from strings to any or nullOptional
streambooleanOptionalDefaults to false

Response

Successful Response

Errors

401
Unauthorized Error
402
Payment Required Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
501
Not Implemented Error