Referencia de la API

Generada a partir del documento OpenAPI 3.1 que sirve la API. Abre una solicitud o respuesta para ver sus campos.

Descargar openapi.jsonVersión 1.0.0 · OpenAPI 3.1.0

Models

What you can run and what it costs.

get`/v1/models`

· List modelsPúblico, sin clave

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.

Respuestas

200

The catalog.

application/jsonPublicModelsResponse

get`/v1/effects`

· List effectsPúblico, sin clave

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.

Respuestas

200

The effects.

application/jsonEffectsResponse

Generations

Quote, start, follow and cancel generations.

post`/v1/quotes`

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

Cuerpo de la solicitud

application/json QuoteRequest

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

Respuestas

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

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

Parámetros

cursorstringconsulta
nextCursor of the previous page.
limitintegerconsulta
≥ 1 · ≤ 100 · default 30
statusstringconsulta
one of "queued", "processing", "succeeded", "failed", "canceled"
modalitystringconsulta
one of "image", "video", "audio", "3d"
workspacestringconsulta
one of "image", "video", "audio", "3d", "tools"
modelIdstringconsulta
activebooleanconsulta
Only generations that are still queued or processing.

Respuestas

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

Parámetros

Idempotency-Keystringcabeceraobligatorio
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.

Cuerpo de la solicitud

application/json CreateGenerationRequest

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

Respuestas

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

Parámetros

idstring (uuid)rutaobligatorio
The generation id.

Respuestas

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

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

Parámetros

idstring (uuid)rutaobligatorio
The generation id.

Respuestas

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

Cuerpo de la solicitud

multipart/form-data object

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

Respuestas

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

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

Parámetros

idstring (uuid)rutaobligatorio
The asset id.

Respuestas

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

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

Respuestas

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

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

Respuestas

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

Eventos de webhook

Solicitudes que inker envía a tus 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

idstringobligatorio
min length 1
typestringobligatorio
one of "generation.succeeded", "generation.failed", "generation.canceled"
createdAtstring (date-time)obligatorio
dataobjectobligatorio
Campos
- generationGenerationobligatorio
  Generation

POST generation.failed

application/json

idstringobligatorio
min length 1
typestringobligatorio
one of "generation.succeeded", "generation.failed", "generation.canceled"
createdAtstring (date-time)obligatorio
dataobjectobligatorio
Campos
- generationGenerationobligatorio
  Generation

POST generation.canceled

application/json

idstringobligatorio
min length 1
typestringobligatorio
one of "generation.succeeded", "generation.failed", "generation.canceled"
createdAtstring (date-time)obligatorio
dataobjectobligatorio
Campos
- generationGenerationobligatorio
  Generation

Esquemas

Los objetos que aceptan y devuelven los endpoints, documentados una sola vez.

Asset

idstringobligatorio
min length 1 · max length 128 · pattern ^[A-Za-z0-9_-]+$
kindstringobligatorio
one of "image", "video", "audio", "3d", "text"
urlstringobligatorio
min length 1
thumbnailUrlstringobligatorio
min length 1
posterUrlstring | nullobligatorio
min length 1
mimeTypestringobligatorio
min length 1
widthinteger | nullobligatorio
> 0
heightinteger | nullobligatorio
> 0
durationSecondsnumber | nullobligatorio
> 0
waveformUrlstring | null
min length 1
transparentboolean
downloadsarray of object
Campos
- formatstringobligatorio
  one of "obj", "fbx", "usdz", "stl"
- urlstringobligatorio
  min length 1
- bytesintegerobligatorio
  > 0
stemstring | null
one of "vocals", "drums", "bass", "other"
subtitlesobject | null
Campos
- srtUrlstringobligatorio
  min length 1
- vttUrlstringobligatorio
  min length 1

Generation

idstringobligatorio
min length 1
modelIdstringobligatorio
min length 1
modelNamestringobligatorio
min length 1
taskTypestringobligatorio
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"
modalitystringobligatorio
one of "image", "video", "audio", "3d"
workspacestringobligatorio
one of "image", "video", "audio", "3d", "tools"
effectobject | nullobligatorio
Campos
- idstringobligatorio
  min length 1
- textstring | nullobligatorio
statusstringobligatorio
one of "queued", "processing", "succeeded", "failed", "canceled"
progressnumber | nullobligatorio
≥ 0 · ≤ 1
queuePositioninteger | nullobligatorio
> 0
paramsobjectobligatorio
coinsQuotedintegerobligatorio
> 0
coinsChargedinteger | nullobligatorio
≥ 0
outputsarray of Assetobligatorio
Asset
outputsRequestedintegerobligatorio
> 0
errorobject | nullobligatorio
Campos
- codestringobligatorio
  one of "content_policy", "invalid_input", "unavailable", "timeout", "internal"
projectIdstring | nullobligatorio
min length 1
createdAtstring (date-time)obligatorio
startedAtstring (date-time) | nullobligatorio
completedAtstring (date-time) | nullobligatorio

GenerationPage

itemsarray of Generationobligatorio
Generation
nextCursorstring | nullobligatorio
min length 1

QuoteResponse

modelIdstringobligatorio
min length 1
coinsintegerobligatorio
> 0
coinsPerOutputintegerobligatorio
> 0
outputsintegerobligatorio
> 0
quoteTokenstring | nullobligatorio
min length 1
expiresAtstring (date-time)obligatorio
availableCoinsintegerobligatorio
≥ 0

Concurrency

limitintegerobligatorio
> 0
raisedLimitinteger | nullobligatorio
> 0
runningintegerobligatorio
≥ 0
queuedintegerobligatorio
≥ 0

PublicModelsResponse

modelsarray of objectobligatorio
Campos
- idstringobligatorio
  min length 1
- listingIdstringobligatorio
  min length 1
- taskTypestringobligatorio
  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"
- modalitystringobligatorio
  one of "image", "video", "audio", "3d"
- workspacestringobligatorio
  one of "image", "video", "audio", "3d", "tools"
- vendorstringobligatorio
  min length 1
- displayNamestringobligatorio
  min length 1
- paramsarray of object | object | object | object | object | objectobligatorio
  Campos
  - namestringobligatorio
    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"
  - requiredbooleanobligatorio
  - uiobjectobligatorio
    Campos
    controlstringobligatorio
    one of "prompt", "textarea", "aspect", "segmented", "select", "switch", "seed", "image", "images", "script", "lyrics", "tags", "voice", "language", "slider", "audio", "video", "mask", "expand", "effect"
    groupstringobligatorio
    one of "prompt", "inputs", "basic", "advanced"
    orderintegerobligatorio
  - kind"text"obligatorio
  - maxLengthintegerobligatorio
    > 0
  - minLengthinteger
    > 0
  Campos
  - namestringobligatorio
    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"
  - requiredbooleanobligatorio
  - uiobjectobligatorio
    Campos
    controlstringobligatorio
    one of "prompt", "textarea", "aspect", "segmented", "select", "switch", "seed", "image", "images", "script", "lyrics", "tags", "voice", "language", "slider", "audio", "video", "mask", "expand", "effect"
    groupstringobligatorio
    one of "prompt", "inputs", "basic", "advanced"
    orderintegerobligatorio
  - kind"enum"obligatorio
  - valuesarray of string | number | booleanobligatorio
    min items 1
  Campos
  - namestringobligatorio
    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"
  - requiredbooleanobligatorio
  - uiobjectobligatorio
    Campos
    controlstringobligatorio
    one of "prompt", "textarea", "aspect", "segmented", "select", "switch", "seed", "image", "images", "script", "lyrics", "tags", "voice", "language", "slider", "audio", "video", "mask", "expand", "effect"
    groupstringobligatorio
    one of "prompt", "inputs", "basic", "advanced"
    orderintegerobligatorio
  - kind"range"obligatorio
  - minnumberobligatorio
  - maxnumberobligatorio
  - stepnumberobligatorio
    > 0
  Campos
  - namestringobligatorio
    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"
  - requiredbooleanobligatorio
  - uiobjectobligatorio
    Campos
    controlstringobligatorio
    one of "prompt", "textarea", "aspect", "segmented", "select", "switch", "seed", "image", "images", "script", "lyrics", "tags", "voice", "language", "slider", "audio", "video", "mask", "expand", "effect"
    groupstringobligatorio
    one of "prompt", "inputs", "basic", "advanced"
    orderintegerobligatorio
  - kind"seed"obligatorio
  - maxintegerobligatorio
    > 0
  Campos
  - namestringobligatorio
    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"
  - requiredbooleanobligatorio
  - uiobjectobligatorio
    Campos
    controlstringobligatorio
    one of "prompt", "textarea", "aspect", "segmented", "select", "switch", "seed", "image", "images", "script", "lyrics", "tags", "voice", "language", "slider", "audio", "video", "mask", "expand", "effect"
    groupstringobligatorio
    one of "prompt", "inputs", "basic", "advanced"
    orderintegerobligatorio
  - kind"media"obligatorio
  - acceptstringobligatorio
    one of "image", "audio", "video"
  Campos
  - namestringobligatorio
    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"
  - requiredbooleanobligatorio
  - uiobjectobligatorio
    Campos
    controlstringobligatorio
    one of "prompt", "textarea", "aspect", "segmented", "select", "switch", "seed", "image", "images", "script", "lyrics", "tags", "voice", "language", "slider", "audio", "video", "mask", "expand", "effect"
    groupstringobligatorio
    one of "prompt", "inputs", "basic", "advanced"
    orderintegerobligatorio
  - kind"media_list"obligatorio
  - accept"image"obligatorio
  - minItemsintegerobligatorio
    ≥ 0
  - maxItemsintegerobligatorio
    > 0
- defaultsobjectobligatorio
- priceFromCoinsinteger | nullobligatorio
  > 0
- inputLimitsobject
  Campos
  - maxOutputPixelsinteger
    > 0
  - maxOutputSideinteger
    > 0
  - minInputSecondsinteger
    > 0
  - maxInputSecondsinteger
    > 0
  - maxInputBytesinteger
    > 0

EffectsResponse

effectsarray of objectobligatorio
Campos
- idstringobligatorio
  pattern ^[a-z0-9][a-z0-9-]{0,63}$
- kindstringobligatorio
  one of "image", "video"
- categorystringobligatorio
  one of "style", "template"
- nameKeystringobligatorio
  min length 1
- thumbnailstring | nullobligatorio
  min length 1
- inputobject | objectobligatorio
  Campos
  - type"images"obligatorio
  - minintegerobligatorio
    > 0
  - maxintegerobligatorio
    > 0
  Campos
  - type"video"obligatorio
- modelIdstringobligatorio
  min length 1

PublicAccount

balanceobjectobligatorio
Campos
- availableintegerobligatorio
- heldintegerobligatorio
  ≥ 0
concurrencyConcurrencyobligatorio
Concurrency
rateLimitsobjectobligatorio
Campos
- keyobjectobligatorio
  Campos
  - limitintegerobligatorio
    > 0
  - windowSecondsintegerobligatorio
    > 0
- accountobjectobligatorio
  Campos
  - limitintegerobligatorio
    > 0
  - windowSecondsintegerobligatorio
    > 0
keyobject | nullobligatorio
Campos
- idstring (uuid)obligatorio
  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)$
- namestringobligatorio
- scopesarray of stringobligatorio
- monthlySpendCapCoinsinteger | nullobligatorio
  > 0
- spentThisMonthCoinsintegerobligatorio
  ≥ 0
- expiresAtstring (date-time) | nullobligatorio
channelstringobligatorio
one of "web", "api", "mcp"

WebhookEvent

idstringobligatorio
min length 1
typestringobligatorio
one of "generation.succeeded", "generation.failed", "generation.canceled"
createdAtstring (date-time)obligatorio
dataobjectobligatorio
Campos
- generationGenerationobligatorio
  Generation

Problem

typestringobligatorio
min length 1
titlestringobligatorio
min length 1
statusintegerobligatorio
≥ 400 · ≤ 599
detailstringobligatorio
codestringobligatorio
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
Campos
- pathstringobligatorio
- messagestringobligatorio

QuoteRequest

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

CreateGenerationRequest

modelIdstringobligatorio
min length 1
paramsobjectobligatorio
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

Respuestas

get/v1/effects

Respuestas

Generations

post/v1/quotes

Cuerpo de la solicitud

Respuestas

get/v1/generations

Parámetros

Respuestas

post/v1/generations

Parámetros

Cuerpo de la solicitud

Respuestas

get/v1/generations/{id}

Parámetros

Respuestas

post/v1/generations/{id}/cancel

Parámetros

Respuestas

Files

post/v1/uploads

Cuerpo de la solicitud

Respuestas

get/v1/assets/{id}

Parámetros

Respuestas

Account

get/v1/generations/concurrency

Respuestas

get/v1/account

Respuestas

Eventos de webhook

POST generation.succeeded

POST generation.failed

POST generation.canceled

Esquemas

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`