Skip to main content
This page covers the rules every request follows: content types, JSON bodies, compression and pagination. Before you start a workflow, check what your account and deployment support:
Read training_available, labeling_available, prompt_tuning, models and limits in the answer. Availability can change. An entry in the catalogue doesn’t promise that it can serve requests at the moment.

Content types

A content type the route doesn’t accept gets 415. /v1/systemone also takes a multipart/form-data body, which carries each image as a file. Images explains its parts.

JSON bodies

Unknown request fields, duplicate JSON keys and invalid numeric values, such as NaN and Infinity, can be rejected. Keep the order of each decision’s outcomes the same from one request to the next. Changing the order can change the probabilities.

Compression

You can compress the body of an authenticated request to a route that needs authentication. Compress it once, with Content-Encoding: gzip or Content-Encoding: zstd. The body’s size limits hold both as sent and decompressed (Request size). A zstd frame’s window can be at most 8 MiB. A route that needs no authentication takes its body uncompressed. /v1/systemone/translate and /v1/lint are two such routes. Compression shortens long text the most. A request with images gains far more when you shrink each image to the size the model reads (Send images fast).

Pagination

Moved routes

The organisation’s own routes moved from under /v1/account to under /v1/organization. Until 00:00 UTC on 10 December 2026, each old path still works as its new one. Its answers carry a Deprecation header, a Sunset header with that date, and a Link to the new path. From then on, an old path gets 410 route_gone, which names the new one. Until then, user in GET /v1/account still has the organisation’s status, financial_blocked, zero_data_retention_since and other deprecated fields. Read organization.status, wallet.financial_blocked, tier and organization.zero_data_retention instead.

API reference

The API reference lists the customer operations. It links the spec the service serves at /openapi.json, which lists the same operations. Its try-it requests go to https://api.sqwish.ai through Mintlify’s proxy, and can spend credit.