Référence de l’API

Générée à partir du document OpenAPI 3.1 servi par l’API. Ouvrez une requête ou une réponse pour voir ses champs.

Télécharger openapi.jsonVersion 1.0.0 · OpenAPI 3.1.0

Models

What you can run and what it costs.

get`/v1/models`

· List modelsPublic, sans clé

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.

Réponses

200

The catalog.

application/jsonPublicModelsResponse

get`/v1/effects`

· List effectsPublic, sans clé

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.

Réponses

200

The effects.

application/jsonEffectsResponse

Generations

Quote, start, follow and cancel generations.

post`/v1/quotes`

· Quote a generationPermission: 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).

Corps de la requête

application/json QuoteRequest

modelIdstringobligatoire
min length 1
paramsobjectobligatoire
draftboolean
default false
effectIdstring
pattern ^[a-z0-9][a-z0-9-]{0,63}$

Réponses

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 generationsPermission: read

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

Paramètres

cursorstringrequête
nextCursor of the previous page.
limitintegerrequête
≥ 1 · ≤ 100 · default 30
statusstringrequête
one of "queued", "processing", "succeeded", "failed", "canceled"
modalitystringrequête
one of "image", "video", "audio", "3d"
workspacestringrequête
one of "image", "video", "audio", "3d", "tools"
modelIdstringrequête
activebooleanrequête
Only generations that are still queued or processing.

Réponses

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 generationPermission: 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.

Paramètres

Idempotency-Keystringen-têteobligatoire
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.

Corps de la requête

application/json CreateGenerationRequest

modelIdstringobligatoire
min length 1
paramsobjectobligatoire
quoteTokenstring
min length 1
maxCoinsinteger
> 0
projectIdstring | null
min length 1
effectIdstring
pattern ^[a-z0-9][a-z0-9-]{0,63}$
consenttrue

Réponses

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 generationPermission: 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.

Paramètres

idstring (uuid)cheminobligatoire
The generation id.

Réponses

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 generationPermission: generate

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

Paramètres

idstring (uuid)cheminobligatoire
The generation id.

Réponses

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 filePermission: 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.

Corps de la requête

multipart/form-data object

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

Réponses

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 filePermission: read

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

Paramètres

idstring (uuid)cheminobligatoire
The asset id.

Réponses

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 limitPermission: read

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

Réponses

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 limitsPermission: account

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

Réponses

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

Événements de webhook

Les requêtes qu’inker envoie à vos 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

idstringobligatoire
min length 1
typestringobligatoire
one of "generation.succeeded", "generation.failed", "generation.canceled"
createdAtstring (date-time)obligatoire
dataobjectobligatoire
Champs
- generationGenerationobligatoire
  Generation

POST generation.failed

application/json

idstringobligatoire
min length 1
typestringobligatoire
one of "generation.succeeded", "generation.failed", "generation.canceled"
createdAtstring (date-time)obligatoire
dataobjectobligatoire
Champs
- generationGenerationobligatoire
  Generation

POST generation.canceled

application/json

idstringobligatoire
min length 1
typestringobligatoire
one of "generation.succeeded", "generation.failed", "generation.canceled"
createdAtstring (date-time)obligatoire
dataobjectobligatoire
Champs
- generationGenerationobligatoire
  Generation

Schémas

Les objets acceptés et renvoyés par les endpoints, chacun documenté une seule fois.

Asset

idstringobligatoire
min length 1 · max length 128 · pattern ^[A-Za-z0-9_-]+$
kindstringobligatoire
one of "image", "video", "audio", "3d", "text"
urlstringobligatoire
min length 1
thumbnailUrlstringobligatoire
min length 1
posterUrlstring | nullobligatoire
min length 1
mimeTypestringobligatoire
min length 1
widthinteger | nullobligatoire
> 0
heightinteger | nullobligatoire
> 0
durationSecondsnumber | nullobligatoire
> 0
waveformUrlstring | null
min length 1
transparentboolean
downloadsarray of object
Champs
- formatstringobligatoire
  one of "obj", "fbx", "usdz", "stl"
- urlstringobligatoire
  min length 1
- bytesintegerobligatoire
  > 0
stemstring | null
one of "vocals", "drums", "bass", "other"
subtitlesobject | null
Champs
- srtUrlstringobligatoire
  min length 1
- vttUrlstringobligatoire
  min length 1

Generation

idstringobligatoire
min length 1
modelIdstringobligatoire
min length 1
modelNamestringobligatoire
min length 1
taskTypestringobligatoire
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"
modalitystringobligatoire
one of "image", "video", "audio", "3d"
workspacestringobligatoire
one of "image", "video", "audio", "3d", "tools"
effectobject | nullobligatoire
Champs
- idstringobligatoire
  min length 1
- textstring | nullobligatoire
statusstringobligatoire
one of "queued", "processing", "succeeded", "failed", "canceled"
progressnumber | nullobligatoire
≥ 0 · ≤ 1
queuePositioninteger | nullobligatoire
> 0
paramsobjectobligatoire
coinsQuotedintegerobligatoire
> 0
coinsChargedinteger | nullobligatoire
≥ 0
outputsarray of Assetobligatoire
Asset
outputsRequestedintegerobligatoire
> 0
errorobject | nullobligatoire
Champs
- codestringobligatoire
  one of "content_policy", "invalid_input", "unavailable", "timeout", "internal"
projectIdstring | nullobligatoire
min length 1
createdAtstring (date-time)obligatoire
startedAtstring (date-time) | nullobligatoire
completedAtstring (date-time) | nullobligatoire

GenerationPage

itemsarray of Generationobligatoire
Generation
nextCursorstring | nullobligatoire
min length 1

QuoteResponse

modelIdstringobligatoire
min length 1
coinsintegerobligatoire
> 0
coinsPerOutputintegerobligatoire
> 0
outputsintegerobligatoire
> 0
quoteTokenstring | nullobligatoire
min length 1
expiresAtstring (date-time)obligatoire
availableCoinsintegerobligatoire
≥ 0

Concurrency

limitintegerobligatoire
> 0
raisedLimitinteger | nullobligatoire
> 0
runningintegerobligatoire
≥ 0
queuedintegerobligatoire
≥ 0

PublicModelsResponse

modelsarray of objectobligatoire
Champs
- idstringobligatoire
  min length 1
- listingIdstringobligatoire
  min length 1
- taskTypestringobligatoire
  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"
- modalitystringobligatoire
  one of "image", "video", "audio", "3d"
- workspacestringobligatoire
  one of "image", "video", "audio", "3d", "tools"
- vendorstringobligatoire
  min length 1
- displayNamestringobligatoire
  min length 1
- paramsarray of object | object | object | object | object | objectobligatoire
  Champs
  - namestringobligatoire
    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"
  - requiredbooleanobligatoire
  - uiobjectobligatoire
    Champs
    controlstringobligatoire
    one of "prompt", "textarea", "aspect", "segmented", "select", "switch", "seed", "image", "images", "script", "lyrics", "tags", "voice", "language", "slider", "audio", "video", "mask", "expand", "effect"
    groupstringobligatoire
    one of "prompt", "inputs", "basic", "advanced"
    orderintegerobligatoire
  - kind"text"obligatoire
  - maxLengthintegerobligatoire
    > 0
  - minLengthinteger
    > 0
  Champs
  - namestringobligatoire
    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"
  - requiredbooleanobligatoire
  - uiobjectobligatoire
    Champs
    controlstringobligatoire
    one of "prompt", "textarea", "aspect", "segmented", "select", "switch", "seed", "image", "images", "script", "lyrics", "tags", "voice", "language", "slider", "audio", "video", "mask", "expand", "effect"
    groupstringobligatoire
    one of "prompt", "inputs", "basic", "advanced"
    orderintegerobligatoire
  - kind"enum"obligatoire
  - valuesarray of string | number | booleanobligatoire
    min items 1
  Champs
  - namestringobligatoire
    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"
  - requiredbooleanobligatoire
  - uiobjectobligatoire
    Champs
    controlstringobligatoire
    one of "prompt", "textarea", "aspect", "segmented", "select", "switch", "seed", "image", "images", "script", "lyrics", "tags", "voice", "language", "slider", "audio", "video", "mask", "expand", "effect"
    groupstringobligatoire
    one of "prompt", "inputs", "basic", "advanced"
    orderintegerobligatoire
  - kind"range"obligatoire
  - minnumberobligatoire
  - maxnumberobligatoire
  - stepnumberobligatoire
    > 0
  Champs
  - namestringobligatoire
    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"
  - requiredbooleanobligatoire
  - uiobjectobligatoire
    Champs
    controlstringobligatoire
    one of "prompt", "textarea", "aspect", "segmented", "select", "switch", "seed", "image", "images", "script", "lyrics", "tags", "voice", "language", "slider", "audio", "video", "mask", "expand", "effect"
    groupstringobligatoire
    one of "prompt", "inputs", "basic", "advanced"
    orderintegerobligatoire
  - kind"seed"obligatoire
  - maxintegerobligatoire
    > 0
  Champs
  - namestringobligatoire
    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"
  - requiredbooleanobligatoire
  - uiobjectobligatoire
    Champs
    controlstringobligatoire
    one of "prompt", "textarea", "aspect", "segmented", "select", "switch", "seed", "image", "images", "script", "lyrics", "tags", "voice", "language", "slider", "audio", "video", "mask", "expand", "effect"
    groupstringobligatoire
    one of "prompt", "inputs", "basic", "advanced"
    orderintegerobligatoire
  - kind"media"obligatoire
  - acceptstringobligatoire
    one of "image", "audio", "video"
  Champs
  - namestringobligatoire
    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"
  - requiredbooleanobligatoire
  - uiobjectobligatoire
    Champs
    controlstringobligatoire
    one of "prompt", "textarea", "aspect", "segmented", "select", "switch", "seed", "image", "images", "script", "lyrics", "tags", "voice", "language", "slider", "audio", "video", "mask", "expand", "effect"
    groupstringobligatoire
    one of "prompt", "inputs", "basic", "advanced"
    orderintegerobligatoire
  - kind"media_list"obligatoire
  - accept"image"obligatoire
  - minItemsintegerobligatoire
    ≥ 0
  - maxItemsintegerobligatoire
    > 0
- defaultsobjectobligatoire
- priceFromCoinsinteger | nullobligatoire
  > 0
- inputLimitsobject
  Champs
  - maxOutputPixelsinteger
    > 0
  - maxOutputSideinteger
    > 0
  - minInputSecondsinteger
    > 0
  - maxInputSecondsinteger
    > 0
  - maxInputBytesinteger
    > 0

EffectsResponse

effectsarray of objectobligatoire
Champs
- idstringobligatoire
  pattern ^[a-z0-9][a-z0-9-]{0,63}$
- kindstringobligatoire
  one of "image", "video"
- categorystringobligatoire
  one of "style", "template"
- nameKeystringobligatoire
  min length 1
- thumbnailstring | nullobligatoire
  min length 1
- inputobject | objectobligatoire
  Champs
  - type"images"obligatoire
  - minintegerobligatoire
    > 0
  - maxintegerobligatoire
    > 0
  Champs
  - type"video"obligatoire
- modelIdstringobligatoire
  min length 1

PublicAccount

balanceobjectobligatoire
Champs
- availableintegerobligatoire
- heldintegerobligatoire
  ≥ 0
concurrencyConcurrencyobligatoire
Concurrency
rateLimitsobjectobligatoire
Champs
- keyobjectobligatoire
  Champs
  - limitintegerobligatoire
    > 0
  - windowSecondsintegerobligatoire
    > 0
- accountobjectobligatoire
  Champs
  - limitintegerobligatoire
    > 0
  - windowSecondsintegerobligatoire
    > 0
keyobject | nullobligatoire
Champs
- idstring (uuid)obligatoire
  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)$
- namestringobligatoire
- scopesarray of stringobligatoire
- monthlySpendCapCoinsinteger | nullobligatoire
  > 0
- spentThisMonthCoinsintegerobligatoire
  ≥ 0
- expiresAtstring (date-time) | nullobligatoire
channelstringobligatoire
one of "web", "api", "mcp"

WebhookEvent

idstringobligatoire
min length 1
typestringobligatoire
one of "generation.succeeded", "generation.failed", "generation.canceled"
createdAtstring (date-time)obligatoire
dataobjectobligatoire
Champs
- generationGenerationobligatoire
  Generation

Problem

typestringobligatoire
min length 1
titlestringobligatoire
min length 1
statusintegerobligatoire
≥ 400 · ≤ 599
detailstringobligatoire
codestringobligatoire
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
Champs
- pathstringobligatoire
- messagestringobligatoire

QuoteRequest

modelIdstringobligatoire
min length 1
paramsobjectobligatoire
draftboolean
default false
effectIdstring
pattern ^[a-z0-9][a-z0-9-]{0,63}$

CreateGenerationRequest

modelIdstringobligatoire
min length 1
paramsobjectobligatoire
quoteTokenstring
min length 1
maxCoinsinteger
> 0
projectIdstring | null
min length 1
effectIdstring
pattern ^[a-z0-9][a-z0-9-]{0,63}$
consenttrue

Models

get/v1/models

Réponses

get/v1/effects

Réponses

Generations

post/v1/quotes

Corps de la requête

Réponses

get/v1/generations

Paramètres

Réponses

post/v1/generations

Paramètres

Corps de la requête

Réponses

get/v1/generations/{id}

Paramètres

Réponses

post/v1/generations/{id}/cancel

Paramètres

Réponses

Files

post/v1/uploads

Corps de la requête

Réponses

get/v1/assets/{id}

Paramètres

Réponses

Account

get/v1/generations/concurrency

Réponses

get/v1/account

Réponses

Événements de webhook

POST generation.succeeded

POST generation.failed

POST generation.canceled

Schémas

get`/v1/models`

get`/v1/effects`

post`/v1/quotes`

get`/v1/generations`

post`/v1/generations`

get`/v1/generations/{id}`

post`/v1/generations/{id}/cancel`

post`/v1/uploads`

get`/v1/assets/{id}`

get`/v1/generations/concurrency`

get`/v1/account`