概要
このページでは、Developer Platform APIに共通する接続情報、エンドポイント、レスポンス形式、エラー、利用上限をまとめます。各ツール固有の入力形式と現在の料金は、GET /toolsで取得してください。
Base URLと共通ヘッダーを確認する
すべてのパスは、次のBase URLへ追加します。エンドポイントを確認する
公開APIで利用する主なエンドポイントは次のとおりです。GET /tools/executionsでは、limit、before、status、toolで一覧を絞り込めます。limitは1〜100で、既定値は20です。
ツールカタログを確認する
GET /toolsのdataには、カタログ全体の料金バージョン、通貨、実行可否、ツール一覧が含まれます。
各ツールでは、次の情報を確認できます。
name— 実行URLと本文に指定するツール名descriptionとcategory— 用途と分類available— 必要な外部サービスが設定され、提供可能かinputSchemaとexample— 入力のJSON Schemaと例models— 選択できるモデルとモデル別の入力例、提供状態、料金説明price— 最小料金、課金単位、料金説明
available: trueだけで実行できるとは限りません。カタログ全体のexecutionEnabled、キーの権限、前払い残高、月間上限も適用されます。
レスポンス形式を確認する
成功レスポンスの本体は、原則としてdataに入ります。
errorに状態とメッセージが入ります。
Cache-Control: no-storeが設定されます。APIキー、結果、期限付きURLを共有キャッシュへ保存しないでください。
エラーへ対応する
受け取ったステータスに応じて、再送前に原因を確認します。利用上限を確認する
クライアント実装では、次の上限を考慮してください。
リクエスト数には、カタログ、見積もり、アップロード、実行、状態確認、再送も含まれます。429を避けるため、状態確認を必要以上に短い間隔で繰り返さないでください。
素材をアップロードする
ローカルの画像・音声・動画を使う場合は、POST /tools/uploadへMIME形式とBase64データを送ります。
fileIdとして使えるid、形式、サイズ、SHA-256、取得期限が返ります。ツール固有のsourceなどへ、カタログが示す形式で指定してください。同じプロジェクト・同じ内容では同じIDが返り、保存期限は初回アップロードから延長されません。