SpeakNotes API error codes

Every failure returns the same JSON envelope: a stable code, a human-readable message, a link to this page, and the fields at fault when there are any.

The shape

Errors never come back as HTML. The code is stable and safe to branch on; the message can change at any time.

HTTP/1.1 402 Payment Required
X-Request-Id: 0f0a3f2c-6f1e-4a5e-9f1b-9d0b5a2c7e11

{
  "error": {
    "type": "billing_error",
    "code": "insufficient_credits",
    "message": "This operation costs 14 credits and the account has 3 left.",
    "doc_url": "https://speaknotes.io/developers/errors#insufficient_credits",
    "request_id": "0f0a3f2c-6f1e-4a5e-9f1b-9d0b5a2c7e11"
  }
}

Codes

invalid_request400
The request was malformed or failed validation.
invalid_token401
The credential is missing, malformed, expired, or revoked.
insufficient_scope403
The credential is valid but lacks the scope this operation needs.
not_found404
The requested resource does not exist.
method_not_allowed405
That HTTP method is not supported on this path.
conflict409
The request conflicts with the current state of the resource.
payload_too_large413
The uploaded file exceeds the size limit.
unsupported_media_type415
The file format is not supported.
insufficient_credits402
The account has no credits left for this operation.
rate_limited429
Too many requests. Retry after the interval in the Retry-After header.
upstream_failure502
A provider SpeakNotes depends on failed.
content_policy422
The content was refused by the AI content policy.
internal_error500
SpeakNotes failed to process the request.

What to retry

Retry rate_limited after the interval in Retry-After, and upstream_failure once or twice with backoff. Never retry invalid_request, insufficient_scope, or content_policy unchanged: they will fail the same way every time.

Request ids

Every response carries an X-Request-Id header, and error bodies repeat it. Quote it to support and the exact failure can be found.