> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tiro.ooo/llms.txt
> Use this file to discover all available pages before exploring further.

# API Overview

> Base URL, credential access boundaries, rate limits, and response format for the Tiro API.

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

## Base URL

All API requests should be made to:

```
https://api.tiro.ooo
```

## Workspace access by credential type

An account API key carries the user's identity. If you select workspaces when you create it, it works only in those workspaces. If you don't, it reaches resources in every workspace the user can currently access, with the user's permissions. A workspace API key stays within its own workspace, and an organization API key stays within its organization's workspaces. You can also limit an organization API key to the workspaces you select.

Call `GET /v1/external/workspaces` to list the workspaces the current credential can reach; each entry carries a `guid`, a `name`, and `isWikiEnabled`.

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:

```json theme={"system"}
{
  "error": {
    "code": 429000,
    "message": "Rate limit exceeded. Retry after 60 second(s).",
    "detail": null
  }
}
```

## 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)

```json theme={"system"}
{
  "content": [...],
  "nextCursor": "opaque-cursor-string"
}
```

### Success Response (Single Resource)

```json theme={"system"}
{
  "id": "resource-id",
  "createdAt": "2024-01-01T00:00:00Z",
  ...
}
```

### Error Response

Errors include detailed information for debugging:

```json theme={"system"}
{
  "error": {
    "code": 400000,
    "message": "Human readable error message",
    "detail": null
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.