Nneorun
В студию
ДокументацияСправочник API
Разделы

API / 10

Справочник API

The read surface of the NeoRun generation hub. Every field name is snake_case, every collection answers { data, next_cursor }, and every failure is { error: { code, message, user_message, request_id, details? } }.

Страница собрана из того самого документа OpenAPI, который лежит в репозитории, — версия 1.0.0, OpenAPI 3.1.0. Базовый адрес: https://api.neorun.ru.

Скачать openapi.json — тот же документ байт в байт, для генератора клиента или импорта в свой инструмент.

An API key sent as Authorization: Bearer . The operations published here ask for me:read, models:read, generations:read, generations:write, library:read, library:write, billing:read, support:read, support:write, uploads:write, workflows:read, workflows:write — a key may hold scopes beyond that set — and every scope an operation names in x-required-scope is required, not any of them.

The first-party session cookie, accepted as an alternative to the key and carrying the full scope set. Browser-only: CORS is closed to the key channel, and a mutating request on this one is refused unless its Origin is allowlisted.

The authorization server at this issuer (RFC 8414 discovery under the same origin). PKCE (S256) is required for every client; a granted access token is scoped exactly like an API key.

billing

GET/v1/billing/subscription

Read the caller’s live subscription

Требуемые права:billing:read

The subscription the account is still billed on, or null when it has none — never 404, the singleton-read convention this API uses throughout. Payments, card data and provider ids are never published: status, amount, recurrent_amount, currency, next_payment_at and cancelled_at are the whole of it.

Plan, balance and free quotas are published by GET /v1/me, not here.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Ответы

  • 200BillingSubscriptionDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

GET/v1/billing/transactions

List the caller’s credit ledger

Требуемые права:billing:read

The caller’s own transactions, newest first. Pass next_cursor back as cursor unchanged; it is opaque and must not be parsed. limit defaults to 20 and caps at 100 — over the cap is refused, never clamped.

amount_cc is signed centi-credits: positive credits the balance, negative debits it. generation_id is the id GET /v1/generations/{id} accepts, or null for a row with no link — including history written before the link existed. reason is a closed machine vocabulary derived from the internal ledger, null when none applies.

Plan, balance and free quotas are published by GET /v1/me, not here.

Параметры запроса

  • cursorstringдлина от 1
  • limitintegerзначение 1–100 · по умолчанию 20

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Ответы

  • 200CreditTransactionCollectionDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 400ApiErrorRefused with invalid_limit, invalid_cursor.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

events

GET/v1/events

Stream generation status changes

Требуемые права:generations:read

A server-sent event stream of the caller’s own generations. It carries one event type, generation.status_changed, whose data is a GenerationEventDto: which generation moved and to what status, never the full record — re-read that through GET /v1/generations/{id} or POST /v1/generations/status.

Every event carries an id:. It is opaque and must not be parsed. Send the last one you received back as Last-Event-ID when reconnecting, and the stream resumes right after it without losing a transition. Comment lines are heartbeats and carry nothing.

When the presented Last-Event-ID cannot be resumed from — it is older than the retention window or is not a cursor of this stream — the first frame is a reset event whose data is an EventStreamResetDto. The stream still answers 200 and continues live after it; catch up on the transitions in between through POST /v1/generations/status.

A terminated event carrying the standard error body ends the stream when access is withdrawn while it is open — a revoked or expired key, a suspended account, a lost scope. The reconnect that follows receives the same refusal as an ordinary error response.

A cancelled generation arrives as FAILED with deleted: true. types narrows the stream to the listed generation types; an unknown type is refused rather than silently matching nothing.

Opening or reconnecting costs one request from the same rate-limit window every other endpoint draws on. Concurrent streams per key are capped and one past the cap is refused with 429 too_many_streams. The heartbeat interval, the cap and the retention window are published in limits.json under events.

Параметры запроса

  • typesstring

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.
  • Last-Event-IDstringThe id: of the last event received, to resume right after it. Browsers send it on their own when an EventSource reconnects.

Ответы

  • 200без телаAn open event stream.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 400ApiErrorRefused with invalid_request.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited, too_many_streams.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

generations

GET/v1/generations

List the caller’s generations

Требуемые права:generations:read

The caller’s own history, newest first, ordered by creation time with the id as tiebreaker. Pass next_cursor back as cursor unchanged; it is opaque and must not be parsed. limit defaults to 20 and caps at 100 — over the cap is refused, never clamped.

Параметры запроса

  • cursorstringдлина от 1
  • limitintegerзначение 1–100 · по умолчанию 20

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Ответы

  • 200GenerationCollectionDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 400ApiErrorRefused with invalid_limit, invalid_cursor.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

POST/v1/generations

Submit a generation

Требуемые права:generations:write

Answers 202 and never 201: the row exists, the work does not. Location points at GET /v1/generations/{id}, the route to poll for the result.

Idempotency-Key is mandatory. A replayed key answers the first submit’s row at its current status rather than a distinct "already done" shape, so a retry after a lost response is safe and charges once. The same key with a different body is refused.

The one surface with no shared request schema, the streaming text surface, answers submit_unavailable naming the type, and nothing is charged. Every other surface submits for real.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.
  • Idempotency-KeystringобязательноеCaller-chosen key that makes a retry replay the first submit instead of charging twice.

Тело запроса (обязательно)

Тело — один из вариантов ниже; какой именно, решает поле-различитель.

посторонние поля не принимаются

  • promptstringThe outer bound of the field. The limit that applies is the model's own prompt_limit, published per model by GET /v1/models, and it is lower for most models.длина до 100000 · по умолчанию ""
  • modelstringобязательноедлина 2–80
  • durationintegerзначение 1–30
  • aspectstringдлина до 20
  • resolutionstringдлина до 10
  • image_urlsarray<string>элементов до 30 · элемент: длина до 2048
  • video_urlstringдлина до 2048
  • video_urlsarray<string>элементов до 10 · элемент: длина до 2048
  • audio_urlstringдлина до 2048
  • audio_urlsarray<string>элементов до 10 · элемент: длина до 2048
  • soundboolean
  • keyframe_timesarray<number>элементов до 10 · элемент: значение 0–20
  • draft_generation_idstringдлина 20–40
  • extend_generation_idstringдлина 20–40
  • keep_original_soundboolean
  • character_orientationstringimagevideo
  • video_durationnumberзначение больше 0 · значение до 60
  • video_duration_sigstringдлина до 128
  • ref_task_typestringreferenceeditextend
  • prompt_expansionstringThe model's prompt-expansion mode. A model takes only the values GET /v1/models publishes in its prompt_expansion_modes; omitted, it applies its default_prompt_expansion.disabledfastbalancedquality
  • seedintegerThe seed the render starts from. Accepted only where GET /v1/models publishes has_seed; omitted, the model picks its own.значение 0–2147483647
  • negative_promptstringдлина до 2500
  • multi_shotboolean
  • shot_typestringcustomizeintelligence
  • multi_promptarray<object>элементов до 6indexintegerобязательноезначение 1–6promptstringобязательноедлина до 2500durationintegerобязательноезначение 2–30
  • indexintegerобязательноезначение 1–6
  • promptstringобязательноедлина до 2500
  • durationintegerобязательноезначение 2–30
  • bypass_promo_queueboolean
  • promo_modestringqueue
  • reference_face_maskarray<boolean>элементов до 30
  • reference_hashesarray<string>элементов до 30 · элемент: длина до 64
  • reference_audioarray<string>элементов до 5 · элемент: длина 1–64
  • typevideoобязательное

посторонние поля не принимаются

  • promptstringThe outer bound of the field. The limit that applies is the model's own prompt_limit, published per model by GET /v1/models, and it is lower for most models.длина до 100000 · по умолчанию ""
  • modelstringобязательноедлина 2–80
  • aspectstringдлина до 20
  • resolutionstringдлина до 10
  • negativestringдлина до 5000
  • image_urlsarray<string>элементов до 16 · элемент: длина до 2048
  • style_ref_urlsarray<string>элементов до 5 · элемент: длина до 2048
  • char_ref_urlsarray<string>элементов до 5 · элемент: длина до 2048
  • seedstringдлина до 500
  • n_variantsintegerзначение 1–4
  • image_sizestringдлина до 30
  • guidance_scalenumber
  • output_formatstringдлина до 10
  • qualitystringlowmediumhigh
  • backgroundstringopaquetransparent
  • promo_modestringqueueunlimited
  • camera_angleobjectThe camera move of a model confined to its own studio page; ignored by every other model.посторонние поля не принимаютсяhorizontalnumberобязательноезначение 0–360verticalnumberобязательноезначение -30–90zoomnumberобязательноезначение 0–10
  • horizontalnumberобязательноезначение 0–360
  • verticalnumberобязательноезначение -30–90
  • zoomnumberобязательноезначение 0–10
  • typeimageобязательное

посторонние поля не принимаются

  • promptstringдлина до 500
  • image_urlstringобязательноедлина до 2048
  • modelstringпо умолчанию "topaz-upscale"topaz-upscaletopaz-video-upscaletopaz-video-starlight-fasttopaz-video-starlight-hqtopaz-video-astraflux-upscale-preciseflux-upscale-creative
  • scaleintegerобязательноезначение больше 0 · значение до 9007199254740991
  • input_widthintegerзначение больше 0 · значение до 20000
  • input_heightintegerзначение больше 0 · значение до 20000
  • topaz_modelstringstandard-v2high-fidelity-v2low-resolution-v2cgitext-refine
  • face_recoveryboolean
  • face_strengthnumberзначение 0–1
  • sharpennumberзначение 0–1
  • denoisenumberзначение 0–1
  • fix_compressionnumberзначение 0–1
  • creativitynumberзначение 0–1
  • typeupscaleобязательное

посторонние поля не принимаются

  • promptstringдлина до 2000 · по умолчанию ""
  • modelstringобязательноедлина 2–80
  • image_urlsarray<string>элементов до 5 · элемент: длина до 2048
  • formatstringGLBOBJUSDZFBXSTLMP4
  • resolutionstring15361536pro
  • materialstringPBRShadedNone
  • mesh_modestringRawQuad
  • generate_typestringNormalGeometry
  • enable_pbrboolean
  • enable_geometryboolean
  • face_countintegerзначение 1000–2000000
  • faceintegerзначение 1000–2000000
  • qualityintegerзначение 1000–2000000
  • subdivision_levelintegerзначение 0–3
  • type3dобязательное

посторонние поля не принимаются

  • video_urlstringобязательноедлина до 2048
  • audio_urlstringобязательноедлина до 2048
  • video_duration_secnumberзначение больше 0 · значение до 10
  • audio_duration_secnumberзначение больше 0 · значение до 30
  • video_duration_sigstringдлина до 128
  • audio_duration_sigstringдлина до 128
  • typelipsyncобязательное

посторонние поля не принимаются

  • audio_urlstringобязательноедлина до 2048
  • image_urlsarray<string>обязательноеэлементов 1–1 · элемент: длина до 2048
  • promptstringдлина до 2000
  • auto_maskboolean
  • modelstringomnihuman-1.5wan2.2-digital-human
  • resolutionstring480p720p1080p
  • turbo_modeboolean
  • audio_duration_secnumberзначение больше 0 · значение до 60
  • audio_duration_sigstringдлина до 128
  • typeomnihumanобязательное

посторонние поля не принимаются

  • image_urlstringобязательноедлина до 2048
  • modestringпо умолчанию "std"stdpro
  • promptstringдлина до 2000
  • audio_urlstringобязательноедлина до 2048
  • audio_duration_secnumberзначение больше 0 · значение до 60
  • audio_duration_sigstringдлина до 128
  • typeavatarобязательное

посторонние поля не принимаются

  • textstringобязательноедлина 2–40000
  • voice_idstringобязательноедлина 1–120
  • voice_namestringдлина до 120
  • modelstringtext-to-speech-turbo-2-5text-to-speech-flash-2-5text-to-speech-multilingual-v2text-to-speech-v3text-to-speech-v4text-to-speech-v4-turbo
  • stabilitynumberзначение 0–1
  • similarity_boostnumberзначение 0–1
  • stylenumberзначение 0–1
  • speednumberзначение 0.7–1.2
  • typevoiceобязательное

посторонние поля не принимаются

  • titlestringдлина до 80
  • lyricsstringдлина до 5000
  • stylestringдлина до 1000
  • modelstringдлина 2–80
  • negative_tagsstringдлина до 500
  • vocal_genderstringmf
  • style_weightnumberзначение 0–1
  • typemusicобязательное

посторонние поля не принимаются

  • titlestringдлина до 80
  • stylestringдлина до 1000
  • file_urlstringобязательноедлина до 2048
  • promptstringдлина 2–2000
  • instrumentalboolean
  • typemusic-coverобязательное

посторонние поля не принимаются

  • promptstringобязательноедлина 5–500
  • modelstringV6V6_WILDV6_MINI
  • instrumentalboolean
  • typesongобязательное

посторонние поля не принимаются

  • themestringобязательноедлина 2–200
  • moodstringдлина до 120
  • typelyricsобязательное

посторонние поля не принимаются

  • marketplacestringобязательноедлина 1–20
  • categorystringобязательноедлина 1–20
  • backgroundstringобязательноедлина 1–20
  • textstringдлина до 100
  • promptstringдлина до 500
  • modelstringобязательноеnano-banana-pronano-banana-2nano-banana-2.1
  • resolutionstring1k2k4k
  • aspectstring3:41:1
  • image_urlsarray<string>обязательноеэлементов 1–3 · элемент: длина до 2048
  • typecard-designобязательное

посторонние поля не принимаются

  • titlestringдлина до 80
  • stylestringобязательноедлина 1–1000
  • promptstringобязательноедлина 1–5000
  • file_urlstringдлина до 2048
  • typemusic-vocalsобязательное

посторонние поля не принимаются

  • titlestringдлина до 80
  • stylestringдлина до 1000
  • promptstringдлина 2–2000
  • file_urlstringдлина до 2048
  • task_idstringдлина 1–200
  • audio_idstringдлина 1–200
  • source_generation_idstringдлина 1–100
  • source_indexintegerзначение 0–100
  • typemusic-instrumentalобязательное

посторонние поля не принимаются

  • titlestringдлина до 80
  • stylestringдлина до 1000
  • promptstringдлина 2–2000
  • file_urlstringдлина до 2048
  • task_idstringдлина 1–200
  • audio_idstringдлина 1–200
  • source_generation_idstringдлина 1–100
  • source_indexintegerзначение 0–100
  • typemusic-stemsобязательное

посторонние поля не принимаются

  • typetextобязательное

Ответы

  • 202GenerationDtoAccepted. The generation row exists; Location names where its result will appear.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.LocationstringThe generation to poll, as /v1/generations/{id}.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • LocationstringThe generation to poll, as /v1/generations/{id}.
  • 400ApiErrorRefused with invalid_request.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 402ApiErrorRefused with payment_required, insufficient_credits, key_spend_limit_reached, grant_spend_limit_reached.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope, moderation_blocked, origin_mismatch. Rate-limit headers are absent on origin_mismatch, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 409ApiErrorRefused with duplicate_key_conflict.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled, submit_unavailable. Rate-limit headers are absent on api_disabled, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.

POST/v1/generations/status

Read the status of several generations at once

Требуемые права:generations:read

Answers several generations in one request. Follow progress through the stream at GET /v1/events; this route is the catch-up after a stream was lost or answered with a reset, and the way to read a known set of ids at any time. One generation reads through GET /v1/generations/{id}. It draws on the same request window every other endpoint does. DONE is the one status that never changes again; FAILED ends the attempt rather than the record, because a late provider answer can still recover such a row into DONE.

The body carries between 1 and 50 ids. Nothing is repaired: more ids than the cap is refused, an empty array is refused, a duplicated id is refused, and an id that is not a resource id is refused — none of them is trimmed, deduplicated or skipped.

An id belonging to another account, or one that never existed, is simply absent from data. Absence is the only signal, which is what keeps the endpoint from confirming that somebody else’s generation exists.

It is a POST because the id list does not belong in a URL. It reads, creates nothing, and answers 200.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Тело запроса (обязательно)

  • idsarray<string>обязательноеэлементов 1–50 · без повторов

Ответы

  • 200GenerationStatusCollectionDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 400ApiErrorRefused with invalid_request, invalid_limit.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope, origin_mismatch. Rate-limit headers are absent on origin_mismatch, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

GET/v1/generations/{id}

Read one generation

Требуемые права:generations:read

The same shape the collection publishes — there is no summary form beside a full one. An id belonging to another account answers 404 rather than 403, so a refusal never confirms that a generation exists.

Параметры пути

  • idstringобязательноеThe generation id, as published in data[].id.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Ответы

  • 200GenerationDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

PATCH/v1/generations/{id}

Rename one generation

Требуемые права:library:write

Edits the title only — generation metadata, under library:write rather than generations:write, because a rename spends nothing. The title is trimmed and stored as the studio stores it; an empty one clears it. The answer is the id and the title only, as GET /v1/generations/{id} would serve it, so a title that read route withholds is withheld here too; reading the rest of the generation takes generations:read. An id belonging to another account answers 404, so a refusal never confirms it. Moving a generation into a folder is POST /v1/library/move.

Параметры пути

  • idstringобязательноеThe generation id, as published in data[].id.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Тело запроса (обязательно)

посторонние поля не принимаются

  • titlestringобязательноедлина до 120

Ответы

  • 200LibraryRenameDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 400ApiErrorRefused with invalid_request.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope, origin_mismatch. Rate-limit headers are absent on origin_mismatch, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

DELETE/v1/generations/{id}

Cancel or delete one generation

Требуемые права:generations:write

The studio’s own cancel reached by key, on the one shared implementation: it cancels before dispatch and deletes once terminal. refunded reports whether this request actually moved credits back — it never decides a refund, and a terminal row is never refunded because a provider was already contacted.

A claimed row answers generation_in_flight. A frozen row is cancelled only while QUEUED or PENDING with no provider task; otherwise generation_frozen. Repeating on a deleted row is a success. Another account’s id answers 404, so a refusal never confirms it.

Параметры пути

  • idstringобязательноеThe generation id, as published in data[].id.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Ответы

  • 200GenerationCancelDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 402ApiErrorRefused with payment_required.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope, origin_mismatch. Rate-limit headers are absent on origin_mismatch, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 409ApiErrorRefused with generation_frozen, generation_in_flight.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

GET/v1/generations/{id}/outputs/{kind}/{index}

Download one generation output

Требуемые права:generations:read

The file behind one entry of output_urls, streamed by this API with the caller’s own credential — use the url exactly as published rather than assembling one. kind is the output_urls channel and index the position the url carries, which can differ from the entry’s place in that list when an earlier output is not served.

Content-Type is the type the file was stored with, Content-Length its size. The answer is Cache-Control: private, no-store: it belongs to the credential that asked.

A single Range: bytes=… is honoured with 206 and Content-Range, so a download resumes and a video seeks; a multi-range request, or one past the end of the file, gets the whole file with 200.

A generation of another account, a deleted one, a position with no file behind it and an output this API does not hold all answer the same 404, so a refusal never confirms a row.

Besides a key and a /v1 OAuth token, this route and the library content route accept an OAuth token issued for /mcp, so an MCP client can follow the url get_output hands back.

Параметры пути

  • idstringобязательноеThe generation id, as published in data[].id.
  • kindstringобязательноеThe output_urls channel — image, original, video, audio, download, wav or model3d.
  • indexintegerобязательноеThe stored position the published url carries.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.
  • RangestringOne bytes= range to resume a download or seek a video. A multi-range request, or one past the end of the file, is answered with the whole file.

Ответы

  • 200без телаThe file itself.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Accept-RangesstringAlways bytes.Content-RangestringOn a 206: the slice sent and the file’s full size.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Accept-RangesstringAlways bytes.
  • Content-RangestringOn a 206: the slice sent and the file’s full size.
  • 206без телаThe requested slice of the file; Content-Range names it.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Accept-RangesstringAlways bytes.Content-RangestringOn a 206: the slice sent and the file’s full size.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Accept-RangesstringAlways bytes.
  • Content-RangestringOn a 206: the slice sent and the file’s full size.
  • 400ApiErrorRefused with invalid_request.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

POST/v1/generations/{id}/report

Report a problem with one generation

Требуемые права:generations:write

«Сообщить о проблеме» reached by key. It records and moves nothing: this is the route to a manual refund a human grants after diagnosis, never an automatic one. Filing a report therefore never changes a balance, and the response carries no credit field.

reason: "moderation" withdraws the generation as well as filing the report — except one already held for review, which only an operator withdraws and whose report is still accepted; "failure", the default, leaves it retryable. A new "failure" report on a generation already settled automatically answers generation_already_settled — there is nothing left to ask for — while a "moderation" report and a replay of the same client_msg_id are accepted regardless.

Send client_msg_id — a UUID — to make a retry after a lost response replay the first ticket instead of filing a second one. The same id with different text is refused rather than silently reused, and an id two callers could both pick would collide across accounts.

Параметры пути

  • idstringобязательноеThe generation id the report is about.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Тело запроса (обязательно)

посторонние поля не принимаются

  • textstringобязательноедлина 1–2000
  • reasonstringпо умолчанию "failure"failuremoderation
  • client_msg_idstringшаблон ^([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)$ · формат uuid

Ответы

  • 201GenerationReportDtoThe report was filed; the ticket it landed on is named.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 400ApiErrorRefused with invalid_request.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope, origin_mismatch. Rate-limit headers are absent on origin_mismatch, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 409ApiErrorRefused with report_replay_mismatch.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 422ApiErrorRefused with generation_already_settled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

knowledge

GET/v1/knowledge

Search the public knowledge base

Требуемые права:models:read

Public help articles and per-model prompting guides, matched on title and summary; without q it answers the first limit of the whole base, not all of it. Articles come first in editorial order, then guides; a specific slug is reached by searching its words, or read directly at GET /v1/knowledge/{slug}. Only content published for users is ever returned — the support team’s internal notes are not part of this surface. Each result carries lang: articles are served as written (mostly ru), guides in en. Upstream provider names are masked in every result.

Capped, not paged: limit defaults to 20 and caps at 50, and next_cursor is always null. Over the cap is refused, never clamped.

Параметры запроса

  • qstringдлина до 120
  • limitintegerзначение 1–50 · по умолчанию 20

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Ответы

  • 200KnowledgeCollectionDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 400ApiErrorRefused with invalid_request, invalid_limit.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

GET/v1/knowledge/{slug}

Read one knowledge article

Требуемые права:models:read

The full article behind a slug from GET /v1/knowledge, in the language it was written in (lang), with upstream provider names masked. A slug that is not published — unknown, withdrawn, lapsed or never public — answers 404 the same way, so the refusal confirms nothing.

Параметры пути

  • slugstringобязательноеThe article slug, as published in data[].slug.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Ответы

  • 200KnowledgeArticleDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

library

GET/v1/library/assets

List the caller’s uploaded references

Требуемые права:library:read

The caller’s own uploads, newest first. Pass next_cursor back as cursor unchanged; it is opaque and must not be parsed. limit defaults to 20 and caps at 100 — over the cap is refused, never clamped.

Параметры запроса

  • cursorstringдлина от 1
  • limitintegerзначение 1–100 · по умолчанию 20

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Ответы

  • 200LibraryAssetCollectionDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 400ApiErrorRefused with invalid_limit, invalid_cursor.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

PATCH/v1/library/assets/{id}

Rename an uploaded reference

Требуемые права:library:write

The title is trimmed and stored as the studio stores it; an empty one clears it. The answer is the id and the stored title only; reading the rest of the asset takes library:read. An asset of another account, a deleted one and one hidden from the caller’s library all answer the same 404, and none of them is renamed.

Параметры пути

  • idstringобязательноеThe asset id, as published in data[].id.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Тело запроса (обязательно)

посторонние поля не принимаются

  • titlestringобязательноедлина до 120

Ответы

  • 200LibraryRenameDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 400ApiErrorRefused with invalid_request.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope, origin_mismatch. Rate-limit headers are absent on origin_mismatch, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

GET/v1/library/assets/{id}/content

Download one uploaded reference

Требуемые права:library:read

The file behind an asset’s output_urls entry, streamed by this API with the caller’s own credential. The same headers as a generation output: the stored Content-Type, the size as Content-Length, and Cache-Control: private, no-store. A byte range is answered as on the generation output route.

An asset of another account, a deleted one, one hidden from the caller’s library and one this API does not hold all answer the same 404. An OAuth token issued for /mcp is accepted here as on the generation output route.

Параметры пути

  • idstringобязательноеThe asset id, as published in data[].id.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.
  • RangestringOne bytes= range to resume a download or seek a video. A multi-range request, or one past the end of the file, is answered with the whole file.

Ответы

  • 200без телаThe file itself.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Accept-RangesstringAlways bytes.Content-RangestringOn a 206: the slice sent and the file’s full size.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Accept-RangesstringAlways bytes.
  • Content-RangestringOn a 206: the slice sent and the file’s full size.
  • 206без телаThe requested slice of the file; Content-Range names it.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Accept-RangesstringAlways bytes.Content-RangestringOn a 206: the slice sent and the file’s full size.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Accept-RangesstringAlways bytes.
  • Content-RangestringOn a 206: the slice sent and the file’s full size.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

GET/v1/library/folders

List the caller’s library folders

Требуемые права:library:read

Folders are capped rather than paged, so this route takes no parameters and next_cursor is always null — the same envelope every other collection answers with. Ordered by position, then creation time, as the studio sidebar shows them.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Ответы

  • 200LibraryFolderCollectionDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

POST/v1/library/folders

Create a library folder

Требуемые права:library:write

The studio’s own folder create, on the one shared implementation: the folder is placed last, names are unique per account, and the account holds a capped number of folders. A name already taken answers folder_name_taken; a full library answers folder_limit_reached. The answer is the new id and the name as stored; the folder’s position and creation time are read through GET /v1/library/folders, which takes library:read. Spends nothing.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Тело запроса (обязательно)

посторонние поля не принимаются

  • namestringобязательноедлина 1–64

Ответы

  • 201LibraryFolderWriteDtoThe folder was created.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 400ApiErrorRefused with invalid_request.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope, origin_mismatch. Rate-limit headers are absent on origin_mismatch, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 409ApiErrorRefused with folder_limit_reached, folder_name_taken.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

PATCH/v1/library/folders/{id}

Rename or reorder a library folder

Требуемые права:library:write

Send name, position or both. position is the sort key the folder list reads, a non-negative 32-bit integer; folders sharing one list in creation order. The caller owns the ordering and nothing renumbers the other folders. The answer is the id and only the fields sent, as stored; reading the rest of the folder takes library:read. A folder of another account answers 404, exactly as one that never existed.

Параметры пути

  • idstringобязательноеThe folder id, as published in data[].id.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Тело запроса (обязательно)

посторонние поля не принимаются

  • namestringдлина 1–64
  • positionintegerзначение 0–2147483647

Ответы

  • 200LibraryFolderWriteDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 400ApiErrorRefused with invalid_request.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope, origin_mismatch. Rate-limit headers are absent on origin_mismatch, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 409ApiErrorRefused with folder_name_taken.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

DELETE/v1/library/folders/{id}

Delete a library folder

Требуемые права:library:write

Deletes the folder only: the generations and uploads in it survive and return to the root. A folder of another account answers 404, exactly as one that never existed.

Параметры пути

  • idstringобязательноеThe folder id, as published in data[].id.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Ответы

  • 200OkDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope, origin_mismatch. Rate-limit headers are absent on origin_mismatch, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

POST/v1/library/move

Move library items into a folder or back to the root

Требуемые права:library:write

item_ids names generations and uploads alike; folder_id: null files them back to the root. An id that is not the caller’s, or not live, is skipped rather than refused, as in the studio, and moved counts only what was actually filed. A target folder of another account answers 404, exactly as one that never existed.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Тело запроса (обязательно)

посторонние поля не принимаются

  • item_idsarray<string>обязательноеэлементов 1–200
  • folder_idstringnullобязательное

Ответы

  • 200LibraryMoveDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 400ApiErrorRefused with invalid_request.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope, origin_mismatch. Rate-limit headers are absent on origin_mismatch, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

me

GET/v1/me

Read the caller’s account

Требуемые права:me:read

Plan, credit balance and free quotas for whoever the credential resolved to. It takes no parameters at all: the subject is never named in the request, so another account cannot be read by typing its id.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Ответы

  • 200MeDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

models

GET/v1/models

List the selectable models and their prices

Требуемые права:models:read

The machine-readable catalog: what each model accepts, and what it costs this caller — price_cc is quoted in the unit beside it, so a per-second rate must be multiplied by the billable duration before it is read as the price of a generation. A model whose pricing.quote is "estimate" publishes no rate: its charge is measured from the source, so POST /v1/pricing/estimate with the full request is its price. Any of it can change at any moment, so the response always revalidates: send the ETag back in If-None-Match and read the 304. The value is opaque — do not parse it.

Параметры запроса

  • typestringimagevideo3dvoicemusic

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.
  • If-None-MatchstringThe ETag of a previous response, to be answered with 304 when unchanged.

Ответы

  • 200ModelCollectionDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.ETagstringSend it back in If-None-Match to revalidate; opaque, never parsed.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • ETagstringSend it back in If-None-Match to revalidate; opaque, never parsed.
  • 304без телаThe catalog is unchanged since the ETag sent in If-None-Match.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.ETagstringSend it back in If-None-Match to revalidate; opaque, never parsed.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • ETagstringSend it back in If-None-Match to revalidate; opaque, never parsed.
  • 400ApiErrorRefused with invalid_request.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

pricing

POST/v1/pricing/estimate

Price a submit before sending it

Требуемые права:models:read

What POST /v1/generations would charge for this exact body, computed by the same function that will charge it rather than by a second expression over the same tables. It takes the submit body itself, so a caller prices and submits one request rather than two shapes.

price_cc is a ceiling, never an under-quote: a free quota and a provider promo run after it and can only lower what the ledger debits. No cost or margin figure appears anywhere in the response.

POST for a body-carrying read, and 200 rather than 201 — nothing is created, no key is claimed and nothing is spent, so a retry is free. It needs only models:read, and no paid gate: a caller must not have to pay to find out what paying costs.

A surface priced on media — the clip a lipsync re-voices, the track an avatar or omnihuman animates, the picture or clip an upscale enlarges, the reference clips a video edits or bills — is quoted by measuring the referenced files on the server exactly as the submit measures them; a length or size the caller declares is never read. The files must exist and belong to the caller: one that cannot be read is refused with invalid_request rather than quoted as nothing, and nothing is touched, claimed or counted. A promo_mode submit, billed by entitlement rather than by a rate, answers estimate_unavailable.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Тело запроса (обязательно)

Тело — один из вариантов ниже; какой именно, решает поле-различитель.

посторонние поля не принимаются

  • promptstringThe outer bound of the field. The limit that applies is the model's own prompt_limit, published per model by GET /v1/models, and it is lower for most models.длина до 100000 · по умолчанию ""
  • modelstringобязательноедлина 2–80
  • durationintegerзначение 1–30
  • aspectstringдлина до 20
  • resolutionstringдлина до 10
  • image_urlsarray<string>элементов до 30 · элемент: длина до 2048
  • video_urlstringдлина до 2048
  • video_urlsarray<string>элементов до 10 · элемент: длина до 2048
  • audio_urlstringдлина до 2048
  • audio_urlsarray<string>элементов до 10 · элемент: длина до 2048
  • soundboolean
  • keyframe_timesarray<number>элементов до 10 · элемент: значение 0–20
  • draft_generation_idstringдлина 20–40
  • extend_generation_idstringдлина 20–40
  • keep_original_soundboolean
  • character_orientationstringimagevideo
  • video_durationnumberзначение больше 0 · значение до 60
  • video_duration_sigstringдлина до 128
  • ref_task_typestringreferenceeditextend
  • prompt_expansionstringThe model's prompt-expansion mode. A model takes only the values GET /v1/models publishes in its prompt_expansion_modes; omitted, it applies its default_prompt_expansion.disabledfastbalancedquality
  • seedintegerThe seed the render starts from. Accepted only where GET /v1/models publishes has_seed; omitted, the model picks its own.значение 0–2147483647
  • negative_promptstringдлина до 2500
  • multi_shotboolean
  • shot_typestringcustomizeintelligence
  • multi_promptarray<object>элементов до 6indexintegerобязательноезначение 1–6promptstringобязательноедлина до 2500durationintegerобязательноезначение 2–30
  • indexintegerобязательноезначение 1–6
  • promptstringобязательноедлина до 2500
  • durationintegerобязательноезначение 2–30
  • bypass_promo_queueboolean
  • promo_modestringqueue
  • reference_face_maskarray<boolean>элементов до 30
  • reference_hashesarray<string>элементов до 30 · элемент: длина до 64
  • reference_audioarray<string>элементов до 5 · элемент: длина 1–64
  • typevideoобязательное

посторонние поля не принимаются

  • promptstringThe outer bound of the field. The limit that applies is the model's own prompt_limit, published per model by GET /v1/models, and it is lower for most models.длина до 100000 · по умолчанию ""
  • modelstringобязательноедлина 2–80
  • aspectstringдлина до 20
  • resolutionstringдлина до 10
  • negativestringдлина до 5000
  • image_urlsarray<string>элементов до 16 · элемент: длина до 2048
  • style_ref_urlsarray<string>элементов до 5 · элемент: длина до 2048
  • char_ref_urlsarray<string>элементов до 5 · элемент: длина до 2048
  • seedstringдлина до 500
  • n_variantsintegerзначение 1–4
  • image_sizestringдлина до 30
  • guidance_scalenumber
  • output_formatstringдлина до 10
  • qualitystringlowmediumhigh
  • backgroundstringopaquetransparent
  • promo_modestringqueueunlimited
  • camera_angleobjectThe camera move of a model confined to its own studio page; ignored by every other model.посторонние поля не принимаютсяhorizontalnumberобязательноезначение 0–360verticalnumberобязательноезначение -30–90zoomnumberобязательноезначение 0–10
  • horizontalnumberобязательноезначение 0–360
  • verticalnumberобязательноезначение -30–90
  • zoomnumberобязательноезначение 0–10
  • typeimageобязательное

посторонние поля не принимаются

  • promptstringдлина до 500
  • image_urlstringобязательноедлина до 2048
  • modelstringпо умолчанию "topaz-upscale"topaz-upscaletopaz-video-upscaletopaz-video-starlight-fasttopaz-video-starlight-hqtopaz-video-astraflux-upscale-preciseflux-upscale-creative
  • scaleintegerобязательноезначение больше 0 · значение до 9007199254740991
  • input_widthintegerзначение больше 0 · значение до 20000
  • input_heightintegerзначение больше 0 · значение до 20000
  • topaz_modelstringstandard-v2high-fidelity-v2low-resolution-v2cgitext-refine
  • face_recoveryboolean
  • face_strengthnumberзначение 0–1
  • sharpennumberзначение 0–1
  • denoisenumberзначение 0–1
  • fix_compressionnumberзначение 0–1
  • creativitynumberзначение 0–1
  • typeupscaleобязательное

посторонние поля не принимаются

  • promptstringдлина до 2000 · по умолчанию ""
  • modelstringобязательноедлина 2–80
  • image_urlsarray<string>элементов до 5 · элемент: длина до 2048
  • formatstringGLBOBJUSDZFBXSTLMP4
  • resolutionstring15361536pro
  • materialstringPBRShadedNone
  • mesh_modestringRawQuad
  • generate_typestringNormalGeometry
  • enable_pbrboolean
  • enable_geometryboolean
  • face_countintegerзначение 1000–2000000
  • faceintegerзначение 1000–2000000
  • qualityintegerзначение 1000–2000000
  • subdivision_levelintegerзначение 0–3
  • type3dобязательное

посторонние поля не принимаются

  • video_urlstringобязательноедлина до 2048
  • audio_urlstringобязательноедлина до 2048
  • video_duration_secnumberзначение больше 0 · значение до 10
  • audio_duration_secnumberзначение больше 0 · значение до 30
  • video_duration_sigstringдлина до 128
  • audio_duration_sigstringдлина до 128
  • typelipsyncобязательное

посторонние поля не принимаются

  • audio_urlstringобязательноедлина до 2048
  • image_urlsarray<string>обязательноеэлементов 1–1 · элемент: длина до 2048
  • promptstringдлина до 2000
  • auto_maskboolean
  • modelstringomnihuman-1.5wan2.2-digital-human
  • resolutionstring480p720p1080p
  • turbo_modeboolean
  • audio_duration_secnumberзначение больше 0 · значение до 60
  • audio_duration_sigstringдлина до 128
  • typeomnihumanобязательное

посторонние поля не принимаются

  • image_urlstringобязательноедлина до 2048
  • modestringпо умолчанию "std"stdpro
  • promptstringдлина до 2000
  • audio_urlstringобязательноедлина до 2048
  • audio_duration_secnumberзначение больше 0 · значение до 60
  • audio_duration_sigstringдлина до 128
  • typeavatarобязательное

посторонние поля не принимаются

  • textstringобязательноедлина 2–40000
  • voice_idstringобязательноедлина 1–120
  • voice_namestringдлина до 120
  • modelstringtext-to-speech-turbo-2-5text-to-speech-flash-2-5text-to-speech-multilingual-v2text-to-speech-v3text-to-speech-v4text-to-speech-v4-turbo
  • stabilitynumberзначение 0–1
  • similarity_boostnumberзначение 0–1
  • stylenumberзначение 0–1
  • speednumberзначение 0.7–1.2
  • typevoiceобязательное

посторонние поля не принимаются

  • titlestringдлина до 80
  • lyricsstringдлина до 5000
  • stylestringдлина до 1000
  • modelstringдлина 2–80
  • negative_tagsstringдлина до 500
  • vocal_genderstringmf
  • style_weightnumberзначение 0–1
  • typemusicобязательное

посторонние поля не принимаются

  • titlestringдлина до 80
  • stylestringдлина до 1000
  • file_urlstringобязательноедлина до 2048
  • promptstringдлина 2–2000
  • instrumentalboolean
  • typemusic-coverобязательное

посторонние поля не принимаются

  • promptstringобязательноедлина 5–500
  • modelstringV6V6_WILDV6_MINI
  • instrumentalboolean
  • typesongобязательное

посторонние поля не принимаются

  • themestringобязательноедлина 2–200
  • moodstringдлина до 120
  • typelyricsобязательное

посторонние поля не принимаются

  • marketplacestringобязательноедлина 1–20
  • categorystringобязательноедлина 1–20
  • backgroundstringобязательноедлина 1–20
  • textstringдлина до 100
  • promptstringдлина до 500
  • modelstringобязательноеnano-banana-pronano-banana-2nano-banana-2.1
  • resolutionstring1k2k4k
  • aspectstring3:41:1
  • image_urlsarray<string>обязательноеэлементов 1–3 · элемент: длина до 2048
  • typecard-designобязательное

посторонние поля не принимаются

  • titlestringдлина до 80
  • stylestringобязательноедлина 1–1000
  • promptstringобязательноедлина 1–5000
  • file_urlstringдлина до 2048
  • typemusic-vocalsобязательное

посторонние поля не принимаются

  • titlestringдлина до 80
  • stylestringдлина до 1000
  • promptstringдлина 2–2000
  • file_urlstringдлина до 2048
  • task_idstringдлина 1–200
  • audio_idstringдлина 1–200
  • source_generation_idstringдлина 1–100
  • source_indexintegerзначение 0–100
  • typemusic-instrumentalобязательное

посторонние поля не принимаются

  • titlestringдлина до 80
  • stylestringдлина до 1000
  • promptstringдлина 2–2000
  • file_urlstringдлина до 2048
  • task_idstringдлина 1–200
  • audio_idstringдлина 1–200
  • source_generation_idstringдлина 1–100
  • source_indexintegerзначение 0–100
  • typemusic-stemsобязательное

посторонние поля не принимаются

  • typetextобязательное

Ответы

  • 200PricingEstimateDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 400ApiErrorRefused with invalid_request.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope, origin_mismatch. Rate-limit headers are absent on origin_mismatch, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 422ApiErrorRefused with estimate_unavailable.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

subscription

POST/v1/subscription/cancel

Cancel the caller’s auto-renewal

Требуемые права:billing:read

The site’s own cancel, session only. The provider stops renewing at once; the plan runs to plan_ends_at — the end of the period already paid for — and superseded reports the one case where nothing ends, because a newer subscription already renews the plan. reason and reason_text feed the retention funnel and are optional.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Тело запроса (обязательно)

посторонние поля не принимаются

  • reasonstring | nullexpensivemodelspauseother_serviceother
  • reason_textstring | null

Ответы

  • 200SubscriptionCancelDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 400ApiErrorRefused with invalid_request, no_active_plan.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope, origin_mismatch. Rate-limit headers are absent on origin_mismatch, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 409ApiErrorRefused with subscription_not_linked.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error, subscription_cancel_unsaved.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 502ApiErrorRefused with subscription_cancel_failed.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

POST/v1/subscription/card-change

Start changing the card an eligible subscription renews on

Требуемые права:billing:read

Session only. Opens a 1 RUB card check the browser runs through the payment widget as a two-stage authorization (paymentSchema: "Dual"): the sum is held, never captured, and released once the change completes or expires on its own. The answer is what the widget needs — payment_id is its invoiceId. Any earlier unfinished check of the caller is abandoned by this call.

Refused with card_change_unavailable when the subscription is not eligible for a card change, and with checkout_in_progress while a plan checkout is open.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Ответы

  • 201CardChangeBeginDtoThe card check was opened.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope, origin_mismatch. Rate-limit headers are absent on origin_mismatch, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 409ApiErrorRefused with card_change_unavailable, checkout_in_progress.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

POST/v1/subscription/card-change/complete

Finish a card change after the widget authorized the check

Требуемые права:billing:read

Session only. The authorization is read back from the provider — by transaction_id when the widget reported one, otherwise by invoice — and must be this caller’s own 1 RUB Authorized check on a card, or card_check_not_authorized is answered and nothing changes. A new subscription is then created on the new card and the old one cancelled; a subscription that is overdue is charged on the new card at once, which charge reports. The hold is released on every outcome. Calling twice answers card_change_in_progress.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Тело запроса (обязательно)

посторонние поля не принимаются

  • payment_idstringобязательноедлина от 1
  • transaction_idintegerзначение больше 0 · значение до 9007199254740991

Ответы

  • 200CardChangeCompleteDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 400ApiErrorRefused with invalid_request, plan_expired, renewal_already_on.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope, origin_mismatch. Rate-limit headers are absent on origin_mismatch, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 409ApiErrorRefused with subscription_not_linked, card_check_not_authorized, card_change_in_progress, card_change_unavailable, checkout_in_progress, subscription_superseded.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 502ApiErrorRefused with card_change_failed, subscription_resume_failed.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

POST/v1/subscription/resume

Turn the caller’s auto-renewal back on

Требуемые права:billing:read

The site’s own resume, reached over the session cookie only — no scope in the vocabulary names it, so a key or an OAuth grant answers insufficient_scope. The cancellation marker is lifted and renewal is re-enabled on the subscription’s saved payment method. Nothing is charged by this call; next_pay_date is when the first renewal lands.

A plan checkout still open on any provider refuses with checkout_in_progress; a newer subscription that already renews the plan answers subscription_superseded.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Ответы

  • 200SubscriptionResumeDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 400ApiErrorRefused with plan_expired, renewal_already_on.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope, origin_mismatch. Rate-limit headers are absent on origin_mismatch, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 409ApiErrorRefused with subscription_not_linked, card_token_missing, checkout_in_progress, subscription_superseded, subscription_recancelled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 502ApiErrorRefused with subscription_resume_failed.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

support

GET/v1/support/messages

Read the caller’s support thread

Требуемые права:support:read

The caller’s one support ticket, exactly as the site shows it: staff notes and messages from before the thread was last archived are never included, and reading it marks it read the same way opening the chat does. An account with no ticket yet answers an empty list, never 404 — the same singleton-read convention GET /v1/billing/subscription uses.

Every message names from: "user" for the caller’s own messages, "support" for anything a staff role sent. text is exactly as authored — never translated, never rewritten — and images are the URLs the site itself renders.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Ответы

  • 200SupportMessageCollectionDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

POST/v1/support/messages

Send a message into the caller’s support thread

Требуемые права:support:write

Raises the caller’s one support ticket the same way the site’s chat does — opening it if none exists yet, reopening it if it was closed. A message sent through this route posts no chat notification: this service has no staff Telegram transport, so the ticket and its unread count are raised exactly as a report filed through POST /v1/generations/{id}/report is, without a card appearing anywhere. Staff find it through the admin queue.

images are references from POST /v1/uploads, never a public URL: each one is byte-validated and ownership-checked at send, exactly like a submit reference, and a refusal names the limit it hit rather than silently resizing or dropping the picture. A refused reference writes no message at all — the picture and the text arrive together or not at all.

Send client_msg_id — a UUID — to make a retry after a lost response replay the first send instead of posting a second message, with the same pictures it was answered with the first time. The same id with different text or a different number of images answers support_replay_mismatch rather than being silently reused.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Тело запроса (обязательно)

посторонние поля не принимаются

  • textstringдлина до 2000 · по умолчанию ""
  • imagesarray<string>элементов до 3
  • client_msg_idstringшаблон ^([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)$ · формат uuid

Ответы

  • 201SupportMessageSentDtoThe message was sent (or, on a replay, was already sent); the thread it landed on is named.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 400ApiErrorRefused with invalid_request.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope, origin_mismatch. Rate-limit headers are absent on origin_mismatch, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 409ApiErrorRefused with support_replay_mismatch.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

uploads

POST/v1/uploads

Get a presigned PUT for a reference file

Требуемые права:uploads:write

Signs a single PUT into the private bucket and tells you exactly what to send. A presign is not a spend: it buys storage the retention sweep reclaims, never credits, so this route carries no paid gate — only its own uploads:write scope, kept separate from generations:write so a key may not mint a write capability into our storage.

200 and not 201: no object exists yet. It exists only once you complete the PUT with exactly the headers returned — the signature binds them, and R2 answers 403 on a mismatch. content_length is exact rather than a maximum, because a query-presigned PUT binds a length.

The ticket writes its key once: If-None-Match: * is signed with the rest, so a second PUT to the same url answers 412 rather than replacing bytes a submit may already have accepted. A PUT that must be retried takes a fresh ticket.

The ticket is registered in your library before it is handed over, which is what puts the object on the retention clock. A ticket you never use leaves an empty library entry that the same retention reclaims.

Send reference back at submit time (e.g. in image_urls). The bytes are checked at submit, not at upload, so a signature here is not an acceptance of the file.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Тело запроса (обязательно)

посторонние поля не принимаются

  • kindstringобязательноеimagevideoaudiofile
  • content_typestringобязательноедлина от 1
  • content_lengthintegerобязательноезначение больше 0 · значение до 9007199254740991

Ответы

  • 200UploadTicketDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 400ApiErrorRefused with invalid_request.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope, origin_mismatch. Rate-limit headers are absent on origin_mismatch, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled, upload_unavailable. Rate-limit headers are absent on api_disabled, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.

PUT/v1/uploads/content

Complete an upload through this API instead of the store

Требуемые права:uploads:write

The same ticket, finished against this host. Use it when a direct PUT to url cannot carry your file: that url points at the object store’s own host, and some networks throttle it to the point where anything but a tiny body fails to arrive. proxy_path on the ticket is this route with the reference already filled in.

Send the bytes as the raw body with the same Content-Type the ticket was issued for. The ticket decides the type and the exact length, so a mismatch is refused rather than stored.

One ticket writes once, whichever path you use, so neither can replace bytes a submit may already have accepted. The refusal differs by who answers it: a second completion here is 409 duplicate_key_conflict, while a second PUT against url is refused by the store itself as 412 — that condition is signed into the url and never reaches this API.

The answer echoes the reference and the byte count actually stored, so a client holding the ticket and the file apart can match them without keeping the query it just sent.

Параметры запроса

  • referencestringобязательноедлина 1–512

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.
  • Content-LengthintegerобязательноеThe ticket's content_length, exactly. Judged before the body is read, so a chunked request carrying no length is refused rather than stored.

Ответы

  • 200UploadStoredDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 400ApiErrorRefused with invalid_request.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope, origin_mismatch. Rate-limit headers are absent on origin_mismatch, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 409ApiErrorRefused with duplicate_key_conflict.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

whoami

GET/v1/whoami

Read what the credential resolved to

Требуемые права:me:read

The principal behind this request: which account, which channel, which credential, and the scopes it holds. A session carries the full scope set. spend_limit is the credential’s own monthly ceiling for the current calendar month in Moscow time — null on the session channel, and monthly_limit_cc/remaining_cc null on a credential with no ceiling set — so a caller can check its remaining budget before submitting.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Ответы

  • 200WhoamiDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

workflows

GET/v1/workflows/blocks

List the caller’s saved blocks

Требуемые права:workflows:read

Reusable node groups saved out of a chain, newest-updated first, capped at 100 — next_cursor is always null.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Ответы

  • 200WorkflowBlockCollectionDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

POST/v1/workflows/blocks

Save a new block

Требуемые права:workflows:write

Stores a subgraph — one or more connected nodes selected out of a chain — under a caller- chosen id. The same reference-ownership and account-ceiling refusals as POST /v1/workflows/templates apply, against the block’s own 100-item ceiling.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Тело запроса (обязательно)

посторонние поля не принимаются

  • idstringобязательноешаблон ^([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)$ · формат uuid
  • titlestringобязательноедлина 1–80
  • descriptionstringдлина до 500 · по умолчанию ""
  • canvasobjectобязательноеdocumentIdstringшаблон ^([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)$ · формат uuidresultSelectionmapobject>viewportobjectпосторонние поля не принимаютсяxnumberобязательноеynumberобязательноеzoomnumberобязательноезначение 0.2–2runIdsarray<string>элементов до 100 · элемент: длина 1–100bypassedNodeIdsarray<string>элементов до 30 · элемент: шаблон ^[a-zA-Z0-9_-]{1,32}$nodesarray<один из вариантов>обязательноеэлементов до 30edgesarray<object>обязательноеэлементов до 60idstringобязательноедлина до 64sourcestringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$targetstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$sourceHandlestringдлина до 32targetHandlestringдлина до 32groupsarray<object>элементов до 12titleSizestringsmallmediumlargenodeIdsarray<string>элементов до 30 · элемент: шаблон ^[a-zA-Z0-9_-]{1,32}$idstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$titlestringобязательноедлина до 60xnumberобязательноеynumberобязательноеwidthnumberобязательноезначение 40–8000heightnumberобязательноезначение 40–8000colorstringдлина до 32
  • documentIdstringшаблон ^([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)$ · формат uuid
  • resultSelectionmapobject>
  • viewportobjectпосторонние поля не принимаютсяxnumberобязательноеynumberобязательноеzoomnumberобязательноезначение 0.2–2
  • xnumberобязательное
  • ynumberобязательное
  • zoomnumberобязательноезначение 0.2–2
  • runIdsarray<string>элементов до 100 · элемент: длина 1–100
  • bypassedNodeIdsarray<string>элементов до 30 · элемент: шаблон ^[a-zA-Z0-9_-]{1,32}$
  • nodesarray<один из вариантов>обязательноеэлементов до 30
  • edgesarray<object>обязательноеэлементов до 60idstringобязательноедлина до 64sourcestringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$targetstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$sourceHandlestringдлина до 32targetHandlestringдлина до 32
  • idstringобязательноедлина до 64
  • sourcestringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$
  • targetstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$
  • sourceHandlestringдлина до 32
  • targetHandlestringдлина до 32
  • groupsarray<object>элементов до 12titleSizestringsmallmediumlargenodeIdsarray<string>элементов до 30 · элемент: шаблон ^[a-zA-Z0-9_-]{1,32}$idstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$titlestringобязательноедлина до 60xnumberобязательноеynumberобязательноеwidthnumberобязательноезначение 40–8000heightnumberобязательноезначение 40–8000colorstringдлина до 32
  • titleSizestringsmallmediumlarge
  • nodeIdsarray<string>элементов до 30 · элемент: шаблон ^[a-zA-Z0-9_-]{1,32}$
  • idstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$
  • titlestringобязательноедлина до 60
  • xnumberобязательное
  • ynumberобязательное
  • widthnumberобязательноезначение 40–8000
  • heightnumberобязательноезначение 40–8000
  • colorstringдлина до 32

Ответы

  • 201WorkflowBlockMutationDtoThe block was stored.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 400ApiErrorRefused with invalid_request.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope, origin_mismatch. Rate-limit headers are absent on origin_mismatch, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 409ApiErrorRefused with resource_conflict.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

GET/v1/workflows/blocks/{id}

Read one block, or one of its saved revisions

Требуемые права:workflows:read

Without revision: the current block plus its lightweight revision list. With it: that one historical revision in full, and no revision list beside it.

Параметры пути

  • idstringобязательноеThe block id.

Параметры запроса

  • revisionstringшаблон ^\d+$

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Ответы

  • 200WorkflowBlockGetDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

PATCH/v1/workflows/blocks/{id}

Update one block

Требуемые права:workflows:write

The same optimistic-concurrency rule as chains: expected_revision must match the block’s current revision, or the write answers revision_conflict.

Параметры пути

  • idstringобязательноеThe block id.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Тело запроса (обязательно)

посторонние поля не принимаются

  • expected_revisionintegerобязательноезначение 0–2147483646
  • titlestringобязательноедлина 1–80
  • descriptionstringдлина до 500 · по умолчанию ""
  • canvasobjectобязательноеdocumentIdstringшаблон ^([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)$ · формат uuidresultSelectionmapobject>viewportobjectпосторонние поля не принимаютсяxnumberобязательноеynumberобязательноеzoomnumberобязательноезначение 0.2–2runIdsarray<string>элементов до 100 · элемент: длина 1–100bypassedNodeIdsarray<string>элементов до 30 · элемент: шаблон ^[a-zA-Z0-9_-]{1,32}$nodesarray<один из вариантов>обязательноеэлементов до 30edgesarray<object>обязательноеэлементов до 60idstringобязательноедлина до 64sourcestringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$targetstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$sourceHandlestringдлина до 32targetHandlestringдлина до 32groupsarray<object>элементов до 12titleSizestringsmallmediumlargenodeIdsarray<string>элементов до 30 · элемент: шаблон ^[a-zA-Z0-9_-]{1,32}$idstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$titlestringобязательноедлина до 60xnumberобязательноеynumberобязательноеwidthnumberобязательноезначение 40–8000heightnumberобязательноезначение 40–8000colorstringдлина до 32
  • documentIdstringшаблон ^([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)$ · формат uuid
  • resultSelectionmapobject>
  • viewportobjectпосторонние поля не принимаютсяxnumberобязательноеynumberобязательноеzoomnumberобязательноезначение 0.2–2
  • xnumberобязательное
  • ynumberобязательное
  • zoomnumberобязательноезначение 0.2–2
  • runIdsarray<string>элементов до 100 · элемент: длина 1–100
  • bypassedNodeIdsarray<string>элементов до 30 · элемент: шаблон ^[a-zA-Z0-9_-]{1,32}$
  • nodesarray<один из вариантов>обязательноеэлементов до 30
  • edgesarray<object>обязательноеэлементов до 60idstringобязательноедлина до 64sourcestringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$targetstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$sourceHandlestringдлина до 32targetHandlestringдлина до 32
  • idstringобязательноедлина до 64
  • sourcestringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$
  • targetstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$
  • sourceHandlestringдлина до 32
  • targetHandlestringдлина до 32
  • groupsarray<object>элементов до 12titleSizestringsmallmediumlargenodeIdsarray<string>элементов до 30 · элемент: шаблон ^[a-zA-Z0-9_-]{1,32}$idstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$titlestringобязательноедлина до 60xnumberобязательноеynumberобязательноеwidthnumberобязательноезначение 40–8000heightnumberобязательноезначение 40–8000colorstringдлина до 32
  • titleSizestringsmallmediumlarge
  • nodeIdsarray<string>элементов до 30 · элемент: шаблон ^[a-zA-Z0-9_-]{1,32}$
  • idstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$
  • titlestringобязательноедлина до 60
  • xnumberобязательное
  • ynumberобязательное
  • widthnumberобязательноезначение 40–8000
  • heightnumberобязательноезначение 40–8000
  • colorstringдлина до 32

Ответы

  • 200WorkflowBlockMutationDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 400ApiErrorRefused with invalid_request.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope, origin_mismatch. Rate-limit headers are absent on origin_mismatch, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 409ApiErrorRefused with revision_conflict.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

DELETE/v1/workflows/blocks/{id}

Delete one block

Требуемые права:workflows:write

A soft delete — the block no longer appears in the list or is resolvable by id.

Параметры пути

  • idstringобязательноеThe block id.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Ответы

  • 200OkDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope, origin_mismatch. Rate-limit headers are absent on origin_mismatch, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

POST/v1/workflows/estimate

Price a chain before running it

Требуемые права:workflows:read

What POST /v1/workflows/runs would charge for this exact graph: the sum of every node’s price with the plan discount applied exactly as the run applies it — never an under-quote. A plan’s free generations never apply to a chain, so neither this estimate nor the run spends them. Carries no paid gate, the same reasoning as POST /v1/pricing/estimate.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Тело запроса (обязательно)

  • graphobjectобязательноеdocumentIdstringшаблон ^([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)$ · формат uuidresultSelectionmapobject>viewportobjectпосторонние поля не принимаютсяxnumberобязательноеynumberобязательноеzoomnumberобязательноезначение 0.2–2runIdsarray<string>элементов до 100 · элемент: длина 1–100bypassedNodeIdsarray<string>элементов до 30 · элемент: шаблон ^[a-zA-Z0-9_-]{1,32}$nodesarray<один из вариантов>обязательноеэлементов до 30edgesarray<object>обязательноеэлементов до 60idstringобязательноедлина до 64sourcestringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$targetstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$sourceHandlestringдлина до 32targetHandlestringдлина до 32groupsarray<object>элементов до 12titleSizestringsmallmediumlargenodeIdsarray<string>элементов до 30 · элемент: шаблон ^[a-zA-Z0-9_-]{1,32}$idstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$titlestringобязательноедлина до 60xnumberобязательноеynumberобязательноеwidthnumberобязательноезначение 40–8000heightnumberобязательноезначение 40–8000colorstringдлина до 32
  • documentIdstringшаблон ^([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)$ · формат uuid
  • resultSelectionmapobject>
  • viewportobjectпосторонние поля не принимаютсяxnumberобязательноеynumberобязательноеzoomnumberобязательноезначение 0.2–2
  • xnumberобязательное
  • ynumberобязательное
  • zoomnumberобязательноезначение 0.2–2
  • runIdsarray<string>элементов до 100 · элемент: длина 1–100
  • bypassedNodeIdsarray<string>элементов до 30 · элемент: шаблон ^[a-zA-Z0-9_-]{1,32}$
  • nodesarray<один из вариантов>обязательноеэлементов до 30
  • edgesarray<object>обязательноеэлементов до 60idstringобязательноедлина до 64sourcestringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$targetstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$sourceHandlestringдлина до 32targetHandlestringдлина до 32
  • idstringобязательноедлина до 64
  • sourcestringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$
  • targetstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$
  • sourceHandlestringдлина до 32
  • targetHandlestringдлина до 32
  • groupsarray<object>элементов до 12titleSizestringsmallmediumlargenodeIdsarray<string>элементов до 30 · элемент: шаблон ^[a-zA-Z0-9_-]{1,32}$idstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$titlestringобязательноедлина до 60xnumberобязательноеynumberобязательноеwidthnumberобязательноезначение 40–8000heightnumberобязательноезначение 40–8000colorstringдлина до 32
  • titleSizestringsmallmediumlarge
  • nodeIdsarray<string>элементов до 30 · элемент: шаблон ^[a-zA-Z0-9_-]{1,32}$
  • idstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$
  • titlestringобязательноедлина до 60
  • xnumberобязательное
  • ynumberобязательное
  • widthnumberобязательноезначение 40–8000
  • heightnumberобязательноезначение 40–8000
  • colorstringдлина до 32

Ответы

  • 200WorkflowEstimateDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 400ApiErrorRefused with invalid_request.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope, origin_mismatch. Rate-limit headers are absent on origin_mismatch, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

POST/v1/workflows/retry-item

Retry one failed iterator item, or preview its cost first

Требуемые права:workflows:write

action: "preview" prices the retry without spending or claiming an Idempotency-Key; action: "run" requires the header and submits exactly like POST /v1/workflows/runs, answering 202. Every sibling item sharing the same failed iterator retries alongside it.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.
  • Idempotency-KeystringобязательноеRequired on every call; only action: "run" uses it to dedupe a retry.

Тело запроса (обязательно)

  • workflow_idstringобязательное
  • node_keystringобязательноедлина 1–200
  • template_idstringобязательное
  • actionstringобязательноеpreviewrun

Ответы

  • 200WorkflowRetryItemResponseDtoaction: "preview" answers 200; action: "run" answers 202 instead.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 202WorkflowRetryItemResponseDtoA submitted retry (action: "run"), same body shape.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 400ApiErrorRefused with invalid_request.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 402ApiErrorRefused with payment_required, insufficient_credits.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope, moderation_blocked, access_denied, origin_mismatch. Rate-limit headers are absent on origin_mismatch, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 409ApiErrorRefused with resource_conflict.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled, submit_unavailable. Rate-limit headers are absent on api_disabled, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.

GET/v1/workflows/runs

List the caller’s runs

Требуемые права:workflows:read

The caller’s own run history, newest first. Pass next_cursor back as cursor unchanged; it is opaque and must not be parsed. limit defaults to 20 and caps at 100 — over the cap is refused, never clamped.

Параметры запроса

  • cursorstring

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Ответы

  • 200WorkflowRunListDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 400ApiErrorRefused with invalid_limit, invalid_cursor.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

POST/v1/workflows/runs

Run a chain

Требуемые права:workflows:write

Compiles and submits a canvas graph over the shared submit pipeline — the same moderation, reference-trust and money edges POST /v1/generations composes. Root nodes are submitted inline; the rest release as their inputs finish, polled through GET /v1/workflows/runs/{id}.

Idempotency-Key is mandatory and is this run’s durable identity: a replayed key with the same graph answers the first submit’s row without moderating or charging a second time. A closed canvas answers not_found on this route too.

A session may run without an active paid plan; a non-staff key without one answers payment_required — the same split POST /v1/generations enforces.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.
  • Idempotency-KeystringобязательноеCaller-chosen key that makes a retry replay the first run instead of a second one.

Тело запроса (обязательно)

  • graphobjectобязательноеdocumentIdstringшаблон ^([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)$ · формат uuidresultSelectionmapobject>viewportobjectпосторонние поля не принимаютсяxnumberобязательноеynumberобязательноеzoomnumberобязательноезначение 0.2–2runIdsarray<string>элементов до 100 · элемент: длина 1–100bypassedNodeIdsarray<string>элементов до 30 · элемент: шаблон ^[a-zA-Z0-9_-]{1,32}$nodesarray<один из вариантов>обязательноеэлементов до 30edgesarray<object>обязательноеэлементов до 60idstringобязательноедлина до 64sourcestringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$targetstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$sourceHandlestringдлина до 32targetHandlestringдлина до 32groupsarray<object>элементов до 12titleSizestringsmallmediumlargenodeIdsarray<string>элементов до 30 · элемент: шаблон ^[a-zA-Z0-9_-]{1,32}$idstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$titlestringобязательноедлина до 60xnumberобязательноеynumberобязательноеwidthnumberобязательноезначение 40–8000heightnumberобязательноезначение 40–8000colorstringдлина до 32
  • documentIdstringшаблон ^([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)$ · формат uuid
  • resultSelectionmapobject>
  • viewportobjectпосторонние поля не принимаютсяxnumberобязательноеynumberобязательноеzoomnumberобязательноезначение 0.2–2
  • xnumberобязательное
  • ynumberобязательное
  • zoomnumberобязательноезначение 0.2–2
  • runIdsarray<string>элементов до 100 · элемент: длина 1–100
  • bypassedNodeIdsarray<string>элементов до 30 · элемент: шаблон ^[a-zA-Z0-9_-]{1,32}$
  • nodesarray<один из вариантов>обязательноеэлементов до 30
  • edgesarray<object>обязательноеэлементов до 60idstringобязательноедлина до 64sourcestringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$targetstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$sourceHandlestringдлина до 32targetHandlestringдлина до 32
  • idstringобязательноедлина до 64
  • sourcestringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$
  • targetstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$
  • sourceHandlestringдлина до 32
  • targetHandlestringдлина до 32
  • groupsarray<object>элементов до 12titleSizestringsmallmediumlargenodeIdsarray<string>элементов до 30 · элемент: шаблон ^[a-zA-Z0-9_-]{1,32}$idstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$titlestringобязательноедлина до 60xnumberобязательноеynumberобязательноеwidthnumberобязательноезначение 40–8000heightnumberобязательноезначение 40–8000colorstringдлина до 32
  • titleSizestringsmallmediumlarge
  • nodeIdsarray<string>элементов до 30 · элемент: шаблон ^[a-zA-Z0-9_-]{1,32}$
  • idstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$
  • titlestringобязательноедлина до 60
  • xnumberобязательное
  • ynumberобязательное
  • widthnumberобязательноезначение 40–8000
  • heightnumberобязательноезначение 40–8000
  • colorstringдлина до 32
  • template_idstring

Ответы

  • 202WorkflowRunCreatedDtoAccepted. The run exists; Location names where its status will appear.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.LocationstringThe run to poll, as /v1/workflows/runs/{id}.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • LocationstringThe run to poll, as /v1/workflows/runs/{id}.
  • 400ApiErrorRefused with invalid_request.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 402ApiErrorRefused with payment_required, insufficient_credits.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope, moderation_blocked, access_denied, origin_mismatch. Rate-limit headers are absent on origin_mismatch, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 409ApiErrorRefused with resource_conflict.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled, submit_unavailable. Rate-limit headers are absent on api_disabled, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.

GET/v1/workflows/runs/{id}

Read one run

Требуемые права:workflows:read

The run and every node in it, in the same shape a fresh poll or the initial submit answers with. Answers 202 while the run is still RUNNING, 200 once it has settled. A foreign or unknown id answers not_found.

Параметры пути

  • idstringобязательноеThe run id, as published in workflow_id.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Ответы

  • 200WorkflowRunDtoThe run has settled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 202WorkflowRunDtoThe run is still RUNNING; the body is the same shape.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

POST/v1/workflows/runs/{id}/cancel

Cancel a running chain

Требуемые права:workflows:write

Stops every node that has not started yet; a node already dispatched keeps going and still delivers into the caller’s history. Nothing here moves credits — an unstarted node was never charged, so there is nothing to refund. Moves no money, so this route carries no paid gate. A run already settled answers resource_conflict; a foreign or unknown id answers not_found.

Параметры пути

  • idstringобязательноеThe run id.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Ответы

  • 200OkDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope, origin_mismatch. Rate-limit headers are absent on origin_mismatch, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 409ApiErrorRefused with resource_conflict.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

GET/v1/workflows/templates

List the caller’s saved chains

Требуемые права:workflows:read

The caller’s own active chains, newest-updated first, capped rather than paged — up to 50 may exist at once, so next_cursor is always null, the same envelope every capped collection in this API answers with. A closed canvas (role or the environment flag) answers not_found on every route under this prefix, indistinguishable from one that does not exist.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Ответы

  • 200WorkflowTemplateCollectionDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

POST/v1/workflows/templates

Save a new chain

Требуемые права:workflows:write

Stores a canvas document under a title. canvas is carried exactly as the studio’s editor produces it — its own field names are not converted, only the envelope around it is snake_case. A reference inside the graph (an uploaded image or audio file) the caller does not own is refused as invalid_request; the account’s 50-document ceiling, or an id already held in the trash, answers resource_conflict.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Тело запроса (обязательно)

  • idstringшаблон ^([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)$ · формат uuid
  • titlestringобязательноедлина 1–80
  • canvasobjectобязательноеdocumentIdstringшаблон ^([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)$ · формат uuidresultSelectionmapobject>viewportobjectпосторонние поля не принимаютсяxnumberобязательноеynumberобязательноеzoomnumberобязательноезначение 0.2–2runIdsarray<string>элементов до 100 · элемент: длина 1–100bypassedNodeIdsarray<string>элементов до 30 · элемент: шаблон ^[a-zA-Z0-9_-]{1,32}$nodesarray<один из вариантов>обязательноеэлементов до 30edgesarray<object>обязательноеэлементов до 60idstringобязательноедлина до 64sourcestringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$targetstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$sourceHandlestringдлина до 32targetHandlestringдлина до 32groupsarray<object>элементов до 12titleSizestringsmallmediumlargenodeIdsarray<string>элементов до 30 · элемент: шаблон ^[a-zA-Z0-9_-]{1,32}$idstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$titlestringобязательноедлина до 60xnumberобязательноеynumberобязательноеwidthnumberобязательноезначение 40–8000heightnumberобязательноезначение 40–8000colorstringдлина до 32
  • documentIdstringшаблон ^([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)$ · формат uuid
  • resultSelectionmapobject>
  • viewportobjectпосторонние поля не принимаютсяxnumberобязательноеynumberобязательноеzoomnumberобязательноезначение 0.2–2
  • xnumberобязательное
  • ynumberобязательное
  • zoomnumberобязательноезначение 0.2–2
  • runIdsarray<string>элементов до 100 · элемент: длина 1–100
  • bypassedNodeIdsarray<string>элементов до 30 · элемент: шаблон ^[a-zA-Z0-9_-]{1,32}$
  • nodesarray<один из вариантов>обязательноеэлементов до 30
  • edgesarray<object>обязательноеэлементов до 60idstringобязательноедлина до 64sourcestringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$targetstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$sourceHandlestringдлина до 32targetHandlestringдлина до 32
  • idstringобязательноедлина до 64
  • sourcestringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$
  • targetstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$
  • sourceHandlestringдлина до 32
  • targetHandlestringдлина до 32
  • groupsarray<object>элементов до 12titleSizestringsmallmediumlargenodeIdsarray<string>элементов до 30 · элемент: шаблон ^[a-zA-Z0-9_-]{1,32}$idstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$titlestringобязательноедлина до 60xnumberобязательноеynumberобязательноеwidthnumberобязательноезначение 40–8000heightnumberобязательноезначение 40–8000colorstringдлина до 32
  • titleSizestringsmallmediumlarge
  • nodeIdsarray<string>элементов до 30 · элемент: шаблон ^[a-zA-Z0-9_-]{1,32}$
  • idstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$
  • titlestringобязательноедлина до 60
  • xnumberобязательное
  • ynumberобязательное
  • widthnumberобязательноезначение 40–8000
  • heightnumberобязательноезначение 40–8000
  • colorstringдлина до 32

Ответы

  • 201WorkflowTemplateDtoThe chain was stored.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 400ApiErrorRefused with invalid_request.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope, origin_mismatch. Rate-limit headers are absent on origin_mismatch, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 409ApiErrorRefused with resource_conflict.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

GET/v1/workflows/templates/trash

List the caller’s trashed chains

Требуемые права:workflows:read

Chains archived rather than deleted, newest-deleted first. Pass next_cursor back as cursor unchanged; it is opaque and must not be parsed. limit defaults to 20 and caps at 100 — over the cap is refused, never clamped.

Параметры запроса

  • cursorstring

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Ответы

  • 200WorkflowTrashCollectionDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 400ApiErrorRefused with invalid_limit, invalid_cursor.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

DELETE/v1/workflows/templates/trash

Permanently delete one trashed chain

Требуемые права:workflows:write

Purges a chain already in the trash — its versions and prompt history are removed with it. Only a trashed id qualifies; an active chain’s id, like a foreign or unknown one, answers not_found.

Параметры запроса

  • idstringобязательное

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Ответы

  • 200OkDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 400ApiErrorRefused with invalid_request.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope, origin_mismatch. Rate-limit headers are absent on origin_mismatch, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

GET/v1/workflows/templates/{id}

Read one chain

Требуемые права:workflows:read

The stored canvas document in full. A foreign id answers not_found rather than a refusal that would confirm it exists.

Параметры пути

  • idstringобязательноеThe chain id, as published in data[].id.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Ответы

  • 200WorkflowTemplateDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

PATCH/v1/workflows/templates/{id}

Update one chain

Требуемые права:workflows:write

Renames it, replaces its canvas, or both. expected_revision is mandatory: it must match the chain’s current revision, or the write is refused as revision_conflict rather than silently overwriting a change made from another tab or device. A no-op write (nothing actually differs) still answers 200 without bumping the revision.

Параметры пути

  • idstringобязательноеThe chain id.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Тело запроса (обязательно)

  • expected_revisionintegerобязательноезначение 0–2147483647
  • titlestringдлина 1–80
  • canvasobjectdocumentIdstringшаблон ^([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)$ · формат uuidresultSelectionmapobject>viewportobjectпосторонние поля не принимаютсяxnumberобязательноеynumberобязательноеzoomnumberобязательноезначение 0.2–2runIdsarray<string>элементов до 100 · элемент: длина 1–100bypassedNodeIdsarray<string>элементов до 30 · элемент: шаблон ^[a-zA-Z0-9_-]{1,32}$nodesarray<один из вариантов>обязательноеэлементов до 30edgesarray<object>обязательноеэлементов до 60idstringобязательноедлина до 64sourcestringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$targetstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$sourceHandlestringдлина до 32targetHandlestringдлина до 32groupsarray<object>элементов до 12titleSizestringsmallmediumlargenodeIdsarray<string>элементов до 30 · элемент: шаблон ^[a-zA-Z0-9_-]{1,32}$idstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$titlestringобязательноедлина до 60xnumberобязательноеynumberобязательноеwidthnumberобязательноезначение 40–8000heightnumberобязательноезначение 40–8000colorstringдлина до 32
  • documentIdstringшаблон ^([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)$ · формат uuid
  • resultSelectionmapobject>
  • viewportobjectпосторонние поля не принимаютсяxnumberобязательноеynumberобязательноеzoomnumberобязательноезначение 0.2–2
  • xnumberобязательное
  • ynumberобязательное
  • zoomnumberобязательноезначение 0.2–2
  • runIdsarray<string>элементов до 100 · элемент: длина 1–100
  • bypassedNodeIdsarray<string>элементов до 30 · элемент: шаблон ^[a-zA-Z0-9_-]{1,32}$
  • nodesarray<один из вариантов>обязательноеэлементов до 30
  • edgesarray<object>обязательноеэлементов до 60idstringобязательноедлина до 64sourcestringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$targetstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$sourceHandlestringдлина до 32targetHandlestringдлина до 32
  • idstringобязательноедлина до 64
  • sourcestringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$
  • targetstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$
  • sourceHandlestringдлина до 32
  • targetHandlestringдлина до 32
  • groupsarray<object>элементов до 12titleSizestringsmallmediumlargenodeIdsarray<string>элементов до 30 · элемент: шаблон ^[a-zA-Z0-9_-]{1,32}$idstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$titlestringобязательноедлина до 60xnumberобязательноеynumberобязательноеwidthnumberобязательноезначение 40–8000heightnumberобязательноезначение 40–8000colorstringдлина до 32
  • titleSizestringsmallmediumlarge
  • nodeIdsarray<string>элементов до 30 · элемент: шаблон ^[a-zA-Z0-9_-]{1,32}$
  • idstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$
  • titlestringобязательноедлина до 60
  • xnumberобязательное
  • ynumberобязательное
  • widthnumberобязательноезначение 40–8000
  • heightnumberобязательноезначение 40–8000
  • colorstringдлина до 32

Ответы

  • 200WorkflowTemplatePatchDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 400ApiErrorRefused with invalid_request.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope, origin_mismatch. Rate-limit headers are absent on origin_mismatch, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 409ApiErrorRefused with revision_conflict.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

DELETE/v1/workflows/templates/{id}

Move one chain to the trash

Требуемые права:workflows:write

A soft delete: the chain, its versions and its prompt history all stay recoverable through POST /v1/workflows/templates/{id}/restore until it is purged from the trash.

Параметры пути

  • idstringобязательноеThe chain id.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Ответы

  • 200OkDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope, origin_mismatch. Rate-limit headers are absent on origin_mismatch, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

GET/v1/workflows/templates/{id}/prompt-history

Read one prompt node’s text history

Требуемые права:workflows:read

Every distinct version a prompt node’s text (and its variable bindings) has gone through, newest first. before pages further back by revision; next_before is the value to send next, or null once the history is exhausted.

Параметры пути

  • idstringобязательноеThe chain id.

Параметры запроса

  • node_idstringобязательноешаблон ^[a-zA-Z0-9_-]{1,32}$
  • beforestringшаблон ^\d+$

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Ответы

  • 200WorkflowPromptHistoryPageDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 400ApiErrorRefused with invalid_request.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 422ApiErrorRefused with unreadable_record.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

POST/v1/workflows/templates/{id}/restore

Restore one chain out of the trash

Требуемые права:workflows:write

Undoes DELETE /v1/workflows/templates/{id}. Refused as resource_conflict when the account is already at its 50-active-chain ceiling — restore the chain after archiving another, or delete something permanently first.

Параметры пути

  • idstringобязательноеThe chain id.

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Ответы

  • 200WorkflowTemplateRestoreDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope, origin_mismatch. Rate-limit headers are absent on origin_mismatch, which is refused before the limiter runs.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 409ApiErrorRefused with resource_conflict.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

GET/v1/workflows/templates/{id}/versions

List or read a chain’s saved revisions

Требуемые права:workflows:read

Without revision: the lightweight list of every kept revision, newest first, capped at 50. With it: that one revision in full, canvas included. An id belonging to another account, or a revision this chain never had, both answer not_found.

Параметры пути

  • idstringобязательноеThe chain id.

Параметры запроса

  • revisionstringшаблон ^\d+$

Заголовки

  • X-Request-IdstringCorrelation id to carry through logs; generated when absent.

Ответы

  • 200WorkflowTemplateVersionsResponseDtoSuccess.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 401ApiErrorRefused with unauthorized, invalid_api_key, api_key_expired, api_key_revoked, invalid_token.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 403ApiErrorRefused with api_access_not_granted, account_suspended, legal_consent_required, insufficient_scope.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 404ApiErrorRefused with not_found.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 413ApiErrorRefused with request_too_large.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 429ApiErrorRefused with rate_limited.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • Retry-AfterintegerSeconds to wait before retrying, on a refusal that names a window.
  • 500ApiErrorRefused with internal_error.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.RateLimitstringThe window that bound this request, as "";r=;t=.RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • RateLimitstringThe window that bound this request, as "";r=;t=.
  • RateLimit-PolicystringThe quota and window of that policy, as "";q=;w=.
  • 503ApiErrorRefused with api_disabled.X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.
  • X-Request-IdstringThe correlation id of this request, echoed back whether the caller supplied it or not.

Схемы

Каждая ссылка на тип в разделах выше ведёт сюда. Поля перечислены так, как их публикует документ.

ApiError

посторонние поля не принимаются

  • errorobjectобязательноепосторонние поля не принимаютсяcodestringобязательноеapi_disabledunauthorizedinvalid_api_keyapi_key_expiredapi_key_revokedinvalid_tokenapi_access_not_grantedaccount_suspendedaccess_deniedlegal_consent_requiredorigin_mismatchinsufficient_scopepayment_requiredinsufficient_creditsinsufficient_text_creditscontext_limit_exceededduplicate_submissionduplicate_key_conflictmoderation_blockedsubmit_unavailableupload_unavailableestimate_unavailablekey_spend_limit_reachedgrant_spend_limit_reachedgeneration_frozengeneration_in_flightgeneration_already_settledreport_replay_mismatchsupport_replay_mismatchfolder_limit_reachedfolder_name_takennot_foundunreadable_recordrevision_conflictresource_conflictgoneplan_expiredrenewal_already_onno_active_plansubscription_not_linkedcard_token_missingcheckout_in_progresssubscription_supersededsubscription_recancelledsubscription_resume_failedsubscription_cancel_failedsubscription_cancel_unsavedcard_change_unavailablecard_check_not_authorizedcard_change_in_progresscard_change_failedrate_limitedtoo_many_streamsrequest_too_largeinternal_errorservice_unavailablerequest_abortedinvalid_requestinvalid_limitinvalid_cursormessagestringобязательноеuser_messagestringобязательноеrequest_idstringобязательноеdetailsarray<ApiErrorDetail>
  • codestringобязательноеapi_disabledunauthorizedinvalid_api_keyapi_key_expiredapi_key_revokedinvalid_tokenapi_access_not_grantedaccount_suspendedaccess_deniedlegal_consent_requiredorigin_mismatchinsufficient_scopepayment_requiredinsufficient_creditsinsufficient_text_creditscontext_limit_exceededduplicate_submissionduplicate_key_conflictmoderation_blockedsubmit_unavailableupload_unavailableestimate_unavailablekey_spend_limit_reachedgrant_spend_limit_reachedgeneration_frozengeneration_in_flightgeneration_already_settledreport_replay_mismatchsupport_replay_mismatchfolder_limit_reachedfolder_name_takennot_foundunreadable_recordrevision_conflictresource_conflictgoneplan_expiredrenewal_already_onno_active_plansubscription_not_linkedcard_token_missingcheckout_in_progresssubscription_supersededsubscription_recancelledsubscription_resume_failedsubscription_cancel_failedsubscription_cancel_unsavedcard_change_unavailablecard_check_not_authorizedcard_change_in_progresscard_change_failedrate_limitedtoo_many_streamsrequest_too_largeinternal_errorservice_unavailablerequest_abortedinvalid_requestinvalid_limitinvalid_cursor
  • messagestringобязательное
  • user_messagestringобязательное
  • request_idstringобязательное
  • detailsarray<ApiErrorDetail>

ApiErrorDetail

посторонние поля не принимаются

  • fieldstringобязательное
  • reasonstringобязательноеwrong_typenot_allowedbad_formatout_of_rangeunknown_fieldduplicateinvalidrequiredin_useexceededrequest_ratesubmit_rateconcurrencyqueue_fullnot_availableunknown_modelunsupported_modelunsupported_resolutionunsupported_durationunsupported_aspectunsupported_qualityunsupported_scaleunsupported_n_variantstransparency_not_supportedprompt_too_longimage_requiredtoo_many_imagesrefusedextend_not_foundextend_unavailabledraft_missingdraft_not_founddraft_wrong_modeldraft_not_readydraft_cache_missingdraft_expireddraft_facts_missinguntrusted_referenceinvalid_graphinsufficient_creditsforeign_referencereference_unavailableunfetchable_reference
  • messagestringобязательное
  • port_idstring
  • user_messagestring
  • required_ccintegerзначение -9007199254740991–9007199254740991
  • balance_ccintegerзначение -9007199254740991–9007199254740991
  • suggested_topup_ccintegerзначение -9007199254740991–9007199254740991
  • confirm_tokenstring
  • scopestring
  • limitintegerзначение -9007199254740991–9007199254740991
  • currentintegerзначение -9007199254740991–9007199254740991
  • retry_after_secondsintegerзначение -9007199254740991–9007199254740991

BillingSubscriptionDto

посторонние поля не принимаются

CardChangeBeginDto

посторонние поля не принимаются

  • payment_idstringобязательноеThe 1 RUB card-check payment; it is the widget invoiceId.
  • public_idstringобязательноеThe payment terminal public id.
  • account_idstringобязательноеThe widget accountId: the caller.
  • emailstringnullобязательное
  • amountnumberобязательноеAlways 1: the check is authorized, never charged.
  • currencyRUBобязательное

CardChangeCompleteDto

посторонние поля не принимаются

  • okbooleanобязательное
  • cardobject | nullобязательноеThe card the subscription renews on from now.last4stringобязательноеbrandstringnullобязательноеbankstringnullобязательное
  • last4stringобязательное
  • brandstringnullобязательное
  • bankstringnullобязательное
  • next_pay_datestringnullобязательное
  • chargestringобязательноеWhether an overdue period was charged on the new card: none when nothing was due.nonecompleteddeclinedunknown
  • resumedbooleanобязательноеTrue when renewal was off: the new card also turned it back on, charging from next_pay_date.

CreditTransactionCollectionDto

посторонние поля не принимаются

  • dataarray<CreditTransactionDto>обязательное
  • next_cursorstringnullобязательное

CreditTransactionDto

посторонние поля не принимаются

  • idstringобязательное
  • typestringобязательноеThe transaction kind, lowercased from the stored enum.purchasespendrefundadjustmentreferral_exchangeteam_transfer
  • amount_ccintegerобязательноеSigned centi-credits: positive credits the balance, negative debits it.значение -9007199254740991–9007199254740991
  • created_atstringобязательное
  • generation_idstringnullобязательноеThe id GET /v1/generations/{id} accepts, or null for a row with no link — including history written before the link existed.
  • reasonstring | nullобязательноеA closed machine vocabulary derived from the internal ledger meta; null when none applies.plan_expired_frozenplan_lost_frozencredits_unfrozenplan_refund_revokedtext_balance_moveupgrade_clawbackchat_estimate_holdchat_overflow_chargechat_overage_settledchat_compress_holdchat_compress_settledchat_compress_refundteam_transfer_inteam_transfer_outrecurring_payment

EventStreamResetDto

The presented Last-Event-ID cannot be resumed: it is past the retention window (cursor_expired) or is not a cursor of this stream (cursor_unknown). The stream continues live after this frame; catch up on the transitions in between with the batch status endpoint named in catch_up.

посторонние поля не принимаются

  • reasonstringобязательноеcursor_expiredcursor_unknown
  • catch_up/v1/generations/statusобязательное

FailureReason

string

provider_errormoderation_blocktimeoutno_contentinvalid_inputunknown

FreeQuotaConfigDto

посторонние поля не принимаются

  • resolutionarray<string>
  • durationnumber
  • duration_maxnumber
  • soundboolean

FreeQuotaDto

посторонние поля не принимаются

  • modelstringобязательное
  • typestringобязательное
  • modestringобязательноеcountedtimedunlimited
  • limitnumber
  • usednumber
  • remainingnumber
  • unlimited_expires_atstring
  • daily_capnumber
  • daily_usednumber
  • fallback_modelstring
  • free_configFreeQuotaConfigDto

GenerationCancelDto

посторонние поля не принимаются

  • refundedbooleanобязательное

GenerationCollectionDto

посторонние поля не принимаются

  • dataarray<GenerationDto>обязательное
  • next_cursorstringnullобязательное

GenerationDto

посторонние поля не принимаются

  • idstringобязательное
  • typestringобязательное
  • statusGenerationStatusобязательное
  • model_idstringnullобязательное
  • titlestringnullобязательное
  • promptstringnullобязательное
  • stylestringnullобязательное
  • input_textstringnullобязательное
  • folder_idstringnullобязательное
  • cost_ccnumberобязательное
  • refundedbooleanобязательное
  • created_atstringобязательное
  • updated_atstringобязательное
  • completed_atstringnullобязательное
  • output_urlsNormalizedOutputобязательное
  • errorGenerationErrorDto

GenerationErrorDto

посторонние поля не принимаются

  • reasonFailureReasonобязательное
  • messagestringобязательное
  • user_messagestringобязательное

GenerationEventDto

One status transition. Re-read the full record via GET /v1/generations/{id} or POST /v1/generations/status.

посторонние поля не принимаются

  • idstringобязательноеThe generation id.
  • typestringобязательноеThe generation type, the same value GET /v1/generations/{id} returns.
  • statusGenerationStatusобязательное
  • deletedbooleanобязательноеTrue once the generation is withdrawn. A cancelled generation arrives as status FAILED with deleted true.
  • updated_atstringобязательноеWhen this transition was recorded, ISO 8601.

GenerationReportDto

посторонние поля не принимаются

  • support_request_idstringобязательное
  • message_idstringобязательное

GenerationStatus

DONE is the only status that never changes again. FAILED ends the attempt, not the record: a late provider answer can recover such a generation into DONE, so a caller that still wants the result re-reads the row later instead of polling on.

string

QUEUEDPENDINGRUNNINGMODERATION_PENDINGDONEFAILED

GenerationStatusCollectionDto

посторонние поля не принимаются

  • dataarray<GenerationDto>обязательное
  • next_cursornullобязательное

KnowledgeArticleDto

посторонние поля не принимаются

  • slugstringобязательное
  • titlestringобязательное
  • summarystringnullобязательное
  • langstringобязательноеenru
  • sourcestringобязательноеarticleguide
  • bodystringобязательное
  • updated_atstringобязательное
  • valid_untilstringnullобязательное

KnowledgeCollectionDto

посторонние поля не принимаются

  • dataarray<KnowledgeHitDto>обязательное
  • next_cursornullобязательное

KnowledgeHitDto

посторонние поля не принимаются

  • slugstringобязательное
  • titlestringобязательное
  • summarystringnullобязательное
  • langstringобязательноеenru
  • sourcestringобязательноеarticleguide

LibraryAssetCollectionDto

посторонние поля не принимаются

  • dataarray<LibraryAssetDto>обязательное
  • next_cursorstringnullобязательное

LibraryAssetDto

посторонние поля не принимаются

  • idstringобязательное
  • kindstringобязательное
  • titlestringnullобязательное
  • widthnumbernullобязательное
  • heightnumbernullобязательное
  • duration_secnumbernullобязательное
  • folder_idstringnullобязательное
  • created_atstringобязательное
  • expires_atstringnullобязательное
  • output_urlsobjectобязательноепосторонние поля не принимаютсяimagearray<string>videoarray<string>audioarray<string>downloadarray<string>
  • imagearray<string>
  • videoarray<string>
  • audioarray<string>
  • downloadarray<string>

LibraryFolderCollectionDto

посторонние поля не принимаются

  • dataarray<LibraryFolderDto>обязательное
  • next_cursornullобязательное

LibraryFolderDto

посторонние поля не принимаются

  • idstringобязательное
  • namestringобязательное
  • positionnumberобязательное
  • created_atstringобязательное

LibraryFolderWriteDto

посторонние поля не принимаются

  • idstringобязательное
  • namestring
  • positionnumber

LibraryMoveDto

посторонние поля не принимаются

  • movednumberобязательное

LibraryRenameDto

посторонние поля не принимаются

  • idstringобязательное
  • titlestringnullобязательное

MeCreditsDto

посторонние поля не принимаются

  • main_ccnumberобязательное
  • frozen_ccnumberобязательное
  • text_ccnumberобязательное

MeDto

посторонние поля не принимаются

  • user_idstringобязательное
  • planMePlanDtoобязательное
  • creditsMeCreditsDtoобязательное
  • free_quotasarray<FreeQuotaDto>обязательное
  • limitsobjectобязательноепосторонние поля не принимаютсяrequestsobjectобязательноепосторонние поля не принимаютсяper_credentialintegerобязательноезначение -9007199254740991–9007199254740991per_accountintegerобязательноезначение -9007199254740991–9007199254740991window_secondsintegerобязательноезначение -9007199254740991–9007199254740991submissionsobjectобязательноепосторонние поля не принимаютсяapiintegerобязательноезначение -9007199254740991–9007199254740991studiointegerобязательноезначение -9007199254740991–9007199254740991window_secondsintegerобязательноезначение -9007199254740991–9007199254740991concurrencyobjectобязательноепосторонние поля не принимаютсяimageintegerобязательноезначение -9007199254740991–9007199254740991videointegerобязательноезначение -9007199254740991–9007199254740991klingintegerобязательноезначение -9007199254740991–9007199254740991veointegerобязательноезначение -9007199254740991–9007199254740991
  • requestsobjectобязательноепосторонние поля не принимаютсяper_credentialintegerобязательноезначение -9007199254740991–9007199254740991per_accountintegerобязательноезначение -9007199254740991–9007199254740991window_secondsintegerобязательноезначение -9007199254740991–9007199254740991
  • per_credentialintegerобязательноезначение -9007199254740991–9007199254740991
  • per_accountintegerобязательноезначение -9007199254740991–9007199254740991
  • window_secondsintegerобязательноезначение -9007199254740991–9007199254740991
  • submissionsobjectобязательноепосторонние поля не принимаютсяapiintegerобязательноезначение -9007199254740991–9007199254740991studiointegerобязательноезначение -9007199254740991–9007199254740991window_secondsintegerобязательноезначение -9007199254740991–9007199254740991
  • apiintegerобязательноезначение -9007199254740991–9007199254740991
  • studiointegerобязательноезначение -9007199254740991–9007199254740991
  • window_secondsintegerобязательноезначение -9007199254740991–9007199254740991
  • concurrencyobjectобязательноепосторонние поля не принимаютсяimageintegerобязательноезначение -9007199254740991–9007199254740991videointegerобязательноезначение -9007199254740991–9007199254740991klingintegerобязательноезначение -9007199254740991–9007199254740991veointegerобязательноезначение -9007199254740991–9007199254740991
  • imageintegerобязательноезначение -9007199254740991–9007199254740991
  • videointegerобязательноезначение -9007199254740991–9007199254740991
  • klingintegerобязательноезначение -9007199254740991–9007199254740991
  • veointegerобязательноезначение -9007199254740991–9007199254740991

MePlanDto

посторонние поля не принимаются

  • idstringобязательное
  • started_atstringnullобязательное
  • ends_atstringnullобязательное
  • cancel_atstringnullобязательное

MediaContent

string

ModelCollectionDto

посторонние поля не принимаются

  • dataarray<ModelDto>обязательное
  • next_cursorstringnullобязательное

ModelConstraints

посторонние поля не принимаются

  • image_inputstringобязательноеnoneoptionalrequired
  • min_reference_imagesnumberобязательное
  • max_reference_imagesnumber
  • requires_promptbooleanобязательное
  • requires_videobooleanобязательное
  • requires_audiobooleanобязательное
  • accepts_video_refbooleanобязательное
  • video_ref_satisfies_imageboolean
  • creator_onlybooleanобязательное
  • aspect_ratiosarray<string>The values the request field aspect accepts.
  • resolutionsarray<string>
  • durationsarray<string>
  • default_durationnumber
  • duration_from_sourceboolean
  • duration_minnumber
  • duration_maxnumber
  • fixed_durationstring
  • resolution_durationsmaparray<string>>
  • default_resolutionstring
  • resolution_paramstring
  • resolution_valuesmapstring>
  • has_soundboolean
  • sound_from_sourceboolean
  • default_soundboolean
  • max_video_refsnumber
  • max_audio_refsnumber
  • voicesarray<string>The values the request field referenceAudio accepts.
  • max_voicesnumberHow many entries referenceAudio takes; a voice-tagging model binds them to @voice1… in order.
  • max_references_totalnumberReference images, clips and voices together: refused past this even when each kind is inside its own cap.
  • audio_min_secnumber
  • audio_max_secnumber
  • ref_video_min_secnumber
  • ref_video_max_secnumber
  • ref_video_total_max_secnumber
  • ref_video_min_dimensionnumber
  • ref_video_min_framesnumber
  • ref_video_max_bytesnumber
  • ref_audio_total_max_secnumber
  • ref_task_typesarray<string>
  • ref_video_min_sec_by_taskmapnumber>
  • multi_shotMultiShotConstraint
  • prompt_expansion_modesarray<string>
  • default_prompt_expansionstring
  • has_seedboolean
  • has_negative_promptboolean
  • negative_prompt_limitnumber
  • has_variantsboolean
  • max_variantsnumber
  • max_style_refsnumber
  • max_char_refsnumber
  • prompt_limitnumber
  • image_ref_mention_limitnumber
  • prompt_paramstring
  • prompt_minnumber
  • transparent_backgroundboolean
  • fixed_qualitystringlowmediumhigh
  • qualitiesarray<string>
  • default_qualitystring
  • formatsarray<string>
  • generate_typesarray<string>
  • materialsarray<string>
  • mesh_modesarray<string>
  • input_kindstringportraitvideo
  • fixed_durationsarray<number>
  • scalesarray<number>The values the request field scale accepts.
  • source_kindstringThe medium an upscaler's source must be. It rides in source_param, not among the references.imagevideo
  • source_paramimage_urlThe request field an upscaler's source is read from.
  • source_max_widthnumberThe widest source frame accepted, in pixels.
  • source_max_heightnumberThe tallest source frame accepted, in pixels.
  • source_max_secnumberThe longest source clip accepted, in seconds.
  • output_max_pixel_framesnumberThe largest upscaled clip delivered, as output width × height × frame rate × seconds; a longer source is refused before any charge.

ModelDto

посторонние поля не принимаются

  • idstringобязательное
  • namestringобязательное
  • typestringобязательное
  • submit_typestringобязательное
  • constraintsModelConstraintsобязательное
  • pricingModelPricingDtoобязательное

ModelPricingDto

посторонние поля не принимаются

  • currencycreditsобязательное
  • variantsarray<PriceVariantDto>обязательное
  • quoteestimatePresent when the charge is measured from the source rather than read off a rate — an upscaler bills the output size and length the server measures. variants is then empty, and POST /v1/pricing/estimate with the full request is the price.
  • surchargesarray<PriceSurchargeDto>обязательное
  • minimum_ccnumber
  • free_lead_secondsnumber
  • amount_roundingceil_ccобязательное
  • variant_selectionceil_to_variant
  • discount_pctnumber

MultiShotConstraint

посторонние поля не принимаются

  • transportstringобязательноеapiprompt-timecodes
  • total_min_secnumberобязательное
  • total_max_secnumberобязательное
  • max_shotsnumberобязательное
  • shot_prompt_limitnumberобязательное
  • silentboolean
  • text_onlyboolean

NormalizedOutput

посторонние поля не принимаются

  • audioarray<string>
  • downloadarray<string>
  • wavarray<string>
  • imagearray<string>
  • videoarray<string>
  • model3darray<string>
  • originalarray<string>

OAuthInteractionDetailsDto

посторонние поля не принимаются

  • promptstringобязательноеloginconsent
  • clientobjectобязательноепосторонние поля не принимаютсяidstringобязательноеnamestringобязательноеhoststringобязательное
  • idstringобязательное
  • namestringобязательное
  • hoststringобязательное
  • scopesarray<string>обязательное
  • monthly_spend_limitinteger | nullобязательное

OAuthInteractionRedirectDto

посторонние поля не принимаются

  • redirect_tostringобязательное

OkDto

посторонние поля не принимаются

  • okbooleanобязательное

PriceSurchargeDto

посторонние поля не принимаются

  • kindstringобязательное
  • variantstringобязательное
  • price_ccnumberобязательное
  • unitPriceUnitобязательное
  • roundingstringceil_per_itemceil_total
  • free_unitsintegerзначение больше 0 · значение до 9007199254740991

PriceUnit

string

per_secondper_videoper_imageper_generationper_1000_charactersper_reference_secondper_reference_image

PriceVariantDto

посторонние поля не принимаются

  • variantstringобязательное
  • price_ccnumberобязательное
  • unitPriceUnitобязательное

PricingEstimateBreakdownDto

посторонние поля не принимаются

  • variantstringnullобязательное
  • unitsnumberобязательное
  • surcharge_ccnumberобязательное

PricingEstimateDto

посторонние поля не принимаются

  • typestringобязательноеvideoimageupscale3dcard-designlipsyncomnihumanavatarvoicemusicmusic-covermusic-vocalsmusic-instrumentalmusic-stemssonglyrics
  • model_idstringобязательное
  • currencycreditsобязательное
  • price_ccnumberобязательное
  • breakdownPricingEstimateBreakdownDtoобязательное

SubscriptionCancelDto

посторонние поля не принимаются

  • okbooleanобязательное
  • supersededbooleanобязательноеTrue when a newer subscription already renews the plan, so nothing is ending.
  • plan_ends_atstringnullобязательноеThe end of the paid period the plan now runs out at, ISO 8601.

SubscriptionDto

Amounts are whole units of currency, not centi-credits.

посторонние поля не принимаются

  • statusstringобязательноеactivepast_due
  • amountintegerобязательноезначение -9007199254740991–9007199254740991
  • recurrent_amountinteger | nullобязательное
  • currencystringобязательное
  • next_payment_atstringnullобязательное
  • cancelled_atstringnullобязательное

SubscriptionResumeDto

посторонние поля не принимаются

  • okbooleanобязательное
  • next_pay_datestringобязательноеWhen the renewed subscription charges next, ISO 8601.

SupportMessageCollectionDto

посторонние поля не принимаются

  • dataarray<SupportMessageDto>обязательное
  • next_cursornullобязательное

SupportMessageDto

посторонние поля не принимаются

  • idstringобязательное
  • fromstringобязательноеusersupport
  • textstringобязательноеAs authored by the user or by support staff, never translated or rewritten.
  • imagesarray<string>обязательное
  • created_atstringобязательное

SupportMessageSentDto

посторонние поля не принимаются

  • support_request_idstringобязательное
  • messageSupportMessageDtoобязательное

UploadStoredDto

посторонние поля не принимаются

  • referencestringобязательное
  • bytes_storedintegerобязательноезначение 0–9007199254740991

UploadTicketDto

посторонние поля не принимаются

  • urlstringобязательное
  • headersmapstring>обязательноеFor the direct PUT to url: send every entry back verbatim — Content-Type, Content-Length and If-None-Match, all bound by the signature, so composing your own set or dropping one is a 403 from the store. The proxy_path completion does not take this map; it reads Content-Type and Content-Length and needs your Authorization.
  • referencestringобязательное
  • proxy_pathstringобязательное
  • expires_atstringобязательное

WhoamiDto

посторонние поля не принимаются

  • user_idstringобязательное
  • rolestringобязательное
  • channelstringобязательноеsessionapi_keyoauthbot
  • key_idstringnullобязательноеThe API key or OAuth grant that authenticated the call; null on the session channel — read channel to tell which.
  • scopesarray<string>обязательноетолько для чтенияme:readmodels:readgenerations:readgenerations:writelibrary:readlibrary:writebilling:readsupport:readsupport:writeuploads:writeworkflows:readworkflows:write
  • may_spendbooleanобязательноеWhether this caller may start generations right now. False when the account holds no active paid plan: every new generation is then refused with payment_required, free quotas and promo modes included, while an exact retry of an Idempotency-Key already answered still returns its stored response. Always true on the session channel and for staff.
  • spend_limitWhoamiSpendLimitDto | nullобязательное

WhoamiSpendLimitDto

посторонние поля не принимаются

  • monthly_limit_ccnumbernullобязательное
  • spent_ccnumberобязательное
  • remaining_ccnumbernullобязательное
  • resets_atstringобязательное

WorkflowBlockCollectionDto

посторонние поля не принимаются

WorkflowBlockDto

посторонние поля не принимаются

  • idstringобязательное
  • titlestringобязательное
  • descriptionstringобязательное
  • canvasobjectобязательноеThe canvas document exactly as stored — its own field names are the studio’s camelCase, never converted.
  • revisionnumberобязательное
  • updated_atstringобязательное

WorkflowBlockGetDto

посторонние поля не принимаются

WorkflowBlockMutationDto

посторонние поля не принимаются

WorkflowBlockSummaryDto

посторонние поля не принимаются

  • idstringобязательное
  • titlestringобязательное
  • descriptionstringобязательное
  • revisionnumberобязательное
  • updated_atstringобязательное

WorkflowBlockVersionEntryDto

посторонние поля не принимаются

  • revisionnumberобязательное
  • titlestringобязательное
  • created_atstringобязательное

WorkflowCompileErrorDto

посторонние поля не принимаются

  • messagestringобязательное
  • node_idstring
  • port_idstring

WorkflowEstimateDto

посторонние поля не принимаются

  • per_nodemapnumber>обязательное
  • item_countsmapnumber>обязательное
  • totalnumberобязательное
  • price_basismapstring>

WorkflowPromptHistoryEntryDto

посторонние поля не принимаются

  • revisionnumberобязательное
  • created_atstringобязательное
  • promptstringобязательное
  • variablesarray<object>обязательноеidstringобязательноеlabelstringобязательное
  • idstringобязательное
  • labelstringобязательное
  • bindingsarray<object>обязательноеsourcestringобязательноеsource_handlestringtarget_handlestring
  • sourcestringобязательное
  • source_handlestring
  • target_handlestring
  • resolvedstring
  • resolution_errorstring

WorkflowPromptHistoryPageDto

посторонние поля не принимаются

WorkflowRetryItemResponseDto

один из вариантов

WorkflowRetryPreviewDto

посторонние поля не принимаются

  • kindpreviewобязательное
  • totalnumberобязательное
  • stepsnumberобязательное
  • node_idsarray<string>обязательное
  • input_kindstringобязательноеparametersprompt
  • promptstringобязательное
  • item_indexnumberобязательное

WorkflowRetryRunDto

посторонние поля не принимаются

  • kindrunобязательное
  • workflow_idstringобязательное
  • total_costnumberобязательное

WorkflowRunCanvasItemDto

посторонние поля не принимаются

  • node_idstringобязательное
  • iterator_idstringобязательное
  • item_idstringобязательное
  • item_indexnumberобязательное
  • item_countnumberобязательное

WorkflowRunCreatedDto

посторонние поля не принимаются

  • workflow_idstringобязательное
  • total_costnumberобязательное

WorkflowRunDto

посторонние поля не принимаются

  • idstringобязательное
  • client_request_idstringnullобязательное
  • recipe_idstringобязательное
  • retry_ofobjectпосторонние поля не принимаютсяworkflow_idstringобязательноеnode_keystringобязательное
  • workflow_idstringобязательное
  • node_keystringобязательное
  • statusstringобязательное
  • total_cost_estimatenumberобязательное
  • errorstringnullобязательное
  • created_atstringобязательное
  • nodesarray<WorkflowRunNodeDto>обязательное

WorkflowRunListDto

посторонние поля не принимаются

  • dataarray<WorkflowRunDto>обязательное
  • next_cursorstringnullобязательное

WorkflowRunNodeDto

посторонние поля не принимаются

  • node_keystringобязательное
  • canvas_itemWorkflowRunCanvasItemDto
  • kindstringобязательное
  • model_labelstringобязательное
  • statusstringобязательное
  • generation_statusstringnullобязательное
  • generation_idstringnullобязательное
  • parametersmapobject>обязательное
  • created_atstringобязательное
  • promptstringобязательное
  • frozenbooleanобязательное
  • waitobjectпосторонние поля не принимаютсяreasonmodel-capобязательноеlimitnumberобязательное
  • reasonmodel-capобязательное
  • limitnumberобязательное
  • cost_creditsnumberобязательное
  • errorstringnullобязательное
  • output_urlsobject | nullобязательноеaudioarray<string>downloadarray<string>wavarray<string>imagearray<string>videoarray<string>model3darray<string>originalarray<string>
  • audioarray<string>
  • downloadarray<string>
  • wavarray<string>
  • imagearray<string>
  • videoarray<string>
  • model3darray<string>
  • originalarray<string>

WorkflowTemplateCollectionDto

посторонние поля не принимаются

WorkflowTemplateDto

посторонние поля не принимаются

  • idstringобязательное
  • titlestringобязательное
  • canvasobjectобязательноеThe canvas document exactly as stored — its own field names are the studio’s camelCase, never converted.
  • revisionnumberобязательное
  • updated_atstringобязательное

WorkflowTemplatePatchDto

посторонние поля не принимаются

  • idstringобязательное
  • titlestringобязательное
  • revisionnumberобязательное

WorkflowTemplateRestoreDto

посторонние поля не принимаются

WorkflowTemplateSummaryDto

посторонние поля не принимаются

  • idstringобязательное
  • titlestringобязательное
  • updated_atstringобязательное
  • node_countnumberобязательное
  • countsobjectобязательноепосторонние поля не принимаютсяcharacternumberобязательноеimagenumberобязательноеvideonumberобязательноеaudionumberобязательное
  • characternumberобязательное
  • imagenumberобязательное
  • videonumberобязательное
  • audionumberобязательное
  • sketchobjectобязательноепосторонние поля не принимаютсяnodesarray<object>обязательноеidstringобязательноеkindstringобязательноеimagevideotextsoundtoolxnumberобязательноеynumberобязательноеwnumberобязательноеhnumberобязательноеimagestringedgesarray<object>обязательноеfromstringобязательноеtostringобязательное
  • nodesarray<object>обязательноеidstringобязательноеkindstringобязательноеimagevideotextsoundtoolxnumberобязательноеynumberобязательноеwnumberобязательноеhnumberобязательноеimagestring
  • idstringобязательное
  • kindstringобязательноеimagevideotextsoundtool
  • xnumberобязательное
  • ynumberобязательное
  • wnumberобязательное
  • hnumberобязательное
  • imagestring
  • edgesarray<object>обязательноеfromstringобязательноеtostringобязательное
  • fromstringобязательное
  • tostringобязательное

WorkflowTemplateVersionCollectionDto

посторонние поля не принимаются

WorkflowTemplateVersionDto

посторонние поля не принимаются

  • revisionnumberобязательное
  • titlestringобязательное
  • canvasobjectобязательноеThe canvas document exactly as stored — its own field names are the studio’s camelCase, never converted.
  • created_atstringобязательное

WorkflowTemplateVersionEntryDto

посторонние поля не принимаются

  • revisionnumberобязательное
  • titlestringобязательное
  • created_atstringобязательное

WorkflowTemplateVersionsResponseDto

один из вариантов

WorkflowTrashCollectionDto

посторонние поля не принимаются

WorkflowTrashEntryDto

посторонние поля не принимаются

  • idstringобязательное
  • titlestringобязательное
  • deleted_atstringобязательное
Назад← Коды ошибок