Documentation

API reference

Get a persistent video quote

POST/v1/video-quotes

retention=persistent; quotes use catalog-supported modes and managed frames. When the switch is off, the route returns 404 directly. Reconfirm if the quote expires or prices change.

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

Request body required

  • modestringOptional

    Required for persistent.

    Enum
    ["text_to_video","image_to_video"]
  • retentionstringOptional

    persistent uses the persistent workspace; omission creates an ordinary task.

  • quote_idstringOptional

    New persistent requests must first confirm a valid quote returned by video-quotes.

  • start_frameobjectOptional

    Required for persistent image-to-video: a managed file belonging to the same key. Prohibited for text-to-video.

    start_frame child fields (1)
    • file_idstringRequired

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

    allOf branch 1

    Type: object

    Required in this branch: file_id

    • file_idstringRequired

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

  • end_frameobjectOptional

    Optional final frame for persistent; the capability must support it.

    end_frame child fields (1)
    • file_idstringRequired

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

    allOf branch 1

    Type: object

    Required in this branch: file_id

    • file_idstringRequired

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

  • webhook_endpoint_idstringOptional

    Ordinary tasks may reference a receiver configured in the console; prohibited for persistent.

  • modelstringRequired

    Public model ID from the current key's catalog; does not guarantee that a historical model remains available.

  • promptstringRequired

    Generation prompt.

    Minimum length
    1
    Maximum length
    2500
  • durationintegerOptional

    Model-specific duration in seconds. Use the complete combination from video-models mode.presets, not a Cartesian product. Wan Turbo does not support this field; there is no uniform default.

  • image_urlstringOptional

    Model-specific public HTTPS first frame for ordinary tasks only; prohibited for persistent.

  • end_image_urlstringOptional

    Model-specific public HTTPS final frame for ordinary tasks only; prohibited for persistent.

  • resolutionstringOptional

    Resolution value in the model preset.

  • aspect_ratiostringOptional

    Aspect ratio value in the model preset.

  • generate_audiobooleanOptionalAllows null

    Model-dependent; use the mode's audio policy and presets. Do not assume every model generates audio.

Responses and errors

HTTP 200

Persistent video quote retrieved successfully

application/json

Type
object
Required fields
idexpires_atrequest_hashpricing_kindcurrencyreserved_quotareserved_amountestimated_final_amountsettlement_note
  • idstringRequired

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

  • expires_atintegerRequired

    Expiration in Unix seconds; 0 means no fixed expiration.

  • request_hashstringRequired

    Normalized request digest binding quote and creation; not the idempotency request key.

  • pricing_kindstringRequired

    Pricing method actually used for this quote.

  • currencystringRequired

    Quote/billing currency.

  • reserved_quotaintegerRequired

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

  • reserved_amountstringRequired

    Maximum reservation amount as a string in the quote currency.

  • estimated_final_amountstringRequiredAllows null

    Estimated final amount as a string; null means it cannot be determined before generation.

  • settlement_notestringRequired

    Actual metering and settlement description.

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

Endpoint notes

These parameters only illustrate a complete preset. Copy the entire preset (duration, resolution, aspect_ratio, generate_audio) for your selected model/mode from the current key's video-models catalog; do not just replace the model or mix presets.