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

# はじめに

> Caret Public APIの概要

Caret Public APIを使用すると、会議、ノート、チームメンバーなどのワークスペースデータとプログラムでやり取りできます。当社のAPIはREST原則に基づいて構築されており、JSON形式のレスポンスを返し、標準的なHTTPレスポンスコードを使用します。

## ベースURL

すべてのAPIリクエストは、以下のベースURLに対して行う必要があります：

```bash theme={null}
https://api.caret.so/v1
```

## 主な機能

<CardGroup cols={2}>
  <Card title="認証" icon="key">
    開発者設定から直接管理されるAPIキーを使用して、リクエストを保護します。
  </Card>

  <Card title="きめ細かな権限" icon="shield-check">
    ユーザー、タグ、ノートなどのスコープ付き権限でアクセスを制御します。
  </Card>

  <Card title="レート制限" icon="gauge">
    小規模なチームから大企業までサポートするように設計された、余裕のあるレート制限。
  </Card>

  <Card title="Webhook" icon="webhook">
    会議の完了やノートの更新に関するリアルタイム通知を受け取ります。
  </Card>
</CardGroup>

## クイックスタート

Caret APIの使用を開始するには、以下の手順に従ってください：

<Steps>
  <Step title="APIキーの作成">
    Caretダッシュボードの\[開発者設定]に移動し、新しいAPIキーを生成します。
  </Step>

  <Step title="権限の設定">
    統合に必要なスコープを選択します（例：`notes:read`、`users:write`）。
  </Step>

  <Step title="最初のリクエストを実行">
    すべてのリクエストに `Authorization: Bearer <API_KEY>` 形式でAPIキーを付与します。
  </Step>
</Steps>

## レート制限

プラットフォームの安定性を確保するため、すべてのAPIエンドポイントにレート制限を適用しています。デフォルトでは、ワークスペースは以下のように制限されています：

* **標準エンドポイント**：1分あたり100リクエスト
* **重い操作**（例：一括エクスポート）：1分あたり20リクエスト

これらの制限を超えると、APIは`429 Too Many Requests`エラーを返します。より高い制限が必要な場合は、サポートチームにお問い合わせください。

<Note>レート制限はワークスペースレベルで適用されます。</Note>

## サポート

APIに関する問題が発生した場合や質問がある場合は、こちらでサポートいたします：

* **ドキュメント**：エンドポイントの詳細については、[APIリファレンス](/api-reference/workspace/get-workspace)を参照してください。
* **メール**：[support@caret.so](mailto:support@caret.so)までお問い合わせください。
* **Slack**：リアルタイムの開発者サポートについては、コミュニティSlackチャネルに参加してください。