Loading your account

API reference

Generated from the OpenAPI 3.1 document the API serves. Open a request or response to see its fields.

Download openapi.jsonVersion 1.0.0 · OpenAPI 3.1.0

Models

What you can run and what it costs.

get/v1/models

· List modelsPublic, no key

Every model open to the API right now, in display order: task type, params with their enum values and ranges, defaults, input limits and priceFromCoins (the coins of a request that sets only the prompt). Send only the params you want to set: omitted params take the model default. Public, cached for a minute.

Responses

200

The catalog.

application/jsonPublicModelsResponse

get/v1/effects

· List effectsPublic, no key

Style filters and templates. Run one by quoting and submitting with its modelId and effectId; params then hold the effect input (images or video, and an optional prompt direction). Public.

Responses

200

The effects.

application/jsonEffectsResponse

Generations

Quote, start, follow and cancel generations.

post/v1/quotes

· Quote a generationScope: generate

Prices a request exactly as a submit would. The quoteToken (valid 10 minutes) reserves exactly coins when you submit with it; after it expires the submit is accepted only at the same price (else price_changed).

Request body

application/json QuoteRequest
  • modelIdstringrequired

    min length 1

  • paramsobjectrequired
  • draftboolean

    default false

  • effectIdstring

    pattern ^[a-z0-9][a-z0-9-]{0,63}$

Responses

200

The price.

application/jsonQuoteResponse
400

Invalid request: invalid_params, invalid_quote, idempotency_key_required, consent_required, input_too_large, input_duration, wrong_media…

application/problem+jsonProblem
401

No valid key: unauthorized, invalid_api_key, api_key_revoked, api_key_expired.

application/problem+jsonProblem
403

insufficient_scope, cooldown, account_locked.

application/problem+jsonProblem
404

not_found or unknown_model.

application/problem+jsonProblem
429

rate_limited: wait Retry-After seconds.

application/problem+jsonProblem
503

unavailable, maintenance or channel_disabled: nothing was charged; retry later.

application/problem+jsonProblem

get/v1/generations

· List generationsScope: read

Your generations, newest first, with cursor pagination: pass nextCursor back as cursor until it is null.

Parameters

  • cursorstringquery

    nextCursor of the previous page.

  • limitintegerquery

    ≥ 1 · ≤ 100 · default 30

  • statusstringquery

    one of "queued", "processing", "succeeded", "failed", "canceled"

  • modalitystringquery

    one of "image", "video", "audio", "3d"

  • workspacestringquery

    one of "image", "video", "audio", "3d", "tools"

  • modelIdstringquery
  • activebooleanquery

    Only generations that are still queued or processing.

Responses

200

One page.

application/jsonGenerationPage
400

Invalid request: invalid_params, invalid_quote, idempotency_key_required, consent_required, input_too_large, input_duration, wrong_media…

application/problem+jsonProblem
401

No valid key: unauthorized, invalid_api_key, api_key_revoked, api_key_expired.

application/problem+jsonProblem
403

insufficient_scope, cooldown, account_locked.

application/problem+jsonProblem
429

rate_limited: wait Retry-After seconds.

application/problem+jsonProblem

post/v1/generations

· Start a generationScope: generate

Holds the coins and queues the generation. Send exactly one of quoteToken (charge exactly the quoted coins) or maxCoins (charge the current price, refused with max_coins_exceeded above it): you are never charged more than either. The Idempotency-Key header is required: repeating a key with the same body returns the original generation (200); the same key with another body is idempotency_conflict (409). Failed generations are refunded in full; partial results are charged per delivered output.

Parameters

  • Idempotency-Keystringheaderrequired

    min length 16 · max length 128 · pattern ^[A-Za-z0-9_-]+$

    16–128 characters of A–Z a–z 0–9 _ -, unique per intended generation (a UUID works). Scoped to your account.

Request body

application/json CreateGenerationRequest
  • modelIdstringrequired

    min length 1

  • paramsobjectrequired
  • quoteTokenstring

    min length 1

  • maxCoinsinteger

    > 0

  • projectIdstring | null

    min length 1

  • effectIdstring

    pattern ^[a-z0-9][a-z0-9-]{0,63}$

  • consenttrue

Responses

200

A replay of an earlier request with the same key.

application/jsonGeneration
201

Created and queued.

application/jsonGeneration
400

Invalid request: invalid_params, invalid_quote, idempotency_key_required, consent_required, input_too_large, input_duration, wrong_media…

application/problem+jsonProblem
401

No valid key: unauthorized, invalid_api_key, api_key_revoked, api_key_expired.

application/problem+jsonProblem
402

insufficient_coins, or spend_cap_exceeded for the key's monthly cap.

application/problem+jsonProblem
403

insufficient_scope, cooldown, account_locked.

application/problem+jsonProblem
404

not_found or unknown_model.

application/problem+jsonProblem
409

idempotency_conflict, price_changed, max_coins_exceeded, not_cancelable.

application/problem+jsonProblem
429

rate_limited: wait Retry-After seconds.

application/problem+jsonProblem
503

unavailable, maintenance or channel_disabled: nothing was charged; retry later.

application/problem+jsonProblem

get/v1/generations/{id}

· Get a generationScope: read

Status (queued, processing, succeeded, failed, canceled), progress, coins and outputs. Output URLs are signed and short-lived: read the generation again for fresh ones. Prefer webhooks to polling; poll no faster than every 2 seconds.

Parameters

  • idstring (uuid)pathrequired

    The generation id.

Responses

200

The generation.

application/jsonGeneration
401

No valid key: unauthorized, invalid_api_key, api_key_revoked, api_key_expired.

application/problem+jsonProblem
403

insufficient_scope, cooldown, account_locked.

application/problem+jsonProblem
404

not_found or unknown_model.

application/problem+jsonProblem
429

rate_limited: wait Retry-After seconds.

application/problem+jsonProblem

post/v1/generations/{id}/cancel

· Cancel a queued generationScope: generate

Free, and only while the generation is still queued (not yet sent for processing); the held coins are released. Otherwise not_cancelable (409).

Parameters

  • idstring (uuid)pathrequired

    The generation id.

Responses

200

Canceled.

application/jsonGeneration
401

No valid key: unauthorized, invalid_api_key, api_key_revoked, api_key_expired.

application/problem+jsonProblem
403

insufficient_scope, cooldown, account_locked.

application/problem+jsonProblem
404

not_found or unknown_model.

application/problem+jsonProblem
409

idempotency_conflict, price_changed, max_coins_exceeded, not_cancelable.

application/problem+jsonProblem
429

rate_limited: wait Retry-After seconds.

application/problem+jsonProblem

Files

Input uploads and output files.

post/v1/uploads

· Upload an input fileScope: uploads

One image (PNG, JPEG, WebP ≤ 20 MB, ≤ 8192 px), audio file (MP3, WAV, M4A, OGG ≤ 50 MB, ≤ 10 min) or video (MP4, WebM, MOV ≤ 200 MB, ≤ 60 s, ≤ 4096 px) as multipart/form-data in the field file. Use the returned id in a media param (image, images, first_frame, audio, video…). Uploads are deleted after 30 days.

Request body

multipart/form-data object
  • filestringrequired

    One of image/png, image/jpeg, image/webp, audio/mpeg, audio/wav, audio/mp4, audio/ogg, video/mp4, video/webm, video/quicktime.

Responses

201

Stored.

application/jsonAsset
400

Invalid request: invalid_params, invalid_quote, idempotency_key_required, consent_required, input_too_large, input_duration, wrong_media…

application/problem+jsonProblem
401

No valid key: unauthorized, invalid_api_key, api_key_revoked, api_key_expired.

application/problem+jsonProblem
403

insufficient_scope, cooldown, account_locked.

application/problem+jsonProblem
413

upload_too_large, upload_too_long.

application/problem+jsonProblem
415

upload_invalid.

application/problem+jsonProblem
429

rate_limited: wait Retry-After seconds.

application/problem+jsonProblem
503

unavailable, maintenance or channel_disabled: nothing was charged; retry later.

application/problem+jsonProblem

get/v1/assets/{id}

· Get a fileScope: read

An output or upload with freshly signed, short-lived download URLs (about an hour).

Parameters

  • idstring (uuid)pathrequired

    The asset id.

Responses

200

The file.

application/jsonAsset
401

No valid key: unauthorized, invalid_api_key, api_key_revoked, api_key_expired.

application/problem+jsonProblem
403

insufficient_scope, cooldown, account_locked.

application/problem+jsonProblem
404

not_found or unknown_model.

application/problem+jsonProblem
429

rate_limited: wait Retry-After seconds.

application/problem+jsonProblem

Account

Balance and limits.

get/v1/generations/concurrency

· Running-generation limitScope: read

How many generations run at once for you, and how many run or wait now. Generations over the limit wait in the queue.

Responses

200

The limit.

application/jsonConcurrency
401

No valid key: unauthorized, invalid_api_key, api_key_revoked, api_key_expired.

application/problem+jsonProblem
403

insufficient_scope, cooldown, account_locked.

application/problem+jsonProblem
429

rate_limited: wait Retry-After seconds.

application/problem+jsonProblem

get/v1/account

· Balance and limitsScope: account

Your coin balance, running-generation limit, rate limits and the calling key with its monthly spend.

Responses

200

The account.

application/jsonPublicAccount
401

No valid key: unauthorized, invalid_api_key, api_key_revoked, api_key_expired.

application/problem+jsonProblem
403

insufficient_scope, cooldown, account_locked.

application/problem+jsonProblem
429

rate_limited: wait Retry-After seconds.

application/problem+jsonProblem

Webhook events

Requests inker sends to your endpoints.

POST generation.succeeded

Sent to your endpoint when a generation ends this way. Verify Inker-Signature (t=<unix>,v1=<hex HMAC-SHA256(secret, "<t>.<raw body>")>), refuse a t more than 300 s off, dedupe on Inker-Event-Id and answer 2xx within 10 s. Failed deliveries are retried for about a day.

application/json
  • idstringrequired

    min length 1

  • typestringrequired

    one of "generation.succeeded", "generation.failed", "generation.canceled"

  • createdAtstring (date-time)required
  • dataobjectrequired
    Fields

POST generation.failed

Sent to your endpoint when a generation ends this way. Verify Inker-Signature (t=<unix>,v1=<hex HMAC-SHA256(secret, "<t>.<raw body>")>), refuse a t more than 300 s off, dedupe on Inker-Event-Id and answer 2xx within 10 s. Failed deliveries are retried for about a day.

application/json
  • idstringrequired

    min length 1

  • typestringrequired

    one of "generation.succeeded", "generation.failed", "generation.canceled"

  • createdAtstring (date-time)required
  • dataobjectrequired
    Fields

POST generation.canceled

Sent to your endpoint when a generation ends this way. Verify Inker-Signature (t=<unix>,v1=<hex HMAC-SHA256(secret, "<t>.<raw body>")>), refuse a t more than 300 s off, dedupe on Inker-Event-Id and answer 2xx within 10 s. Failed deliveries are retried for about a day.

application/json
  • idstringrequired

    min length 1

  • typestringrequired

    one of "generation.succeeded", "generation.failed", "generation.canceled"

  • createdAtstring (date-time)required
  • dataobjectrequired
    Fields

Schemas

The objects the endpoints accept and return, each documented once.

Asset
  • idstringrequired

    min length 1 · max length 128 · pattern ^[A-Za-z0-9_-]+$

  • kindstringrequired

    one of "image", "video", "audio", "3d", "text"

  • urlstringrequired

    min length 1

  • thumbnailUrlstringrequired

    min length 1

  • posterUrlstring | nullrequired

    min length 1

  • mimeTypestringrequired

    min length 1

  • widthinteger | nullrequired

    > 0

  • heightinteger | nullrequired

    > 0

  • durationSecondsnumber | nullrequired

    > 0

  • waveformUrlstring | null

    min length 1

  • transparentboolean
  • downloadsarray of object
    Fields
    • formatstringrequired

      one of "obj", "fbx", "usdz", "stl"

    • urlstringrequired

      min length 1

    • bytesintegerrequired

      > 0

  • stemstring | null

    one of "vocals", "drums", "bass", "other"

  • subtitlesobject | null
    Fields
    • srtUrlstringrequired

      min length 1

    • vttUrlstringrequired

      min length 1

Generation
  • idstringrequired

    min length 1

  • modelIdstringrequired

    min length 1

  • modelNamestringrequired

    min length 1

  • taskTypestringrequired

    one of "image.generate", "image.edit", "video.generate", "video.animate", "image.upscale", "image.remove-bg", "image.inpaint", "image.outpaint", "image.relight", "image.vectorize", "image.restore", "image.effect", "video.v2v", "video.extend", "video.upscale", "video.interpolate", "video.remove-bg", "video.add-audio", "video.lipsync", "video.effect", "video.reframe", "audio.tts", "audio.music", "audio.sfx", "audio.voice-change", "audio.isolate", "audio.stt", "3d.from-text", "3d.from-image", "image.erase", "image.reframe", "image.sketch", "image.restyle", "image.colorize", "image.retouch", "image.product-shot", "image.replace-bg", "image.try-on"

  • modalitystringrequired

    one of "image", "video", "audio", "3d"

  • workspacestringrequired

    one of "image", "video", "audio", "3d", "tools"

  • effectobject | nullrequired
    Fields
    • idstringrequired

      min length 1

    • textstring | nullrequired
  • statusstringrequired

    one of "queued", "processing", "succeeded", "failed", "canceled"

  • progressnumber | nullrequired

    ≥ 0 · ≤ 1

  • queuePositioninteger | nullrequired

    > 0

  • paramsobjectrequired
  • coinsQuotedintegerrequired

    > 0

  • coinsChargedinteger | nullrequired

    ≥ 0

  • outputsarray of Assetrequired
    Asset
  • outputsRequestedintegerrequired

    > 0

  • errorobject | nullrequired
    Fields
    • codestringrequired

      one of "content_policy", "invalid_input", "unavailable", "timeout", "internal"

  • projectIdstring | nullrequired

    min length 1

  • createdAtstring (date-time)required
  • startedAtstring (date-time) | nullrequired
  • completedAtstring (date-time) | nullrequired
GenerationPage
  • itemsarray of Generationrequired
    Generation
  • nextCursorstring | nullrequired

    min length 1

QuoteResponse
  • modelIdstringrequired

    min length 1

  • coinsintegerrequired

    > 0

  • coinsPerOutputintegerrequired

    > 0

  • outputsintegerrequired

    > 0

  • quoteTokenstring | nullrequired

    min length 1

  • expiresAtstring (date-time)required
  • availableCoinsintegerrequired

    ≥ 0

Concurrency
  • limitintegerrequired

    > 0

  • raisedLimitinteger | nullrequired

    > 0

  • runningintegerrequired

    ≥ 0

  • queuedintegerrequired

    ≥ 0

PublicModelsResponse
  • modelsarray of objectrequired
    Fields
    • idstringrequired

      min length 1

    • listingIdstringrequired

      min length 1

    • taskTypestringrequired

      one of "image.generate", "image.edit", "video.generate", "video.animate", "image.upscale", "image.remove-bg", "image.inpaint", "image.outpaint", "image.relight", "image.vectorize", "image.restore", "image.effect", "video.v2v", "video.extend", "video.upscale", "video.interpolate", "video.remove-bg", "video.add-audio", "video.lipsync", "video.effect", "video.reframe", "audio.tts", "audio.music", "audio.sfx", "audio.voice-change", "audio.isolate", "audio.stt", "3d.from-text", "3d.from-image", "image.erase", "image.reframe", "image.sketch", "image.restyle", "image.colorize", "image.retouch", "image.product-shot", "image.replace-bg", "image.try-on"

    • modalitystringrequired

      one of "image", "video", "audio", "3d"

    • workspacestringrequired

      one of "image", "video", "audio", "3d", "tools"

    • vendorstringrequired

      min length 1

    • displayNamestringrequired

      min length 1

    • paramsarray of object | object | object | object | object | objectrequired
      Fields
      • namestringrequired

        one of "prompt", "negative_prompt", "aspect_ratio", "resolution", "duration", "num_outputs", "seed", "images", "image", "first_frame", "last_frame", "generate_audio", "upscale_factor", "mask", "expand_left", "expand_right", "expand_top", "expand_bottom", "video", "audio", "fps", "effect", "text", "voice", "language", "speed", "lyrics", "style", "instrumental", "stem", "polycount", "texture", "format", "garment", "lighting", "light_direction", "palette", "pbr", "quad", "geometry_quality", "texture_quality"

      • requiredbooleanrequired
      • uiobjectrequired
        Fields
        • controlstringrequired

          one of "prompt", "textarea", "aspect", "segmented", "select", "switch", "seed", "image", "images", "script", "lyrics", "tags", "voice", "language", "slider", "audio", "video", "mask", "expand", "effect"

        • groupstringrequired

          one of "prompt", "inputs", "basic", "advanced"

        • orderintegerrequired
      • kind"text"required
      • maxLengthintegerrequired

        > 0

      • minLengthinteger

        > 0

      Fields
      • namestringrequired

        one of "prompt", "negative_prompt", "aspect_ratio", "resolution", "duration", "num_outputs", "seed", "images", "image", "first_frame", "last_frame", "generate_audio", "upscale_factor", "mask", "expand_left", "expand_right", "expand_top", "expand_bottom", "video", "audio", "fps", "effect", "text", "voice", "language", "speed", "lyrics", "style", "instrumental", "stem", "polycount", "texture", "format", "garment", "lighting", "light_direction", "palette", "pbr", "quad", "geometry_quality", "texture_quality"

      • requiredbooleanrequired
      • uiobjectrequired
        Fields
        • controlstringrequired

          one of "prompt", "textarea", "aspect", "segmented", "select", "switch", "seed", "image", "images", "script", "lyrics", "tags", "voice", "language", "slider", "audio", "video", "mask", "expand", "effect"

        • groupstringrequired

          one of "prompt", "inputs", "basic", "advanced"

        • orderintegerrequired
      • kind"enum"required
      • valuesarray of string | number | booleanrequired

        min items 1

      Fields
      • namestringrequired

        one of "prompt", "negative_prompt", "aspect_ratio", "resolution", "duration", "num_outputs", "seed", "images", "image", "first_frame", "last_frame", "generate_audio", "upscale_factor", "mask", "expand_left", "expand_right", "expand_top", "expand_bottom", "video", "audio", "fps", "effect", "text", "voice", "language", "speed", "lyrics", "style", "instrumental", "stem", "polycount", "texture", "format", "garment", "lighting", "light_direction", "palette", "pbr", "quad", "geometry_quality", "texture_quality"

      • requiredbooleanrequired
      • uiobjectrequired
        Fields
        • controlstringrequired

          one of "prompt", "textarea", "aspect", "segmented", "select", "switch", "seed", "image", "images", "script", "lyrics", "tags", "voice", "language", "slider", "audio", "video", "mask", "expand", "effect"

        • groupstringrequired

          one of "prompt", "inputs", "basic", "advanced"

        • orderintegerrequired
      • kind"range"required
      • minnumberrequired
      • maxnumberrequired
      • stepnumberrequired

        > 0

      Fields
      • namestringrequired

        one of "prompt", "negative_prompt", "aspect_ratio", "resolution", "duration", "num_outputs", "seed", "images", "image", "first_frame", "last_frame", "generate_audio", "upscale_factor", "mask", "expand_left", "expand_right", "expand_top", "expand_bottom", "video", "audio", "fps", "effect", "text", "voice", "language", "speed", "lyrics", "style", "instrumental", "stem", "polycount", "texture", "format", "garment", "lighting", "light_direction", "palette", "pbr", "quad", "geometry_quality", "texture_quality"

      • requiredbooleanrequired
      • uiobjectrequired
        Fields
        • controlstringrequired

          one of "prompt", "textarea", "aspect", "segmented", "select", "switch", "seed", "image", "images", "script", "lyrics", "tags", "voice", "language", "slider", "audio", "video", "mask", "expand", "effect"

        • groupstringrequired

          one of "prompt", "inputs", "basic", "advanced"

        • orderintegerrequired
      • kind"seed"required
      • maxintegerrequired

        > 0

      Fields
      • namestringrequired

        one of "prompt", "negative_prompt", "aspect_ratio", "resolution", "duration", "num_outputs", "seed", "images", "image", "first_frame", "last_frame", "generate_audio", "upscale_factor", "mask", "expand_left", "expand_right", "expand_top", "expand_bottom", "video", "audio", "fps", "effect", "text", "voice", "language", "speed", "lyrics", "style", "instrumental", "stem", "polycount", "texture", "format", "garment", "lighting", "light_direction", "palette", "pbr", "quad", "geometry_quality", "texture_quality"

      • requiredbooleanrequired
      • uiobjectrequired
        Fields
        • controlstringrequired

          one of "prompt", "textarea", "aspect", "segmented", "select", "switch", "seed", "image", "images", "script", "lyrics", "tags", "voice", "language", "slider", "audio", "video", "mask", "expand", "effect"

        • groupstringrequired

          one of "prompt", "inputs", "basic", "advanced"

        • orderintegerrequired
      • kind"media"required
      • acceptstringrequired

        one of "image", "audio", "video"

      Fields
      • namestringrequired

        one of "prompt", "negative_prompt", "aspect_ratio", "resolution", "duration", "num_outputs", "seed", "images", "image", "first_frame", "last_frame", "generate_audio", "upscale_factor", "mask", "expand_left", "expand_right", "expand_top", "expand_bottom", "video", "audio", "fps", "effect", "text", "voice", "language", "speed", "lyrics", "style", "instrumental", "stem", "polycount", "texture", "format", "garment", "lighting", "light_direction", "palette", "pbr", "quad", "geometry_quality", "texture_quality"

      • requiredbooleanrequired
      • uiobjectrequired
        Fields
        • controlstringrequired

          one of "prompt", "textarea", "aspect", "segmented", "select", "switch", "seed", "image", "images", "script", "lyrics", "tags", "voice", "language", "slider", "audio", "video", "mask", "expand", "effect"

        • groupstringrequired

          one of "prompt", "inputs", "basic", "advanced"

        • orderintegerrequired
      • kind"media_list"required
      • accept"image"required
      • minItemsintegerrequired

        ≥ 0

      • maxItemsintegerrequired

        > 0

    • defaultsobjectrequired
    • priceFromCoinsinteger | nullrequired

      > 0

    • inputLimitsobject
      Fields
      • maxOutputPixelsinteger

        > 0

      • maxOutputSideinteger

        > 0

      • minInputSecondsinteger

        > 0

      • maxInputSecondsinteger

        > 0

      • maxInputBytesinteger

        > 0

EffectsResponse
  • effectsarray of objectrequired
    Fields
    • idstringrequired

      pattern ^[a-z0-9][a-z0-9-]{0,63}$

    • kindstringrequired

      one of "image", "video"

    • categorystringrequired

      one of "style", "template"

    • nameKeystringrequired

      min length 1

    • thumbnailstring | nullrequired

      min length 1

    • inputobject | objectrequired
      Fields
      • type"images"required
      • minintegerrequired

        > 0

      • maxintegerrequired

        > 0

      Fields
      • type"video"required
    • modelIdstringrequired

      min length 1

PublicAccount
  • balanceobjectrequired
    Fields
    • availableintegerrequired
    • heldintegerrequired

      ≥ 0

  • concurrencyConcurrencyrequired
    Concurrency
  • rateLimitsobjectrequired
    Fields
    • keyobjectrequired
      Fields
      • limitintegerrequired

        > 0

      • windowSecondsintegerrequired

        > 0

    • accountobjectrequired
      Fields
      • limitintegerrequired

        > 0

      • windowSecondsintegerrequired

        > 0

  • keyobject | nullrequired
    Fields
    • idstring (uuid)required

      pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

    • namestringrequired
    • scopesarray of stringrequired
    • monthlySpendCapCoinsinteger | nullrequired

      > 0

    • spentThisMonthCoinsintegerrequired

      ≥ 0

    • expiresAtstring (date-time) | nullrequired
  • channelstringrequired

    one of "web", "api", "mcp"

WebhookEvent
  • idstringrequired

    min length 1

  • typestringrequired

    one of "generation.succeeded", "generation.failed", "generation.canceled"

  • createdAtstring (date-time)required
  • dataobjectrequired
    Fields
Problem
  • typestringrequired

    min length 1

  • titlestringrequired

    min length 1

  • statusintegerrequired

    ≥ 400 · ≤ 599

  • detailstringrequired
  • codestringrequired

    one of "invalid_params", "unknown_model", "invalid_quote", "price_changed", "max_coins_exceeded", "insufficient_coins", "idempotency_conflict", "idempotency_key_required", "cooldown", "account_locked", "unauthorized", "not_found", "not_cancelable", "rate_limited", "unavailable", "input_too_large", "input_duration", "input_file_too_large", "consent_required", "upload_too_large", "upload_invalid", "upload_too_long", "wrong_media", "download_too_large", "maintenance", "explore_blocked", "explore_limit", "explore_not_shareable", "explore_removed", "internal", "invalid_api_key", "api_key_revoked", "api_key_expired", "insufficient_scope", "channel_disabled", "spend_cap_exceeded"

  • instancestring
  • issuesarray of object
    Fields
    • pathstringrequired
    • messagestringrequired
QuoteRequest
  • modelIdstringrequired

    min length 1

  • paramsobjectrequired
  • draftboolean

    default false

  • effectIdstring

    pattern ^[a-z0-9][a-z0-9-]{0,63}$

CreateGenerationRequest
  • modelIdstringrequired

    min length 1

  • paramsobjectrequired
  • quoteTokenstring

    min length 1

  • maxCoinsinteger

    > 0

  • projectIdstring | null

    min length 1

  • effectIdstring

    pattern ^[a-z0-9][a-z0-9-]{0,63}$

  • consenttrue