Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.timbal.ai/llms.txt

Use this file to discover all available pages before exploring further.

The Timbal API uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Timbal servers (these are rare).

Rate limiting

Some endpoints enforce per-user rate limits. When limits apply, successful 2xx responses and 429 Too Many Requests may include:
HeaderMeaning
RateLimit-LimitMaximum requests allowed in the current window.
RateLimit-RemainingRequests left before the window resets.
RateLimit-ResetSeconds until the window resets.
Retry-AfterOn 429, seconds to wait before retrying (prefer this over a fixed backoff when present).
Legacy aliases X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset mirror the RateLimit-* values.
CodeStatusDescription
200OKEverything worked as expected.
400
422
Bad RequestsThe request was unacceptable, often due to missing a required parameter.
401UnauthorizedNo valid API key provided.
402Request FailedThe parameters were valid but the request failed.
403ForbiddenThe API key doesn’t have permissions to perform the request.
404Not FoundThe requested resource doesn’t exist.
429Too Many RequestsPer-user rate limit exceeded. Honor Retry-After when sent; otherwise use exponential backoff.
500
502
503
504
Server ErrorsSomething went wrong on our end.