Documentation

API reference

Get a persistent image quote

POST/v1/image-quotes

Only validates inputs and permissions; does not lock images. Quotes are valid for 60 seconds, and creation revalidates route/price/request. A disabled service switch returns 503.

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
modelpromptsize
Additional properties
false

Request body required

  • modelstringRequired

    Public model ID from the current key's catalog.

    Maximum length
    191
  • promptstringRequired

    Nonempty, at most 32000 UTF-8 bytes. OpenAPI maxLength counts characters, so no artificial character limit is specified.

  • sizestringRequired

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

  • nintegerOptional

    Omitted or 0 values normalize to 1. The actual maximum is max_n from image-models; do not treat the global maximum as a model capability.

    Default value
    1
    Minimum
    1
    Maximum
    6
  • referencesarrayOptional

    Select only one of file_id, asset_id, or url per item; actual quantity is governed by max_references.

    Maximum items
    14
    references child fields (1)
    • []objectOptional
      [] child fields (3)
      • file_idstringOptional

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

      • asset_idstringOptional

        Upload asset ID for the same account and key.

      • urlstringOptional

        Public HTTPS URL; userinfo and fragment are prohibited, and SSRF checks apply.

        Format
        "uri"
      oneOf branch 1

      Required in this branch: file_id

      oneOf branch 2

      Required in this branch: asset_id

      oneOf branch 3

      Required in this branch: url

  • source_task_idstringOptional

    Optional source task belonging to the same key, for provenance only; does not replace references.

    Maximum length
    64
  • quote_idstringOptional

    Must be valid and match the request when creating a task; ignored in quote requests.

Responses and errors

HTTP 200

Persistent image quote retrieved successfully

application/json

Type
object
Required fields
pricing_noteidexpires_atreserved_quotaestimated_costcurrency
  • pricing_notestringRequired

    Model pricing description; final settlement uses confirmed metering.

  • idstringRequired

    Public identifier of this object, used for its corresponding detail path.

  • expires_atintegerRequired

    Expiration in Unix seconds; 0 means no fixed expiration.

  • reserved_quotaintegerRequired

    Reserved quota in platform quota units, not a USD amount.

  • estimated_costnumberRequired

    Estimated selling charge in the quote currency.

  • currencystringRequired

    Quote/billing currency.

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