メインコンテンツにスキップ

ドキュメント

1 つのバックエンド、4 つの方法。各セクションでは同じ使用例が説明されているため、REST API で学習する概念は MCP および CLI でも同じ概念です。

  • はじめる

    認証、ワークスペース、プロジェクト、および最初に公開された投稿。

    まだ公開されていませんこのセクションは、付属の API に対して作成され、それを使用して公開されます。変更される可能性のあるエンドポイントに関するドキュメントのみを示したいと考えています。

  • REST API

    リソース、ページネーション、冪等性、エラー コード、レート制限。

    まだ公開されていませんこのセクションは、付属の API に対して作成され、それを使用して公開されます。変更される可能性のあるエンドポイントに関するドキュメントのみを示したいと考えています。

  • MCPサーバー

    トランスポート、OAuth、ツール カタログ、スコープ、承認ハンドシェイク。

    まだ公開されていませんこのセクションは、付属の API に対して作成され、それを使用して公開されます。変更される可能性のあるエンドポイントに関するドキュメントのみを示したいと考えています。

  • CLI

    インストール、認証、および機械読み取り可能な出力コントラクトを実行します。

    まだ公開されていませんこのセクションは、付属の API に対して作成され、それを使用して公開されます。変更される可能性のあるエンドポイントに関するドキュメントのみを示したいと考えています。

  • Webhook

    イベント カタログ、署名検証、再試行および再配信。

    まだ公開されていませんこのセクションは、付属の API に対して作成され、それを使用して公開されます。変更される可能性のあるエンドポイントに関するドキュメントのみを示したいと考えています。

  • プラットフォームごとの要件、アカウントの種類、制限、既知の制限。

  • エラー参照

    すべてのエラー コード、その原因、およびその対処方法。

    まだ公開されていませんこのセクションは、付属の API に対して作成され、それを使用して公開されます。変更される可能性のあるエンドポイントに関するドキュメントのみを示したいと考えています。

信頼できるもの

  • すべての書き込みには冪等性キーが必要です。同じキーを使用してリクエストを再生すると、2 番目の投稿を作成するのではなく、元の結果が返されます。
  • すべてのエラーには、安定したコード、メッセージ キー、およびサニタイズされた詳細が含まれます。コードの意味はバージョン間で変わりません。
  • 重大な変更には新しいバージョンが適用され、非推奨期間が発表されます。追加的な変更は行われません。
  • 読み取り、下書き、承認の要求、スケジュール設定、および公開は別の範囲です。資格情報は、その役割を果たす最小のセットを取得します。

API and MCP Terms