Documentation

API documentation in various formats.

Developer Guide (HTML)

get

Returns the developer guide as rendered HTML. Includes authentication examples, workflow guides, and changelog.

Authorizations

BearerAuth

AuthorizationstringRequired

How to Authenticate

1. Get your token from Timbr Dashboard
2. Click the Authorize button above
3. Enter only the token (e.g., TBR_abc123def456)
4. Click Authorize then Close

Important

• ✅ Correct: TBR_8b3364b5a772328a
• ❌ Wrong: Bearer TBR_8b3364b5a772328a

The 'Bearer ' prefix is added automatically by Swagger UI.

Responses

200

Successful Response

text/html

Responsestring

get

/developer-guide

HTTPcURLJavaScriptPython

GET /developer-guide HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful Response

text

Developer Guide (Markdown)

get

Returns the raw markdown content of the developer guide for downloading or embedding.

Authorizations

BearerAuth

AuthorizationstringRequired

How to Authenticate

1. Get your token from Timbr Dashboard
2. Click the Authorize button above
3. Enter only the token (e.g., TBR_abc123def456)
4. Click Authorize then Close

Important

• ✅ Correct: TBR_8b3364b5a772328a
• ❌ Wrong: Bearer TBR_8b3364b5a772328a

The 'Bearer ' prefix is added automatically by Swagger UI.

Responses

200

Successful Response

text/plain

Responsestring

get

/developer-guide.md

HTTPcURLJavaScriptPython

GET /developer-guide.md HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful Response

text