Skip to content

API reference

Every Slicer API v1 endpoint by group — method, path, scopes, rate limit, price, parameters, responses and examples in curl, JavaScript and Python.

On this page

The reference is built from the OpenAPI 3.1 specification that the server itself serves — the description and the API's behavior don't drift apart. You can download the specification for a client generator or Postman without a token: https://api.slicer.media/v1/openapi.json (opens in a new tab).

Groups

Group What's inside
Accountprofile, balance, token, wallet transactions
Catalog and pricesstyles and montage settings, export presets, operation price, the specification
Uploadsuploading files whole, in parts, by link and from a URL
Projectsmontage, status, versions, rebuild, retry, stop, download
Editingthe video text, edit operations, the edit document, AI assistant, translation, style
Export and publishingrendering, publications, connected social accounts
Webhooksnotification endpoints, testing and the delivery log

Reading an endpoint description

  • Method and path — relative to https://api.slicer.media; path parameters are in curly braces.
  • Scopes — which scopes the token needs. "Any" means any valid token will do.
  • Limit — the rate limit bucket: regular, paid or upload parts.
  • Price — for paid endpoints: without confirmCost the response is a Quote price and nothing starts (Montage and pricing). Captions from speech, the AI assistant and translation are priced at AI cost: the Quote has estimate (the expected price) and atCost: true, and cost is the maximum (Editing the video).
  • Response — the content of the data field of a successful { "ok": true, "data": … } response. Errors use the common format (Errors).

All requests with a body send JSON (Content-Type: application/json), except file uploads, where the body is the file bytes (application/octet-stream).

Common schemas

Quote

Field Type Description
statusrequired"quote"
costrequiredintegerPrice in tokens; repeat the request with confirmCost equal to it. For an operation at cost (atCost) — the maximum: the actual cost is charged, never more
freerequiredbooleanThe operation is free (first video, free retry)
estimatenumberOperation at cost: expected price in tokens (fractional)
atCostbooleanPriced at the AI providers’ cost, no markup: the wallet is charged the actual cost, at most cost
availablerequiredintegerTokens available now
enoughrequiredbooleanEnough tokens to run
spendLimitLeftrequiredinteger | nullWhat is left of the token's monthly spend limit; null — no limit

Error

Field Type Description
okrequiredfalse
errorrequiredobject
error.coderequiredstringStable snake_case error code
error.messagerequiredstringHuman-readable message in the account language
error.fieldsRecord<string, string>Field errors
error.retryAfterSecintegerSeconds to wait before retrying

What's next