迷路のないドキュメント
始める場所
すでに動いているもの。
形
リクエストの形に従い、期待されるレスポンスを検査し、非同期作業が最終状態に達するまで見えるままに保つ。
表1 — パス
五つのパス、 三つの挙動。
| メソッド | パス | 契約 | 返り値 | 挙動 |
|---|---|---|---|---|
| POST | /v1/chat/completions | OpenAI互換 | メッセージ | 同期 |
| POST | /v1/messages | Claudeネイティブ | メッセージ | 同期 |
| POST | /v1/images/generations | 生成 | 結果URL | 同期 |
| POST | /v1/images/edits | Multipart | 結果URL | 同期 |
| POST | /v1/video/generations | 生成 | タスクID | 非同期 |
| GET | /v1/video/generations/{task_id} | 生成 | ステータス、次にURL | 最終状態までポーリング |
パスは公開時のもの。アクティブなカタログと各パスのモデルIDは使用時に確認する。
最初に書くことになるもの
クライアントがすでにこの形を話しているなら、変わるのはボディ内のモデル名だけ。
POST /v1/chat/completions
curl https://aiwave.live/v1/chat/completions \
-H "Authorization: Bearer $AIWAVE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"model":"your-model-id",
"messages":[{"role":"user",
"content":"Ship one representative request."}]}'