エンドポイント概要

ベースアドレスはすべて https://locopalai.com で、すべてのエンドポイントが同じプラットフォーム API Key を使用します。共通の取り決め（認証、レスポンス構造、ページネーション、レート制限、冪等性）は認証と基本仕様を参照してください。

モデルと生成エンドポイント

用途	メソッド	パス	詳細ドキュメント
利用可能なモデルの照会	GET	`/v1/models`	モデルとテキストのエンドポイント
テキスト対話（ストリーミングを含む）	POST	`/v1/chat/completions`	モデルとテキストのエンドポイント
画像生成	POST	`/v1/images/generations`	画像生成エンドポイント
テキスト読み上げ	POST	`/v1/audio/speech`	テキスト読み上げエンドポイント
動画タスクの作成	POST	`/v1/video/generations`	動画生成エンドポイント
動画タスクの照会	GET	`/v1/video/generations/{task_id}`	動画生成エンドポイント
動画タスクの作成（OpenAI 互換形式）	POST	`/v1/videos`	動画生成エンドポイント
動画タスクの照会（OpenAI 互換形式）	GET	`/v1/videos/{task_id}`	動画生成エンドポイント

素材ライブラリのエンドポイント

素材ライブラリのエンドポイントはすべて API Key を使用し、成功時は統一して { "code": 0, "data": ..., "msg": "..." } を返します。

用途	メソッド	パス	詳細ドキュメント
素材グループの照会	GET	`/api/v1/materials/groups`	素材グループ
素材グループの作成（`virtual` / `real`）	POST	`/api/v1/materials/groups`	素材グループ
素材一覧の照会（`group_id`、ページネーションに対応）	GET	`/api/v1/materials/assets`	素材
画像素材の送信（`image_url` または `data_url`）	POST	`/api/v1/materials/assets`	素材
単一素材のステータス照会	GET	`/api/v1/materials/assets/{asset_id}`	素材
素材ステータスの同期	POST	`/api/v1/materials/sync`	素材ステータスの同期
QR コード読み取りによる肖像権許諾セッションの作成	POST	`/api/v1/materials/portrait/sessions`	実在人物素材の肖像権許諾
QR コード読み取りの完了確認	POST	`/api/v1/materials/portrait/resolve`	実在人物素材の肖像権許諾

詳細なパラメータ、例、エラーの説明は素材ライブラリ API 概要を参照してください。

典型的な呼び出しフロー

モデルと動画

GET  /v1/models
  → POST /v1/video/generations
  → GET  /v1/video/generations/{task_id}

タスク作成後は必ずタスク ID を保存してください。ネットワークが中断した場合は元のタスクの照会を続け、重複して作成しないでください。

テキスト読み上げ

GET  /v1/models
  → POST /v1/audio/speech
  → 保存二进制音频响应

音声エンドポイントが利用可能かどうか、どの voice と response_format に対応するかは、現在の Key のモデルカタログおよび実際のモデル能力に準じます。

バーチャル素材

POST /api/v1/materials/groups
  → POST /api/v1/materials/assets
  → GET  /api/v1/materials/assets/{asset_id}   （轮询到 status 为 Active）
  → 在视频 content 中使用 asset://<asset_id>

実在人物素材

POST /api/v1/materials/groups {"type":"real"}
  → POST /api/v1/materials/portrait/sessions   （拿到二维码链接）
  → 由真人本人扫码完成采集
  → POST /api/v1/materials/portrait/resolve
  → POST /api/v1/materials/sync
  → 查询素材状态后用于支持真人素材库的模型

エンドツーエンドの例は人物素材と参照動画の連携フローを、複数画像と参照動画の能力の境界は複数画像と参照動画の説明を参照してください。

レスポンスとエラー

エンドポイント種別	成功	失敗
モデル / 画像 / 動画	結果オブジェクトを直接返す	HTTP が `2xx` 以外、`error.message` を読み取る
素材ライブラリ	`{ "code": 0, "data": ..., "msg": "OK" }`	HTTP ステータスコードと `code` が一致

クライアントは HTTP ステータスとレスポンスボディの両方を確認する必要があります。完全なエラーコードと調査方法はエラーコードとトラブルシューティングを参照してください。

このページの目次