はじめに - Caret

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

ベースURL

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

https://api.caret.so/v1

開発者設定から直接管理されるAPIキーを使用して、リクエストを保護します。

ユーザー、タグ、ノートなどのスコープ付き権限でアクセスを制御します。

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

会議の完了やノートの更新に関するリアルタイム通知を受け取ります。

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

APIキーの作成

Caretダッシュボードの[開発者設定]に移動し、新しいAPIキーを生成します。

権限の設定

統合に必要なスコープを選択します（例：notes:read、users:write）。

最初のリクエストを実行

リクエストを認証するために、X-API-KeyヘッダーにAPIキーを使用します。

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

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

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

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