Documentation

API reference

Generate images synchronously

POST/v1/images/generations

Synchronous requests validate parameters by model; only image capabilities supported by selected models are available. Qwen supports up to 6 images/3 reference images; Ark limits vary by model. Venice text-to-image produces one image and does not support reference images. Ordinary API files follow the day-based storage policy and are not equivalent to persistent image tasks.

Boundaries for synchronous output

Qwen supports up to 6 outputs and 3 reference images; Ark limits vary by model, and Venice only provides single-image text-to-image generation. Select a model first, then send its corresponding fields. Do not send reference-image requests to models that do not support them.

For quote confirmation, long-term history, and disconnect recovery, use the persistent image workflow rather than automatically repeating synchronous generation requests. File archival headers in synchronous responses only describe the saving stage. Ordinary file retention differs from task reference protection; see Billing.

Authentication and permissions

Use your current GloopAPI key. Available models, capabilities and permissions depend on its catalog and the endpoint documentation.

Authorization: Bearer $GLOOP_API_KEY

Authentication schemes: BearerAuth

Request

Request body · application/json

Type
object
Required fields
modelprompt

Request body required

  • image_urlsarrayOptional

    Model-specific list of reference image URLs. Qwen/Ark have their own limits; Venice synchronous text-to-image rejects this field.

    image_urls child fields (1)
    • []stringOptional
  • modelstringRequired

    Public model ID from the current key's catalog.

  • promptstringRequired

    Generation prompt.

  • nintegerOptional

    Requested output image count, still constrained by the selected model's maximum.

  • sizestringOptional

    Size value returned by the selected image-models entry; capabilities and sizes are validated per model.

  • response_formatstringOptional

    Model-specific output format; do not assume every model supports every format.

  • userunknownOptional

    JSON value defined by the selected tool's schema or protocol; do not assume fixed fields.

  • extra_bodyunknownOptional

    JSON value defined by the selected tool's schema or protocol; do not assume fixed fields.

Responses and errors

HTTP 200

Images generated synchronously successfully

application/json

Type
object
Required fields
createddata
  • createdintegerRequired

    Image response generation time in Unix seconds.

  • dataarrayRequired

    Array of data for the current page/catalog.

    data child fields (1)
    • []objectOptional
      [] child fields (7)
      • file_idstringOptional

        Public ID of a managed file for the same account and key.

      • storage_statusstringOptional

        File archival status; managed downloads are only guaranteed after ready.

      • storage_errorstringOptional

        Public category for file archival failure.

      • expires_atintegerOptional

        Expiration in Unix seconds; 0 means no fixed expiration.

      • urlstringOptional

        Access URL for a result or reference; signed URLs are only valid briefly.

      • b64_jsonstringOptional

        Image Base64 string; do not request it as a URL.

      • revised_promptstringOptional

        Revised prompt returned by the service, if any.

HTTP 400

Invalid request fields or parameters.

application/json

Type
object
Required fields
error

HTTP 401

The key is missing, invalid, expired, or revoked.

application/json

Type
object
Required fields
error

HTTP 403

Insufficient IP, account, model, or tool permissions.

application/json

Type
object
Required fields
error

HTTP 404

Object/capability unavailable, or feature switch disabled.

application/json

Type
object
Required fields
error

HTTP 409

Idempotency/quote conflict, object not ready, or still referenced.

application/json

Type
object
Required fields
error

HTTP 429

Request/queue rate limit.

application/json

Type
object
Required fields
error

HTTP 500

Internal authentication or data storage failure.

application/json

Type
object
Required fields
error

HTTP 503

Service, pricing, or storage unavailable.

application/json

Type
object
Required fields
error