コンテンツにスキップ

モデル API

モデル API は、価格つきのモデルカタログを返します。API キーは不要です。完全なスキーマは、OpenAPI 定義と API リファレンスにあります。

GET /v1/models

クエリパラメータはすべて任意で、複数指定すると AND で絞り込みます。

  • modality: モデルの主モダリティ(modality フィールド)が一致するモデルだけを返します。音声も出力する動画モデルは video では返り、audio では返りません。出力するモダリティはすべて capabilities.output_modalities に入ります。値は text, image, video, audio のいずれかです。
  • task: そのタスクに対応するモデルだけを返します。値は chat, text-to-image, image-edit, text-to-video, image-to-video, reference-to-video, text-to-speech のいずれかです。
  • locale: summary、description、パラメータの説明の言語です。値は en、ja、zh、ko のいずれかで、既定は en です。

これらの一覧にない値を指定すると、400 と invalid_request を返し、error.details.allowed に指定できる値が入ります。

ターミナルウィンドウ
curl "https://api.sakuranbo.ai/v1/models?modality=image&locale=en"

レスポンスは、object: "list" と、モデルの data 配列を持ちます。各モデルには次の項目が入ります。

  • id、name、vendor、vendor_name、modality、tasks、status、endpoint(そのモデルを実行する生成エンドポイント)。
  • released_at(公開日が確認できているときだけ)と updated_at。
  • summary、description、capabilities、parameters(JSON Schema 形式の入力フィールド)。
  • pricing: 価格の項目ごとに 1 件。amount_micro_usd(整数)、amount_usd(10 進文字列)、conditions(その価格を選ぶ入力値)を持ちます。
  • data_policy、およびモデルのページと Markdown 版への links。

GET /v1/models/{vendor}/{model}

ターミナルウィンドウ
curl "https://api.sakuranbo.ai/v1/models/sakuranbo/cherryimage-1.0-pro"

カタログにない ID を指定すると、404 と model_not_found を返します。

公開の GET レスポンスは、すべての origin を許可し、弱い ETag を持ち、Cache-Control: public, max-age=60 を使います。If-None-Match を送ると、カタログが変わっていなければ 304 を返します。

モデル IDモダリティタスク上流の提供状況
sakuranbo/cherrytext-1.0-flashtextchatGA(上流)
sakuranbo/cherry-1.0-provideotext-to-video, image-to-video, reference-to-videoGA(上流)
sakuranbo/cherryimage-1.0-proimagetext-to-image, image-editGA(上流)