Image Generation/Get Image Models

Get Image Models

GET/api/v1/image/models

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 one at OpenApi (Pro plan and up).

Response

200Successful Response

Successful calls return a standard envelope: the endpoint payload under data (its fields are documented below), plus a message string ("success") and an ISO 8601 server_time.

Response fields (data)

modelsarray of ImageModelDtoRequired

Machine-readable model capabilities, including credit_per_image

Show 5 propertiesHide 5 properties

model_idstringRequired

Public model ID to send in image-generation requests.

descriptionstringRequired

Public model summary.

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.

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.

paramsImageModelParamsRequired

Allowed image parameters and defaults.

Show 4 propertiesHide 4 properties

promptImagePromptCapabilityRequired

Prompt-length limit.

Show 1 propertyHide 1 property

max_lengthintegerRequired

Maximum prompt characters for image generation or editing.

aspect_ratioStringChoicesRequired

Supported image aspect ratios and default.

Show 2 propertiesHide 2 properties

valuesarray of stringRequired

Currently accepted values for this model.

defaultstring | nullRequired

Value used when the request omits this parameter.

resolutionStringChoicesRequired

Supported output sizes and default.

Show 2 propertiesHide 2 properties

valuesarray of stringRequired

Currently accepted values for this model.

defaultstring | nullRequired

Value used when the request omits this parameter.

refsImageReferencesRequired

Reference-image count and accepted kinds.

Show 2 propertiesHide 2 properties

maxintegerRequired

Maximum reference images per request.

acceptarray of stringRequired

Accepted reference kinds; currently image.

Errors

All error responses share one JSON 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 (handy for AI agents).

errorErrorDetailRequired

Error payload returned with every non-2xx response. Present only on failure; successful calls use the standard success envelope instead.

Show 4 propertiesHide 4 properties

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.

messagestringRequired

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

detailsstring | nullOptional

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

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.

Request

curl -X GET 'https://openapi.visionstory.ai/api/v1/image/models' \
  -H 'X-API-Key: sk-vs-xxxxxxxxxxxxxxxxxxx'

import requests

url = "https://openapi.visionstory.ai/api/v1/image/models"
headers = {
    "X-API-Key": "sk-vs-xxxxxxxxxxxxxxxxxxx",
}
response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch("https://openapi.visionstory.ai/api/v1/image/models", {
  method: "GET",
  headers: {
    "X-API-Key": "sk-vs-xxxxxxxxxxxxxxxxxxx",
  },
});
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://openapi.visionstory.ai/api/v1/image/models", nil)
	req.Header.Set("X-API-Key", "sk-vs-xxxxxxxxxxxxxxxxxxx")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://openapi.visionstory.ai/api/v1/image/models"))
    .header("X-API-Key", "sk-vs-xxxxxxxxxxxxxxxxxxx")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

<?php
$ch = curl_init("https://openapi.visionstory.ai/api/v1/image/models");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "X-API-Key: sk-vs-xxxxxxxxxxxxxxxxxxx",
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

require "net/http"
require "uri"

uri = URI("https://openapi.visionstory.ai/api/v1/image/models")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request["X-API-Key"] = "sk-vs-xxxxxxxxxxxxxxxxxxx"
response = http.request(request)
puts response.body

import Foundation

var request = URLRequest(url: URL(string: "https://openapi.visionstory.ai/api/v1/image/models")!)
request.httpMethod = "GET"
request.setValue("sk-vs-xxxxxxxxxxxxxxxxxxx", forHTTPHeaderField: "X-API-Key")
let (data, _) = try await URLSession.shared.data(for: request)
print(String(data: data, encoding: .utf8) ?? "")

using System;
using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://openapi.visionstory.ai/api/v1/image/models");
request.Headers.Add("X-API-Key", "sk-vs-xxxxxxxxxxxxxxxxxxx");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Response

200

{
  "data": {
    "models": [
      {
        "model_id": "nano-banana-2",
        "description": "Balanced quality and speed, strong instruction-following edits.",
        "credit_per_image": 2,
        "credit_by_resolution": {
          "1K": 2,
          "2K": 2
        },
        "params": {
          "prompt": {
            "max_length": 5000
          },
          "aspect_ratio": {
            "values": [
              "1:1",
              "2:3",
              "3:2",
              "3:4",
              "4:3",
              "4:5",
              "5:4",
              "9:16",
              "16:9",
              "21:9"
            ],
            "default": "1:1"
          },
          "resolution": {
            "values": [
              "1K",
              "2K"
            ],
            "default": "1K"
          },
          "refs": {
            "max": 4,
            "accept": [
              "image"
            ]
          }
        }
      },
      {
        "model_id": "nano-banana-pro",
        "description": "Highest quality tier, best for detailed scenes; supports 2K output.",
        "credit_per_image": 3,
        "credit_by_resolution": {
          "1K": 3,
          "2K": 3
        },
        "params": {
          "prompt": {
            "max_length": 5000
          },
          "aspect_ratio": {
            "values": [
              "1:1",
              "2:3",
              "3:2",
              "3:4",
              "4:3",
              "4:5",
              "5:4",
              "9:16",
              "16:9",
              "21:9"
            ],
            "default": "1:1"
          },
          "resolution": {
            "values": [
              "1K",
              "2K"
            ],
            "default": "1K"
          },
          "refs": {
            "max": 4,
            "accept": [
              "image"
            ]
          }
        }
      },
      {
        "model_id": "seedream-5.0-lite",
        "description": "Fast and economical; 2K or 4K output at the same price.",
        "credit_per_image": 1,
        "credit_by_resolution": {
          "2K": 1,
          "4K": 1
        },
        "params": {
          "prompt": {
            "max_length": 3000
          },
          "aspect_ratio": {
            "values": [
              "1:1",
              "2:3",
              "3:2",
              "3:4",
              "4:3",
              "4:5",
              "5:4",
              "9:16",
              "16:9",
              "21:9"
            ],
            "default": "1:1"
          },
          "resolution": {
            "values": [
              "2K",
              "4K"
            ],
            "default": "2K"
          },
          "refs": {
            "max": 14,
            "accept": [
              "image"
            ]
          }
        }
      },
      {
        "model_id": "seedream-5.0-pro",
        "description": "Higher-fidelity Seedream tier; 1K by default, 2K on request.",
        "credit_per_image": 2,
        "credit_by_resolution": {
          "1K": 2,
          "2K": 2
        },
        "params": {
          "prompt": {
            "max_length": 3000
          },
          "aspect_ratio": {
            "values": [
              "1:1",
              "2:3",
              "3:2",
              "3:4",
              "4:3",
              "4:5",
              "5:4",
              "9:16",
              "16:9",
              "21:9"
            ],
            "default": "1:1"
          },
          "resolution": {
            "values": [
              "1K",
              "2K"
            ],
            "default": "1K"
          },
          "refs": {
            "max": 10,
            "accept": [
              "image"
            ]
          }
        }
      },
      {
        "model_id": "gpt-image-2.5-flare",
        "description": "OpenAI GPT Image 2.5 Flare: fast, high-quality generation and edits.",
        "credit_per_image": 2,
        "credit_by_resolution": {
          "1K": 2,
          "2K": 3
        },
        "params": {
          "prompt": {
            "max_length": 5000
          },
          "aspect_ratio": {
            "values": [
              "1:1",
              "2:3",
              "3:2",
              "3:4",
              "4:3",
              "4:5",
              "5:4",
              "9:16",
              "16:9",
              "21:9"
            ],
            "default": "1:1"
          },
          "resolution": {
            "values": [
              "1K",
              "2K"
            ],
            "default": "1K"
          },
          "refs": {
            "max": 6,
            "accept": [
              "image"
            ]
          }
        }
      },
      {
        "model_id": "gpt-image-2.5-sunburst",
        "description": "OpenAI GPT Image 2.5 Sunburst: most capable GPT Image model, best for precise edits; slower than Flare.",
        "credit_per_image": 2,
        "credit_by_resolution": {
          "1K": 2,
          "2K": 3
        },
        "params": {
          "prompt": {
            "max_length": 5000
          },
          "aspect_ratio": {
            "values": [
              "1:1",
              "2:3",
              "3:2",
              "3:4",
              "4:3",
              "4:5",
              "5:4",
              "9:16",
              "16:9",
              "21:9"
            ],
            "default": "1:1"
          },
          "resolution": {
            "values": [
              "1K",
              "2K"
            ],
            "default": "1K"
          },
          "refs": {
            "max": 6,
            "accept": [
              "image"
            ]
          }
        }
      },
      {
        "model_id": "gpt-image-2",
        "description": "OpenAI GPT Image 2: previous-generation GPT Image model.",
        "credit_per_image": 2,
        "credit_by_resolution": {
          "1K": 2,
          "2K": 3
        },
        "params": {
          "prompt": {
            "max_length": 5000
          },
          "aspect_ratio": {
            "values": [
              "1:1",
              "2:3",
              "3:2",
              "3:4",
              "4:3",
              "4:5",
              "5:4",
              "9:16",
              "16:9",
              "21:9"
            ],
            "default": "1:1"
          },
          "resolution": {
            "values": [
              "1K",
              "2K"
            ],
            "default": "1K"
          },
          "refs": {
            "max": 6,
            "accept": [
              "image"
            ]
          }
        }
      }
    ]
  },
  "message": "success",
  "server_time": "2026-09-04T00:00:00Z"
}