Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.tumban.com/llms.txt

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

The Tumban API uses standard HTTP status codes. Failures return a JSON body with a detail field; validation errors include a list of field-level reasons.

​
Status codes

StatusMeaning
200Request succeeded.
201Resource created (Create API key).
204Request succeeded; no body (Revoke API key).
400Request was syntactically valid but had no recognized fields, or contained an invalid filter value.
401Missing or malformed Authorization header, or the credential is invalid or revoked.
403Token decoded but lacks the required organization context (Clerk JWT only).
404The resource referenced by the path does not exist within your organization.
422Body failed Pydantic validation — see the per-field detail.
5xxTumban server error. Retry with backoff.

​
Error envelope

Most errors: 
{ "detail": "Invalid or revoked API key" }
Validation errors (422) — detail is a list: 
{
  "detail": [
    {
      "field": "profile_url",
      "msg": "Input should be a valid URL",
      "type": "url_parsing"
    }
  ]
}

​
Common detail strings

StatusDetailWhere
401Missing or invalid Authorization header. Expected: Bearer <token>All authenticated endpoints.
401Token has expiredClerk JWT is past its exp.
401Invalid tokenClerk JWT failed signature or claim verification.
401Invalid or revoked API keyThe sk_… token is unknown or revoked.
403Token missing org_id — make sure you have an active organization selectedDashboard session has no active org.
404Scan not foundGet scan.
404Batch not foundGet batch.
404Org settings not foundOrg settings or usage endpoints.
404API key not found or already revokedRevoke API key.
400No fields to updateUpdate org settings.
400Invalid recommendation values: [...]List org scans.