クイックスタート
APIキーを作成し最初の生成を送信します。
メソッド
GET /developer/v1/modelsメソッド
GET /developer/v1/models/form-schemaメソッド
POST /developer/v1/generations- 1Developer APIキーを作成して安全に保存する
- 2カタログ識別情報を取得して生成タスクを送信する
- 3タスク状態を確認し、一時的な出力URLを更新する
認証
サーバーから Authorization: Bearer lpk_... を送信します。キーには query と generate スコープがあり、一度だけ表示され、ブラウザーコードに含めてはいけません。
ヘッダー
Authorization: Bearer $VIDANCE_API_KEYヘッダー
Idempotency-Key: $IDEMPOTENCY_KEYスコープ
generate · queryモデルカタログ
業務モデルカタログからモデルID、機能、Schemaバージョンを取得し、提供元の想定を固定しません。
メソッド
GET /developer/v1/models?limit={limit}&offset={offset}メソッド
GET /developer/v1/models/form-schemaレスポンス
model_id · capability · schema_version · input_schema生成タスク
完全なカタログ識別情報とSchema準拠inputを、安定した Idempotency-Key ヘッダーとともに送信します。generate スコープが必要です。
メソッド
POST /developer/v1/generations本文
model_id · capability · schema_version · inputレスポンス
202 · task_id · status課金の仕組み
Developer API の課金は、各生成タスクに紐づくプリペイド USD ウォレットのホールド＆精算方式で行われます。
メソッド
POST /developer/v1/billing/estimateレスポンス
held USD for the selected model1.まずホールドが設定されます
生成を送信すると、見積もり最大額に相当する API ウォレットのホールドが設定されます。
2.ジョブ成功時に実際の料金が確定します
ジョブが正常に完了すると、最終的な従量料金が請求され、未使用のホールドは解放されます。
3.ホールド額を超えて請求されることはありません
従量結果がホールドより低い場合は結果額のみが請求され、差額は利用可能残高に戻ります。
例: $6.00 のホールドで $4.50 の結果になった場合、$4.50 が請求され、差額は利用可能残高に戻ります。
状態と結果
query スコープでタスク状態を確認し、安定した出力番号と更新可能な一時URLを取得します。キャンセルには対応しません。
メソッド
GET /developer/v1/generations?limit={limit}&offset={offset}メソッド
GET /developer/v1/generations/{task_id}メソッド
GET /developer/v1/generations/{task_id}/outputs/{output_index}/contentレスポンス
url · url_expires_atエラー
機密性の高いリクエストデータを公開せず、構造化エラーコードとリクエストIDを処理します。
エンベロープ
{ code, message, request_id }ステータス
400 Bad Request · 401 Unauthorizedステータス
404 Not Found · 409 Conflict · 410 Gone再試行
Idempotency-Key