ガイド
エンドポイントのシグネチャだけでは分からないこと。トークンの取得方法、エンドポイントごとに必要なスコープ、そしてすべてのリクエストが共有する規約を扱います。
API リファレンスは各エンドポイントのリクエストとレスポンスを記述します。これらのガイドは、シグネチャだけでは分からないことを扱います。トークンの取得方法、エンドポイントごとに必要なスコープ、そしてすべてのエンドポイントが共有する規約です。
ワークスペースへのアクセス権をすでにお持ちであることを前提とします。
| ガイド | 分かること |
|---|---|
| クライアントを接続する | クライアントの登録、PKCE フロー、トークンの更新 |
| スコープと同意 | エンドポイントに必要なスコープと、リクエストが通る 4 つの検査 |
| 規約 | 冪等性、ページネーション、リビジョン、リクエスト制限 |
| エラー | 拒否のフォーマットと、再試行の価値がある拒否 |
| 公開エンドポイント | フォーム境界と Meta Webhook。この API ではありません |
このガイドに含まれないもの
サインイン済みワークスペースのトランスポート、すなわち /api/v1/workspace 配下のすべてのパスは、この API の対象外です。Web アプリケーション自身のセッションのみを受け付け、Bearer トークンは 403 と理由 workspace_session_required で拒否します。
これは記述漏れではなく意図的なものです。これらのルートは粗いアクションに対応づけられており、そこでの records.write は組織設定とアクセス制御ポリシーも編集します。それほど広い権限は同意によって第三者に委譲できません。外部クライアントには、文書化された REST リソースと MCP が提供されます。