API Reference
Images
Generate images from text prompts using leading image-generation models through the OpenAI-compatible endpoint.
Endpoint
http
POST https://api.tokspan.com/v1/images/generationsRequest Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| model | string | Yes | Model ID (e.g., dall-e-3, dall-e-2) |
| prompt | string | Yes | Text description of the desired image (max 4000 chars) |
| n | integer | No | Number of images to generate. Default: 1 |
| size | string | No | Image resolution. Supported sizes depend on the model — dall-e-2: 256x256, 512x512, 1024x1024; dall-e-3: 1024x1024, 1792x1024, 1024x1792 |
| quality | string | No | "standard" or "hd" (on supported image models) |
| response_format | string | No | "url" (default) or "b64_json" |
| style | string | No | "vivid" (default) or "natural" (on supported image models) |
Example
python
from openai import OpenAI
client = OpenAI(
api_key="sk-your-key",
base_url="https://api.tokspan.com/v1",
)
response = client.images.generate(
model="MODEL_NAME",
prompt="A serene mountain lake at sunset, digital art style",
n=1,
size="1024x1024",
)
print(response.data[0].url)Image Editing
http
POST https://api.tokspan.com/v1/images/edits| Parameter | Type | Required | Description |
|---|---|---|---|
| model | string | Yes | Model ID (e.g., dall-e-3, dall-e-2) |
| image | file | Yes | The input image to edit, as a multipart file upload (PNG, JPEG, WebP). |
| prompt | string | Yes | Text description of the desired edit (e.g., "add a red boat to the lake"). |
| mask | file | No | Optional mask image indicating the area to edit. Transparent areas are preserved. |
| n | integer | No | Number of images to generate. Default: 1 |
| size | string | No | Image resolution. Supported sizes depend on the model — dall-e-2: 256x256, 512x512, 1024x1024; dall-e-3: 1024x1024, 1792x1024, 1024x1792 |
| response_format | string | No | "url" (default) or "b64_json" |
python
from openai import OpenAI
client = OpenAI(
api_key="sk-your-key",
base_url="https://api.tokspan.com/v1",
)
response = client.images.edit(
model="MODEL_NAME",
image=open("input.png", "rb"),
prompt="Add a red boat to the lake",
)
print(response.data[0].url)Available Models
Supported image generation models include leading models from OpenAI and other providers. See the Models page for the current model availability and pricing.