Documentation

API reference

Query persistent image history

GET/v1/image-tasks

History for the same key, 20 items per page, using the service's returned cursor. History is still checked against current model authorization.

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

Query parameters

  • cursorstringOptional

    next_cursor from the original response; do not assemble it yourself.

  • qstringOptional

    Prompt search, at most 256 UTF-8 bytes.

  • statusstringOptional

    Exact status filter: queued/dispatching/running/succeeded/partial_succeeded/failed/unknown.

    Enum
    ["queued","dispatching","running","succeeded","partial_succeeded","failed","unknown"]

Responses and errors

HTTP 200

Persistent image history queried successfully

application/json

Type
object
Required fields
datanext_cursor
  • dataarrayRequired

    Array of data for the current page/catalog.

    data child fields (1)
    • []objectOptional
      [] child fields (17)
      • modelstringRequired

        Public model ID from the current key's catalog.

      • promptstringRequired

        Generation prompt.

      • sizestringRequired

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

      • nintegerRequired

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

      • referencesarrayRequired

        List of reference images for generation.

        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

        Public source task ID, for provenance only.

      • quote_idstringOptional

        Public quote ID; must satisfy price and request binding on creation.

      • idstringRequired

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

      • statusstringRequired

        unknown is not automatically resubmitted; reserved billing may still be pending.

        Enum
        ["queued","dispatching","running","succeeded","partial_succeeded","failed","unknown","deleted"]
      • created_atintegerRequired

        Creation time in Unix seconds.

      • updated_atintegerRequired

        Last update time in Unix seconds.

      • reserved_quotaintegerRequired

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

      • final_quotaintegerRequired

        Final charge in platform quota units; null means not yet determined.

      • billing_statusstringRequired

        Reservation/settlement/refund status; check separately from task and archival status.

      • error_codestringOptional

        Public error code usable for branching logic.

      • error_messagestringOptional

        User-facing description processed through public error classification.

      • resultsarrayRequired

        Generated output items; each item's archival status is independent.

        results 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.

  • next_cursorstringRequired

    Cursor for the next page; pass it unchanged to this endpoint's pagination parameter. An empty value indicates the last page.

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