TopviewAI Pro Studio API guide
Manage API keys and understand signed-in Studio requests. The image endpoint example below uses GPT Image 2.5; other models have their own request formats.
https://topviewai.proQuick Start
Complete your first API call in just two steps: submit a generation task, then poll for status.
Submit Task
Send a POST request to the generate endpoint to get a Task ID.
Query Status
Use the Task ID to check progress until you get the image URL.
Authentication
These Studio endpoints require a signed-in session and an API key. A Bearer key alone is not sufficient. Keep your key private.
Authorization: Bearer {YOUR_API_KEY}/api/image/gpt-image-2-5/generateSubmit a GPT Image 2.5 image request. The response returns a task_id; query the matching status endpoint for results.
Body Parameters
| Parameter Name | Type | Required | Description |
|---|---|---|---|
prompt | string | Yes | Describe the image in 1–20,000 characters. |
aspect_ratio | string | No | Optional aspect ratio; defaults to auto. Examples: 1:1, 4:3, 3:4, 16:9, 9:16. |
{
"code": 200,
"message": "success",
"data": {
"task_id": "task_1234567890",
"status": "IN_PROGRESS"
}
}/api/image/gpt-image-2-5/statusQuery the execution status and results of a task.
Query Parameters
| Parameter Name | Required | Description |
|---|---|---|
task_id | Yes | The ID returned when submitting the task. |
{
"code": 200,
"message": "success",
"data": {
"status": "SUCCESS",
"task_id": "xxxxxxxx",
"request": {
"prompt": "A sunset over mountains",
"aspect_ratio": "16:9"
},
"response": [
"https://cdn.example.com/images/task_xxx_0.jpeg"
],
"consumed_credits": 4,
"created_at": "2026-11-05 13:05:09",
"error_message": null
}
}Billing
GPT Image 2.5 example cost
Costs vary by model, resolution and settings. Check the Studio estimate and the task’s reported credit usage.
Error Handling
401 UnauthorizedInvalid API Key402 Payment RequiredInsufficient balance429 Too Many RequestsRate limit triggered
About TopviewAI Pro
A shared Studio for video, images, editing, speech and audio.
Choose the model for each job
Use Seedance 2.5 for video, GPT Image 2.5 for images and the other models listed in the Studio. Each model keeps its real name.
One credit balance, model-specific costs
Choose a subscription or a one-time pay-as-you-go top-up. Credits pay for the models and tools you actually use.