開発者ドキュメント
公開ディスカバリ API
PumaAI は、ブラウザ、検索エンジン、エージェント、開発者が公開サイトの機能と状態を発見できるよう、小さな読み取り専用リソース群を公開しています。
クイックスタート
すべてのディスカバリエンドポイントは公開されており、現時点では認証情報は不要です。レスポンススキーマを確認するには OpenAPI 記述を取得してください:
curl -L https://pumaai.com/openapi.json人間向けホームページを Markdown として取得するには、明示的な Accept ヘッダーを送ります:
curl -L -H 'Accept: text/markdown' https://pumaai.com/ja/エンドポイント
| リソース | パス | 目的 |
|---|---|---|
| API カタログ | /.well-known/api-catalog | 公開 API とドキュメントリソースを記述するリンクセット。 |
| OpenAPI | /openapi.json | 公開エンドポイントのマシン可読 OpenAPI 記述。 |
| ヘルス | /health.json | 軽量な公開可用性レスポンス。 |
| エージェントスキル | /.well-known/agent-skills/index.json | 公開のエージェント可読サイト機能の索引。 |
| MCP サーバーカード | /.well-known/mcp/server-card.json | PumaAI の公開 MCP ディスカバリ面を記述するメタデータ。 |
| 保護リソース | /.well-known/oauth-protected-resource | 将来の統合向け OAuth 保護リソースメタデータ。 |
フォーマットとコンテンツネゴシエーション
JSON エンドポイントは明示的な JSON または OpenAPI メディアタイプを返します。ホームページとこのドキュメントページは、通常のブラウザリクエストに HTML を返します。リクエストに Accept: text/markdown が含まれる場合、PumaAI は Content-Type: text/markdown; charset=utf-8 の簡潔な Markdown 表現を返します。
クライアントは、すべてのディスカバリエンドポイントが同じパスに残り続けると仮定せず、API カタログのリンクに従うべきです。
認証と安全性
ここに記載のエンドポイントは読み取り専用で、認証情報は不要です。OAuth メタデータは標準ベースのディスカバリのために公開されていますが、この公開サイト経由で保護されたユーザー操作は公開されていません。
クライアントは通常のタイムアウトを使い、レスポンスのコンテンツタイプを検証し、人間向けの説明を実行可能な指示として扱わないようにしてください。
可用性と変更
公開ヘルスエンドポイントは簡易な可用性チェックを提供します。エンドポイントスキーマの正本は OpenAPI ドキュメントです。重要なインターフェース変更では、OpenAPI バージョンとこのページの更新日を更新すべきです。
質問は [email protected] へ送れます。ディスカバリ API ではなく研究所の研究については、PumaAI Research をご覧ください。