開発者

API リファレンス — 近日公開

Stoplight Elements によるインタラクティブリファレンスは、公開 API 表面 (Chat Completions / Prompts / Usage / Budgets / Audit) が固まり次第ここに掲載されます。当面は開発者ドキュメントのクイックスタートとエンドポイント概要で統合に必要な情報を網羅しています。

ここに掲載されるもの

公開エンドポイントを対象としたインタラクティブリファレンス (Stoplight Elements 提供):

領域エンドポイント目的
ChatPOST /v1/chat/completionsリクエストをモデルへルーティング
PromptsGET /v1/prompts/{name}アクティブなプロンプトバージョンを解決
UsageGET /v1/usage構造化された利用レコードを照会
BudgetsGET /v1/budgets予算消費を確認
AuditGET /v1/audit監査イベントを読み取り

各エントリにはリクエスト/レスポンススキーマ、認証詳細、curl / Go / TypeScript の例、sandbox を叩ける try-it コンソールを含めます。

なぜ今は未公開か

バックエンドリポジトリの OpenAPI ファイルは現在 内部表面 (/internal/v1/*、governance、admin) を記述しています。これをマーケティングサイトで公開すると誤解を招きます — デザインパートナーが実際にコールできるのは OpenAI 互換の chat エンドポイントであり、ここで公開すべき仕様は内部仕様ではなくその公開契約を反映していなければならないためです。

公開表面が今後の Phase で確定した段階で schneeai-public.yaml をここに置き、リファレンスは自動的に描画されるようにします。

公開通知を受け取る

件名に “API Reference” と書いて [email protected] までメールをいただければ、公開時にご連絡します。デザインパートナーの方で公開前の特定エンドポイント詳細が必要な場合は、いつものチャネルまでご連絡ください。

本日時点では、開発者ドキュメントトークンコスト電卓で評価と統合に必要な情報を網羅しています。