Integrate Figviz diagram generation into your applications via REST API
All API requests require an API key passed via the Authorization header.
Authorization: Bearer cvk_your_api_key_hereYou can create and manage API keys in your Settings > API Keys dashboard.
Your API key grants full access to your account credits. Keep it secret and never expose it in client-side code.
https://figviz.com/api/v1POST /api/v1/generate
Generate one or more scientific diagrams from text prompts.
| Parameter | Type | Required | Description |
|---|---|---|---|
prompt | string | Yes* | A single text prompt describing the diagram |
prompts | string[] | Yes* | Array of prompts for batch generation (max 4) |
quality | string | No | Image resolution: "1k" (default), "2k", or "4k" |
aspectRatio | string | No | Aspect ratio (e.g. "16:9", "1:1") |
Provide either prompt (single) or prompts (batch) — not both. If both are provided, prompts takes priority.
{
"images": [
{
"url": "https://cdn.figviz.io/generated/abc123.png",
"prompt": "water cycle diagram"
}
],
"credits_used": 1,
"credits_remaining": 79
}| Quality | Credits per Image |
|---|---|
1k | 1 |
2k | 1 |
4k | 1.5 |
Only successfully generated images consume credits. Failed images in a batch request are not charged.
curl -X POST https://figviz.com/api/v1/generate \
-H "Authorization: Bearer cvk_your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"prompt": "water cycle diagram showing evaporation, condensation, and precipitation",
"quality": "2k"
}'import requests
response = requests.post(
"https://figviz.com/api/v1/generate",
headers={
"Authorization": "Bearer cvk_your_api_key_here",
"Content-Type": "application/json",
const response = await fetch("https://figviz.com/api/v1/generate", {
method: "POST",
headers: {
"Authorization": "Bearer cvk_your_api_key_here",
"Content-Type": "application/json",
},
body:
curl -X POST https://figviz.com/api/v1/generate \
-H "Authorization: Bearer cvk_your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"prompts": [
"solar system diagram",
"food web diagram for grassland ecosystem",
"human digestive system"
],
"quality": "1k"
}'The API returns standard HTTP status codes with JSON error bodies:
{
"error": "Human-readable error message",
"code": "ERROR_CODE"
}| HTTP Status | Code | Description |
|---|---|---|
400 | INVALID_BODY | Request body is not valid JSON |
400 | PROMPT_REQUIRED | No prompt or prompts provided |
400 | TOO_MANY_PROMPTS | More than 4 prompts in one request |
401 | UNAUTHORIZED | Missing or invalid Authorization header |
401 | INVALID_API_KEY | API key is invalid or disabled |
402 | INSUFFICIENT_CREDITS | Not enough credits (includes credits_remaining) |
403 | PLAN_LIMIT_EXCEEDED | Batch size exceeds your plan limit |
403 | QUALITY_NOT_ALLOWED | Requested quality not available on your plan |
500 | GENERATION_FAILED | Image generation failed |
504 | GENERATION_TIMEOUT | Generation timed out (>5 min) |
response = requests.post(url, headers=headers, json=payload)
if response.status_code == 402:
data = response.json()
print(f"Not enough credits. Remaining:
| Constraint | Value |
|---|---|
| Max images per request | 4 |
| Max API keys per account | 5 |
| Request timeout | 5 minutes |
| Available qualities | Depends on your plan |