Skip to main content
Use the Tiro API to read and manage notes, transcripts, summaries, and folders.

​
Base URL

All API requests should be made to:

​
Workspace access by credential type

An account API key carries the user’s identity and permissions across every workspace they can currently access. A workspace API key stays within its one workspace, while an organization API key stays within the workspaces in its organization. Call GET /v1/external/workspaces to list the workspaces the current credential can reach; each entry carries a guid, a name, and isWikiEnabled. GET /v1/external/workspaces/me returns the account API key’s default workspace or the workspace bound to a workspace API key. Workspace-scoped resources include a workspaceGuid. For example, POST /v1/external/workspaces/{workspaceGuid}/folders creates a folder in that workspace. When one account API key integrates with several workspaces, get the currently accessible workspaceGuid values from GET /v1/external/workspaces.

​
Rate Limits

You can send up to 600 requests per 60 seconds per API key. If you exceed that, you get a 429 response with Retry-After and X-RateLimit-* headers.

​
Rate Limit Exceeded

When rate limits are exceeded, you receive a 429 Too Many Requests response:

​
Response Format

List responses that use cursor pagination follow this consistent JSON format. Lists that don’t need pagination, like the workspace list, may use a different key (e.g. {workspaces: [...]}) instead of {content, nextCursor}.

​
Success Response (List)

​
Success Response (Single Resource)

​
Error Response

Errors include detailed information for debugging: