ヘルプとリファレンス
本ページでは、ドキュメントとプラットフォーム画面に登場する用語を統一的に説明し、同じ概念がページごとに異なる呼び方をされることを防ぎます。
| 用語 | 意味 |
|---|
| LocoPal Ai | API プラットフォームであり、エコシステム全体の中核でもあります。アカウント、ログイン、課金、モデルカタログ、素材ライブラリ、タスク記録を提供します。入口は locopalai.com。 |
| LocoPal Creation | 制作プラットフォーム（Web ワークスペース）で、コードを書かずに直接制作することを目的としています。入口は creation.locopalai.com。 |
| コンソール | LocoPal Ai にログインした後の管理画面で、モデルマーケット、API キー、ログ、素材ライブラリ管理、ウォレットなどを含みます。 |
| 用語 | 意味 |
|---|
| API keys | プラットフォームのエンドポイントを呼び出すための認証情報で、sk-... の形式です。1 つの Key でモデル、画像、動画、音声、素材のエンドポイントを呼び出せます。 |
| Access Token | 短期間有効な呼び出し用トークン。プラットフォームのフロントエンドではメモリ内にのみ保持し、localStorage には書き込みません。 |
| リフレッシュトークン / セッション Cookie | ページの更新後にログイン状態を復元するために使用します。スコープは .locopalai.com のため、2 つのプラットフォームでログインを共有できます。 |
| 統合ログイン | LocoPal Ai で 1 回だけログインすれば、残りのプラットフォームは自動的にログイン状態を取得します。LocoPal Ai が唯一の ID のソースです。 |
| ログイン状態の失効 | ログアウト、アカウントの切り替え、パスワードの変更後は、両方のプラットフォームのセッションが同時に失効し、再ログインが必要になります。 |
| 用語 | 意味 |
|---|
| モデル ID | リクエストの model フィールドに入力する値で、GET /v1/models が返す data[].id から取得します。ページに表示される名称ではありません。 |
| モデルマーケット | モデル名、機能、パラメータ、価格、利用可能なグループを確認する入口。 |
| 呼び出しグループ / グループ | 1 つの Key が表示・呼び出しできるモデルの権限範囲を決定します。1 つのグループには複数のチャネルがあり、チャネルに複数のモデルが紐づきます。 |
| チャネル | グループの下で実際にモデルを担う経路。モデルが利用可能かどうかは、現在利用可能なチャネルへルーティングできるかによって決まります。 |
| ベースアドレス（Base URL） | エンドポイントのプレフィックスで、例は https://locopalai.com。ドメインまでのみ記述し、/v1 を重複して追加しないでください。 |
us-api.locopalai.com | 海外モデルまたは特定のネットワーク環境向けの代替接続アドレス。どちらのアドレスを使用する場合も、そのアドレスの /v1/models を基準にしてください。 |
| 同期呼び出し | リクエストが返った時点で結果が得られる呼び出しで、テキスト、画像、音声などがあります。 |
| 非同期タスク | 先にタスクを作成して ID を取得し、その後ポーリングで結果を照会する呼び出しで、動画生成などがあります。 |
| 用語 | 意味 |
|---|
| 素材ライブラリ | プラットフォーム共通の素材ストレージで、グループ単位で整理されます。1 回登録するだけで、素材参照をサポートするすべてのモデルで再利用できます。 |
| 素材グループ | 素材のコンテナで、バーチャル（virtual）と実写人物（real）の 2 種類に分かれます。 |
| バーチャル素材 | アップロードまたは生成した画像素材で、キャラクター、商品、スタイルなど再利用可能な資料の保存に適しています。 |
| 実写人物素材 | 本人がスマートフォンで QR コードをスキャンして生体収集と肖像権の許諾を完了する必要がある人物資料で、通常の画像アップロードでは代替できません。 |
| 素材 ID | 素材の一意な識別子で、モデル間で一貫しています。 |
asset://<asset_id> | リクエスト内で登録済み素材を参照する記法。素材のステータスが Active になってから使用してください。 |
Active | 素材のステータスの 1 つで、処理が完了し、素材参照をサポートするモデルで安定的に使用できることを示します。 |
Processing | 素材がまだ処理中です。これはエラーではなく、同じ素材 ID でポーリングを続けてください。 |
data_url | 画像データをインラインで送信する形式（data:image/...;base64,...）で、image_url とはどちらか一方のみ送信できます。 |
| 用語 | 意味 |
|---|
| タスク ID | 非同期タスクの識別子。作成後は必ず保存し、ローカルでタイムアウトしても再作成ではなく照会で追跡してください。 |
| タスクログ | 非同期タスクの実行明細を確認する入口で、送信時刻、タスク ID、所要時間、状態、進捗、成果物を含みます。 |
| 使用ログ | 同期呼び出しの明細を確認する入口で、モデル、Token、費用を含みます。 |
queued / 待機中 | タスクが受理され、実行を待っています。 |
processing / 生成中 | タスクが実行中です。ページを離れても、後から元の記録に戻って確認できます。 |
succeeded / 完了 | 結果が生成され、ダウンロードまたは参照できます。 |
failed / 失敗 | タスクが終端状態で失敗しました。同じレスポンス内の error.code と error.message を読み取ってください。 |
video_generation_failed | 動画タスクの終端状態の失敗コードで、error.message はすでに整理された読み取り可能な原因です。 |
| 成果物 | タスクの生成物で、直接プレビューまたはダウンロードできる画像、動画、音声です。 |
| リクエストスナップショット | タスクのリクエスト内容と元のリクエスト JSON。管理者のみ表示可能で、一般ユーザーが自分のタスクを照会する際には該当フィールドは返されません。 |
| 用語 | 意味 |
|---|
| Token 単位の課金 | 入力 Token と出力 Token をそれぞれ課金し、単位は 1K または 1M Token で表示されます。 |
| キャッシュ入力 / キャッシュ書き込み | プロンプトキャッシュをサポートするモデルでのみ表示される課金項目。 |
| 回数単位の課金 | 成功したリクエストごとに固定価格で課金します。 |
| 価格マトリクス | 動画モデルが「動画入力の有無」×「出力解像度」で表示する価格表。 |
| 完了時の精算 | 非同期タスクの実際の課金はタスク完了時に発生し、送信はタスクを受理するだけで、事前に課金されません。 |
| ウォレット | チャージ、プラン、注文、請求記録の入口。 |
| 推定消費 | タスク送信前の費用見積もり。残高がこれをカバーできない場合は、メッセージを直接返してタスクを作成しません。 |
| 用語 | 意味 |
|---|
レート制限 / 429 | リクエストが多すぎる状態。案内に従ってバックオフして再試行し、並行して再試行しないでください。 |
task_concurrency_exceeded | 並行タスクが上限に達しました。既存のタスク ID を保持し、しばらく待ってからユーザーが主体的に再送信してください。 |
| バックオフ再試行 | 失敗後に一定時間待ってから再試行し、待ち時間を徐々に延ばす方式で、即座に連続して再送信するものではありません。 |
| RequestId / リクエスト ID | 1 回のリクエストの識別子で、問題を調査する際に特定の記録を突き止めるために使用します。 |
400 パラメータ検証の失敗 | リクエストが受理されず、通常は生成タスクの費用は発生しません。 |
