Skip to content

Models API

The Models API returns the model catalog with prices. It needs no API key. The full schema is in the OpenAPI definition and the API reference.

GET /v1/models

Query parameters are optional, and filters combine with AND:

  • modality: return only models whose primary modality (the modality field) matches. A video model that also outputs audio is returned for video, not for audio; capabilities.output_modalities lists every output. One of text, image, video, audio.
  • task: return only models that support the task. One of chat, text-to-image, image-edit, text-to-video, image-to-video, reference-to-video, text-to-speech.
  • locale: the language of summary, description, and parameter descriptions. One of en, ja, zh, ko. The default is en.

A value outside these lists returns 400 with invalid_request, and error.details.allowed lists the accepted values.

Terminal window
curl "https://api.sakuranbo.ai/v1/models?modality=image&locale=en"

The response has object: "list" and a data array of models. Each model includes:

  • id, name, vendor, vendor_name, modality, tasks, status, and endpoint (the generation endpoint that runs the model).
  • released_at (only when the release date is confirmed) and updated_at.
  • summary, description, capabilities, and parameters (input fields in a JSON Schema style).
  • pricing: one entry per price dimension, with amount_micro_usd (integer), amount_usd (decimal string), and conditions (the input values that select the price).
  • data_policy and links to the model page and its Markdown version.

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

Terminal window
curl "https://api.sakuranbo.ai/v1/models/sakuranbo/cherryimage-1.0-pro"

An ID that is not in the catalog returns 404 with model_not_found.

Public GET responses allow any origin, carry a weak ETag, and use Cache-Control: public, max-age=60. Send If-None-Match to receive 304 when the catalog has not changed.

Model IDModalityTasksUpstream status
sakuranbo/cherrytext-1.0-flashtextchatGA (upstream)
sakuranbo/cherry-1.0-provideotext-to-video, image-to-video, reference-to-videoGA (upstream)
sakuranbo/cherryimage-1.0-proimagetext-to-image, image-editGA (upstream)