> ## 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概要

> AIによるノートテイキングのためのTiro APIの概要

Tiro APIは、ノート、トランスクリプト、サマリー、フォルダへのプログラムによるアクセスを提供します。

## Base URL

すべてのAPIリクエストは、次のURLに対して行ってください。

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

## ワークスペース

すべての Tiro API リクエストは、1 つの**ワークスペース**の中で実行されます。API キーは 1 つのワークスペースに限定され、そのワークスペースのリソース（ノート、トランスクリプト、サマリー、フォルダ）にのみ到達します。キーが別のワークスペースをまたぐことはありません。

`GET /v1/external/workspaces` を呼び出すと、アカウントがアクセスできるワークスペースの一覧が返ります。各エントリには `guid`、`name`、`isWikiEnabled` が含まれます。`GET /v1/external/workspaces/me` を呼び出すと、現在のキーが対応するワークスペースを確認できます。

ワークスペース単位のリソースは `workspaceGuid` を公開します。フォルダのエンドポイントはこれをパスで受け取ります — `POST /v1/external/workspaces/{workspaceGuid}/folders` は特定のワークスペース内にフォルダを作成します。連携が複数のワークスペースにまたがる場合は、ワークスペースごとにキーを 1 つずつ作成してください。

## Rate Limits

公平な利用とシステムの安定性を確保するため、Tiro APIはAPIキーごとに60秒あたり600リクエストまで許可しています。超過すると、再試行のタイミングを示す`Retry-After`・`X-RateLimit-*`ヘッダーがレスポンスに含まれます。

### Rate Limit Exceeded

rate limitを超過すると、`429 Too Many Requests`レスポンスが返されます。

```json theme={"system"}
{
  "error": {
    "code": 429001,
    "message": "Rate limit exceeded. Try again in 60 seconds",
    "detail": "Limit of 600 requests per 60 seconds exceeded"
  }
}
```

## レスポンス形式

すべてのAPIレスポンスは、一貫したJSON形式に従います。

### 成功レスポンス（リスト）

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

### 成功レスポンス（単一リソース）

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

### エラーレスポンス

エラーには、デバッグのための詳細な情報が含まれます。

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