API reference

Every operation of the Scarleta API with its method, path, parameters, request and response fields, error codes and code samples in cURL, JavaScript and Python.

Before you start

Base URL: https://api.scarleta.ai
Authentication: Send Authorization: Bearer <key>. Paid keys start with scar_live_, free keys with sk_free_.
Responses: Most success bodies are { "data": ..., "meta": { "request_id": ... } } and most errors are { "error": { "code", "message", "request_id", "docs_url" } }. A few operations answer an older or different shape (a { "data": ... } body with no meta, a flat { "error": "<code>", "message": ... } error, a bare body, a file or an empty body). The Responses section of each operation shows its exact body: follow that, not this summary. Every code is explained on the error codes page.
Request limits: 100 per hour on a free key, 10,000 per hour on a paid key. Over the limit, the API answers 429 and a Retry-After header.
Cost: 1 token is 1 second of audio, billed at $0.10 per minute. A free account starts with 300 tokens, one time. Each operation says whether it uses tokens.
Machine-readable spec: openapi.json (OpenAPI 3.1).

Operations

Analysis

4 operations

POST /v1/analyze · GET /v1/analyze/{job_id}

Analysis results

2 operations

GET /v1/audio/{audioId}/analyses · GET /v1/audio/{audioId}/midi