Machine-readable capabilities of available image models: aspect ratios, resolutions, reference image limits, and price: credit_per_image at the default resolution, plus credit_by_resolution for every supported resolution (GPT Image models cost more at 2K).
Headers
X-API-KeystringrequiredYour VisionStory API key (sk-vs-...), kept server-side. Create or manage keys in API keys (Pro plan and up).
Responses
200Successful Response
application/json
dataGetImageModelsResponse | nullrequirednullableThe endpoint-specific payload. See this endpoint's response schema for its fields; null only when the operation returns no payload.
modelsImageModelDto[]requiredMachine-readable model capabilities, including credit_per_image
credit_by_resolutionobjectrequiredCredits per image for each supported resolution. Some models (such as the GPT Image ones) cost more at 2K than at 1K; for the others every resolution has the same price.
credit_per_imageintegerrequiredCurrent credits per image at the model's default resolution. Example prices illustrate the response only; query this endpoint for live pricing.
descriptionstringrequiredPublic model summary.
model_idstringrequiredPublic model ID to send in image-generation requests.
paramsImageModelParamsrequiredaspect_ratioStringChoicesrequireddefaultstring | nullrequirednullableValue used when the request omits this parameter.
valuesstring[]requiredCurrently accepted values for this model.
promptImagePromptCapabilityrequiredmax_lengthintegerrequiredMaximum prompt characters for image generation or editing.
refsImageReferencesrequiredacceptstring[]requiredAccepted reference kinds; currently image.
maxintegerrequiredMaximum reference images per request.
resolutionStringChoicesrequireddefaultstring | nullrequirednullableValue used when the request omits this parameter.
valuesstring[]requiredCurrently accepted values for this model.
messagestringHuman-readable status message; "success" on a successful call.
server_timestring · date-timerequiredServer-side timestamp when the response was produced, in ISO 8601 format (UTC).
defaultError response. All failures share one envelope: an error object with a numeric code, a human-readable message, an optional details string, and an optional hint giving an actionable next step (useful for AI agents).
application/json
errorErrorDetailrequiredcodeintegerrequiredMachine-readable error code. Mirrors the HTTP status for transport-level failures (e.g. 401, 404, 422, 500) and may carry a business-specific code otherwise.
detailsstring | nullnullableOptional structured detail about the failure, e.g. a JSON string of per-field validation errors on a 422. Absent when there is nothing extra to report.
hintstring | nullnullableActionable next step for resolving the error, written for both humans and AI agents (e.g. how to fix the request, or where to obtain an API key). May be absent.
messagestringrequiredHuman-readable explanation of what went wrong. Safe to log or surface to end users; not localized.