مرجع واجهة البرمجة

مُولَّد من مستند OpenAPI 3.1 الذي تقدّمه واجهة البرمجة. افتح طلبًا أو استجابة لترى حقولها.

تنزيل openapi.jsonالإصدار 1.0.0 · OpenAPI 3.1.0

Models

What you can run and what it costs.

get`/v1/models`

· List modelsعامة، بلا مفتاح

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.

الاستجابات

200

The catalog.

application/jsonPublicModelsResponse

get`/v1/effects`

· List effectsعامة، بلا مفتاح

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.

الاستجابات

200

The effects.

application/jsonEffectsResponse

Generations

Quote, start, follow and cancel generations.

post`/v1/quotes`

· Quote a generationالصلاحية: 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).

متن الطلب

application/json QuoteRequest

modelIdstringإلزامي
min length 1
paramsobjectإلزامي
draftboolean
default false
effectIdstring
pattern ^[a-z0-9][a-z0-9-]{0,63}$

الاستجابات

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 generationsالصلاحية: read

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

المعاملات

cursorstringالاستعلام
nextCursor of the previous page.
limitintegerالاستعلام
≥ 1 · ≤ 100 · default 30
statusstringالاستعلام
one of "queued", "processing", "succeeded", "failed", "canceled"
modalitystringالاستعلام
one of "image", "video", "audio", "3d"
workspacestringالاستعلام
one of "image", "video", "audio", "3d", "tools"
modelIdstringالاستعلام
activebooleanالاستعلام
Only generations that are still queued or processing.

الاستجابات

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 generationالصلاحية: 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.

المعاملات

Idempotency-Keystringالترويسةإلزامي
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.

متن الطلب

application/json CreateGenerationRequest

modelIdstringإلزامي
min length 1
paramsobjectإلزامي
quoteTokenstring
min length 1
maxCoinsinteger
> 0
projectIdstring | null
min length 1
effectIdstring
pattern ^[a-z0-9][a-z0-9-]{0,63}$
consenttrue

الاستجابات

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 generationالصلاحية: 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.

المعاملات

idstring (uuid)المسارإلزامي
The generation id.

الاستجابات

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 generationالصلاحية: generate

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

المعاملات

idstring (uuid)المسارإلزامي
The generation id.

الاستجابات

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 fileالصلاحية: 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.

متن الطلب

multipart/form-data object

filestringإلزامي
One of image/png, image/jpeg, image/webp, audio/mpeg, audio/wav, audio/mp4, audio/ogg, video/mp4, video/webm, video/quicktime.

الاستجابات

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 fileالصلاحية: read

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

المعاملات

idstring (uuid)المسارإلزامي
The asset id.

الاستجابات

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 limitالصلاحية: read

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

الاستجابات

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 limitsالصلاحية: account

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

الاستجابات

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

أحداث خطافات الويب

الطلبات التي يرسلها inker إلى نقاط الاستقبال الخاصة بك.

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

idstringإلزامي
min length 1
typestringإلزامي
one of "generation.succeeded", "generation.failed", "generation.canceled"
createdAtstring (date-time)إلزامي
dataobjectإلزامي
الحقول
- generationGenerationإلزامي
  Generation

POST generation.failed

application/json

idstringإلزامي
min length 1
typestringإلزامي
one of "generation.succeeded", "generation.failed", "generation.canceled"
createdAtstring (date-time)إلزامي
dataobjectإلزامي
الحقول
- generationGenerationإلزامي
  Generation

POST generation.canceled

application/json

idstringإلزامي
min length 1
typestringإلزامي
one of "generation.succeeded", "generation.failed", "generation.canceled"
createdAtstring (date-time)إلزامي
dataobjectإلزامي
الحقول
- generationGenerationإلزامي
  Generation

المخططات

الكائنات التي تقبلها نقاط النهاية وتعيدها، موثّق كلٌّ منها مرة واحدة.

Asset

idstringإلزامي
min length 1 · max length 128 · pattern ^[A-Za-z0-9_-]+$
kindstringإلزامي
one of "image", "video", "audio", "3d", "text"
urlstringإلزامي
min length 1
thumbnailUrlstringإلزامي
min length 1
posterUrlstring | nullإلزامي
min length 1
mimeTypestringإلزامي
min length 1
widthinteger | nullإلزامي
> 0
heightinteger | nullإلزامي
> 0
durationSecondsnumber | nullإلزامي
> 0
waveformUrlstring | null
min length 1
transparentboolean
downloadsarray of object
الحقول
- formatstringإلزامي
  one of "obj", "fbx", "usdz", "stl"
- urlstringإلزامي
  min length 1
- bytesintegerإلزامي
  > 0
stemstring | null
one of "vocals", "drums", "bass", "other"
subtitlesobject | null
الحقول
- srtUrlstringإلزامي
  min length 1
- vttUrlstringإلزامي
  min length 1

Generation

idstringإلزامي
min length 1
modelIdstringإلزامي
min length 1
modelNamestringإلزامي
min length 1
taskTypestringإلزامي
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"
modalitystringإلزامي
one of "image", "video", "audio", "3d"
workspacestringإلزامي
one of "image", "video", "audio", "3d", "tools"
effectobject | nullإلزامي
الحقول
- idstringإلزامي
  min length 1
- textstring | nullإلزامي
statusstringإلزامي
one of "queued", "processing", "succeeded", "failed", "canceled"
progressnumber | nullإلزامي
≥ 0 · ≤ 1
queuePositioninteger | nullإلزامي
> 0
paramsobjectإلزامي
coinsQuotedintegerإلزامي
> 0
coinsChargedinteger | nullإلزامي
≥ 0
outputsarray of Assetإلزامي
Asset
outputsRequestedintegerإلزامي
> 0
errorobject | nullإلزامي
الحقول
- codestringإلزامي
  one of "content_policy", "invalid_input", "unavailable", "timeout", "internal"
projectIdstring | nullإلزامي
min length 1
createdAtstring (date-time)إلزامي
startedAtstring (date-time) | nullإلزامي
completedAtstring (date-time) | nullإلزامي

GenerationPage

itemsarray of Generationإلزامي
Generation
nextCursorstring | nullإلزامي
min length 1

QuoteResponse

modelIdstringإلزامي
min length 1
coinsintegerإلزامي
> 0
coinsPerOutputintegerإلزامي
> 0
outputsintegerإلزامي
> 0
quoteTokenstring | nullإلزامي
min length 1
expiresAtstring (date-time)إلزامي
availableCoinsintegerإلزامي
≥ 0

Concurrency

limitintegerإلزامي
> 0
raisedLimitinteger | nullإلزامي
> 0
runningintegerإلزامي
≥ 0
queuedintegerإلزامي
≥ 0

PublicModelsResponse

modelsarray of objectإلزامي
الحقول
- idstringإلزامي
  min length 1
- listingIdstringإلزامي
  min length 1
- taskTypestringإلزامي
  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"
- modalitystringإلزامي
  one of "image", "video", "audio", "3d"
- workspacestringإلزامي
  one of "image", "video", "audio", "3d", "tools"
- vendorstringإلزامي
  min length 1
- displayNamestringإلزامي
  min length 1
- paramsarray of object | object | object | object | object | objectإلزامي
  الحقول
  - namestringإلزامي
    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"
  - requiredbooleanإلزامي
  - uiobjectإلزامي
    الحقول
    controlstringإلزامي
    one of "prompt", "textarea", "aspect", "segmented", "select", "switch", "seed", "image", "images", "script", "lyrics", "tags", "voice", "language", "slider", "audio", "video", "mask", "expand", "effect"
    groupstringإلزامي
    one of "prompt", "inputs", "basic", "advanced"
    orderintegerإلزامي
  - kind"text"إلزامي
  - maxLengthintegerإلزامي
    > 0
  - minLengthinteger
    > 0
  الحقول
  - namestringإلزامي
    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"
  - requiredbooleanإلزامي
  - uiobjectإلزامي
    الحقول
    controlstringإلزامي
    one of "prompt", "textarea", "aspect", "segmented", "select", "switch", "seed", "image", "images", "script", "lyrics", "tags", "voice", "language", "slider", "audio", "video", "mask", "expand", "effect"
    groupstringإلزامي
    one of "prompt", "inputs", "basic", "advanced"
    orderintegerإلزامي
  - kind"enum"إلزامي
  - valuesarray of string | number | booleanإلزامي
    min items 1
  الحقول
  - namestringإلزامي
    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"
  - requiredbooleanإلزامي
  - uiobjectإلزامي
    الحقول
    controlstringإلزامي
    one of "prompt", "textarea", "aspect", "segmented", "select", "switch", "seed", "image", "images", "script", "lyrics", "tags", "voice", "language", "slider", "audio", "video", "mask", "expand", "effect"
    groupstringإلزامي
    one of "prompt", "inputs", "basic", "advanced"
    orderintegerإلزامي
  - kind"range"إلزامي
  - minnumberإلزامي
  - maxnumberإلزامي
  - stepnumberإلزامي
    > 0
  الحقول
  - namestringإلزامي
    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"
  - requiredbooleanإلزامي
  - uiobjectإلزامي
    الحقول
    controlstringإلزامي
    one of "prompt", "textarea", "aspect", "segmented", "select", "switch", "seed", "image", "images", "script", "lyrics", "tags", "voice", "language", "slider", "audio", "video", "mask", "expand", "effect"
    groupstringإلزامي
    one of "prompt", "inputs", "basic", "advanced"
    orderintegerإلزامي
  - kind"seed"إلزامي
  - maxintegerإلزامي
    > 0
  الحقول
  - namestringإلزامي
    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"
  - requiredbooleanإلزامي
  - uiobjectإلزامي
    الحقول
    controlstringإلزامي
    one of "prompt", "textarea", "aspect", "segmented", "select", "switch", "seed", "image", "images", "script", "lyrics", "tags", "voice", "language", "slider", "audio", "video", "mask", "expand", "effect"
    groupstringإلزامي
    one of "prompt", "inputs", "basic", "advanced"
    orderintegerإلزامي
  - kind"media"إلزامي
  - acceptstringإلزامي
    one of "image", "audio", "video"
  الحقول
  - namestringإلزامي
    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"
  - requiredbooleanإلزامي
  - uiobjectإلزامي
    الحقول
    controlstringإلزامي
    one of "prompt", "textarea", "aspect", "segmented", "select", "switch", "seed", "image", "images", "script", "lyrics", "tags", "voice", "language", "slider", "audio", "video", "mask", "expand", "effect"
    groupstringإلزامي
    one of "prompt", "inputs", "basic", "advanced"
    orderintegerإلزامي
  - kind"media_list"إلزامي
  - accept"image"إلزامي
  - minItemsintegerإلزامي
    ≥ 0
  - maxItemsintegerإلزامي
    > 0
- defaultsobjectإلزامي
- priceFromCoinsinteger | nullإلزامي
  > 0
- inputLimitsobject
  الحقول
  - maxOutputPixelsinteger
    > 0
  - maxOutputSideinteger
    > 0
  - minInputSecondsinteger
    > 0
  - maxInputSecondsinteger
    > 0
  - maxInputBytesinteger
    > 0

EffectsResponse

effectsarray of objectإلزامي
الحقول
- idstringإلزامي
  pattern ^[a-z0-9][a-z0-9-]{0,63}$
- kindstringإلزامي
  one of "image", "video"
- categorystringإلزامي
  one of "style", "template"
- nameKeystringإلزامي
  min length 1
- thumbnailstring | nullإلزامي
  min length 1
- inputobject | objectإلزامي
  الحقول
  - type"images"إلزامي
  - minintegerإلزامي
    > 0
  - maxintegerإلزامي
    > 0
  الحقول
  - type"video"إلزامي
- modelIdstringإلزامي
  min length 1

PublicAccount

balanceobjectإلزامي
الحقول
- availableintegerإلزامي
- heldintegerإلزامي
  ≥ 0
concurrencyConcurrencyإلزامي
Concurrency
rateLimitsobjectإلزامي
الحقول
- keyobjectإلزامي
  الحقول
  - limitintegerإلزامي
    > 0
  - windowSecondsintegerإلزامي
    > 0
- accountobjectإلزامي
  الحقول
  - limitintegerإلزامي
    > 0
  - windowSecondsintegerإلزامي
    > 0
keyobject | nullإلزامي
الحقول
- idstring (uuid)إلزامي
  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)$
- namestringإلزامي
- scopesarray of stringإلزامي
- monthlySpendCapCoinsinteger | nullإلزامي
  > 0
- spentThisMonthCoinsintegerإلزامي
  ≥ 0
- expiresAtstring (date-time) | nullإلزامي
channelstringإلزامي
one of "web", "api", "mcp"

WebhookEvent

idstringإلزامي
min length 1
typestringإلزامي
one of "generation.succeeded", "generation.failed", "generation.canceled"
createdAtstring (date-time)إلزامي
dataobjectإلزامي
الحقول
- generationGenerationإلزامي
  Generation

Problem

typestringإلزامي
min length 1
titlestringإلزامي
min length 1
statusintegerإلزامي
≥ 400 · ≤ 599
detailstringإلزامي
codestringإلزامي
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
الحقول
- pathstringإلزامي
- messagestringإلزامي

QuoteRequest

modelIdstringإلزامي
min length 1
paramsobjectإلزامي
draftboolean
default false
effectIdstring
pattern ^[a-z0-9][a-z0-9-]{0,63}$

CreateGenerationRequest

modelIdstringإلزامي
min length 1
paramsobjectإلزامي
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

الاستجابات

get/v1/effects

الاستجابات

Generations

post/v1/quotes

متن الطلب

الاستجابات

get/v1/generations

المعاملات

الاستجابات

post/v1/generations

المعاملات

متن الطلب

الاستجابات

get/v1/generations/{id}

المعاملات

الاستجابات

post/v1/generations/{id}/cancel

المعاملات

الاستجابات

Files

post/v1/uploads

متن الطلب

الاستجابات

get/v1/assets/{id}

المعاملات

الاستجابات

Account

get/v1/generations/concurrency

الاستجابات

get/v1/account

الاستجابات

أحداث خطافات الويب

POST generation.succeeded

POST generation.failed

POST generation.canceled

المخططات

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`