Search VisionStory documentation

No documentation matched “”.

Try a feature or resource name such as , , or .

VisionStoryDevelopers

Get Image Models

GET/api/v1/image/models
Image Generation

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-Keystringrequired

Your 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 | nullrequirednullable

The endpoint-specific payload. See this endpoint's response schema for its fields; null only when the operation returns no payload.

modelsImageModelDto[]required

Machine-readable model capabilities, including credit_per_image

credit_by_resolutionobjectrequired

Credits 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_imageintegerrequired

Current credits per image at the model's default resolution. Example prices illustrate the response only; query this endpoint for live pricing.

descriptionstringrequired

Public model summary.

model_idstringrequired

Public model ID to send in image-generation requests.

paramsImageModelParamsrequired
aspect_ratioStringChoicesrequired
defaultstring | nullrequirednullable

Value used when the request omits this parameter.

valuesstring[]required

Currently accepted values for this model.

promptImagePromptCapabilityrequired
max_lengthintegerrequired

Maximum prompt characters for image generation or editing.

refsImageReferencesrequired
acceptstring[]required

Accepted reference kinds; currently image.

maxintegerrequired

Maximum reference images per request.

resolutionStringChoicesrequired
defaultstring | nullrequirednullable

Value used when the request omits this parameter.

valuesstring[]required

Currently accepted values for this model.

messagestring

Human-readable status message; "success" on a successful call.

Default: success

server_timestring · date-timerequired

Server-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

errorErrorDetailrequired
codeintegerrequired

Machine-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 | nullnullable

Optional 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 | nullnullable

Actionable 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.

messagestringrequired

Human-readable explanation of what went wrong. Safe to log or surface to end users; not localized.