API-Zeno Docs
Choose the capability you want to integrate
Select a configuration or API category from the sidebar to view API-Zeno authentication, Base URLs, request paths, code examples, and capability boundaries.
Setup
Personal user setup guide
Register an api-zeno account, purchase quota, create an API Key, fill in connection details, and troubleshoot common setup issues.
Method
GUIDEEndpoint
Console / API KeysBase URL
https://api-zeno.com/v1Auth
api-zeno user sessionNotes
- Register an api-zeno account and complete email verification.
- Purchase a plan or enable usage-based billing, then confirm available quota.
- Create an API Key and configure group, quota, expiration, and permissions.
- Enter the API Key and Base URL in a tool or client that supports OpenAI-compatible APIs.
Setup
Quickstart
Use one Chat Completions request to verify your key, quota, model, and channel routing.
Method
POSTEndpoint
/v1/chat/completionsBase URL
https://api.api-zeno.com/v1Auth
Authorization: Bearer $API_ZENO_KEYNotes
- Create an API Key in the console.
- Set your SDK or tool Base URL to https://api.api-zeno.com/v1.
- Run a small model request before integrating production workloads.
Example
curl https://api.api-zeno.com/v1/chat/completions \
-H "Authorization: Bearer $API_ZENO_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "gpt-4o-mini",
"messages": [
{ "role": "user", "content": "Hello API-Zeno" }
]
}'Setup
Auth and Base URL
Gateway calls use API Key auth. Console APIs use user or admin sessions.
Method
HEADEREndpoint
AuthorizationBase URL
https://api.api-zeno.com/v1Auth
Bearer API KeyNotes
- Model calls: Authorization: Bearer $API_ZENO_KEY.
- OpenAI-compatible paths: https://api.api-zeno.com/v1.
- Gemini-compatible paths: https://api.api-zeno.com/v1beta.
- Console and admin APIs use login sessions instead of model API Keys.
Model Gateway
Chat Completions
OpenAI Chat Completions compatible entrypoint for chat, tool calls, JSON output, and regular app integration.
Method
POSTEndpoint
/v1/chat/completionsBase URL
https://api.api-zeno.com/v1Auth
Authorization: Bearer $API_ZENO_KEYNotes
- The model must be configured in model, channel, or account-pool settings.
- Requests go through API-Zeno quota, logs, channel scheduling, and billing.
- Routing to different upstream protocols depends on admin configuration.
Example
import OpenAI from "openai";
const client = new OpenAI({
apiKey: process.env.API_ZENO_KEY,
baseURL: "https://api.api-zeno.com/v1",
});
const result = await client.chat.completions.create({
model: "gpt-4o-mini",
messages: [{ role: "user", content: "Hello API-Zeno" }],
});
console.log(result.choices[0]?.message?.content);from openai import OpenAI
client = OpenAI(
api_key="YOUR_API_ZENO_KEY",
base_url="https://api.api-zeno.com/v1",
)
result = client.chat.completions.create(
model="gpt-4o-mini",
messages=[{"role": "user", "content": "Hello API-Zeno"}],
)
print(result.choices[0].message.content)Model Gateway
Responses
For Responses-style clients, tools, multimodal inputs, and clients that need a Responses-shaped API.
Method
POSTEndpoint
/v1/responsesBase URL
https://api.api-zeno.com/v1Auth
Authorization: Bearer $API_ZENO_KEYNotes
- Supports normal and streaming responses.
- Can work with sticky sessions and Responses WebSocket compatibility when enabled.
- Also provides /v1/responses/compact as a compact helper.
Example
curl https://api.api-zeno.com/v1/responses \
-H "Authorization: Bearer $API_ZENO_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "gpt-4o-mini",
"input": "Summarize API-Zeno in one paragraph"
}'Protocols
Claude Messages
Keep the Claude Messages request shape while using API-Zeno keys, quota, logs, and channel scheduling.
Method
POSTEndpoint
/v1/messagesBase URL
https://api.api-zeno.com/v1Auth
Authorization: Bearer $API_ZENO_KEYNotes
- Keep the Messages request body shape.
- Model name and channel capability must be configured by admins.
- This is native passthrough, not a promise of arbitrary protocol conversion.
Example
curl https://api.api-zeno.com/v1/messages \
-H "Authorization: Bearer $API_ZENO_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "claude-sonnet-4-6",
"max_tokens": 256,
"messages": [
{ "role": "user", "content": "Hello Claude" }
]
}'Protocols
Gemini generateContent
Gemini-style generateContent and streamGenerateContent entrypoints authenticated by API-Zeno API Key.
Method
POSTEndpoint
/v1beta/models/{model}:generateContentBase URL
https://api.api-zeno.com/v1betaAuth
Authorization: Bearer $API_ZENO_KEYNotes
- Supports generateContent and streamGenerateContent.
- Model is part of the path, for example /models/gemini-2.0-flash:generateContent.
- Upstream accounts, channels, and groups are configured in admin.
Example
curl https://api.api-zeno.com/v1beta/models/gemini-2.0-flash:generateContent \
-H "Authorization: Bearer $API_ZENO_KEY" \
-H "Content-Type: application/json" \
-d '{
"contents": [
{ "role": "user", "parts": [{ "text": "Hello Gemini" }] }
]
}'Protocols
Embeddings
Vectorize text for retrieval, RAG ingestion, and similarity processing.
Method
POSTEndpoint
/v1/embeddingsBase URL
https://api.api-zeno.com/v1Auth
Authorization: Bearer $API_ZENO_KEYNotes
- Embedding models need their own price, channel, and permission configuration.
- Calls are included in logs and quota accounting.
Example
curl https://api.api-zeno.com/v1/embeddings \
-H "Authorization: Bearer $API_ZENO_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "text-embedding-3-small",
"input": "API-Zeno protocol coverage"
}'Media
Image generation and editing
OpenAI-style paths for image generation, image edits, and image variations.
Method
POSTEndpoint
/v1/images/generationsBase URL
https://api.api-zeno.com/v1Auth
Authorization: Bearer $API_ZENO_KEYNotes
- Common paths: /v1/images/generations, /v1/images/edits, /v1/images/variations.
- Exact parameters depend on upstream model and channel configuration.
- Image capability can also be used through Creator tasks.
Example
curl https://api.api-zeno.com/v1/images/generations \
-H "Authorization: Bearer $API_ZENO_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "gpt-image-1",
"prompt": "A clean API gateway diagram",
"size": "1024x1024"
}'Media
Audio APIs
Speech generation, transcription, and translation style audio entrypoints.
Method
POSTEndpoint
/v1/audio/speechBase URL
https://api.api-zeno.com/v1Auth
Authorization: Bearer $API_ZENO_KEYNotes
- Common paths: /v1/audio/speech, /v1/audio/transcriptions, /v1/audio/translations.
- File upload endpoints use multipart/form-data.
Example
curl https://api.api-zeno.com/v1/audio/speech \
-H "Authorization: Bearer $API_ZENO_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "tts-1",
"voice": "alloy",
"input": "API-Zeno is ready."
}' --output speech.mp3Media
Video tasks
Submit video generation tasks and query task status.
Method
POSTEndpoint
/v1/video/generationsBase URL
https://api.api-zeno.com/v1Auth
Authorization: Bearer $API_ZENO_KEYNotes
- Submit task: POST /v1/video/generations.
- Query task: GET /v1/video/generations/{task_id}.
- Model capability, task fields, and return shape depend on configured upstreams.
Example
curl https://api.api-zeno.com/v1/video/generations \
-H "Authorization: Bearer $API_ZENO_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "kling-v1",
"prompt": "A clean product walkthrough video for an API gateway"
}'Protocols
Rerank
Rerank retrieval results for search, RAG, and knowledge-base ranking.
Method
POSTEndpoint
/v1/rerankBase URL
https://api.api-zeno.com/v1Auth
Authorization: Bearer $API_ZENO_KEYNotes
- Request body contains query and documents.
- Model, price, and channel must be configured in admin.
Example
curl https://api.api-zeno.com/v1/rerank \
-H "Authorization: Bearer $API_ZENO_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "bge-reranker-large",
"query": "gateway billing trace",
"documents": [
"API logs include request_id and channel_id.",
"Frontend theme settings are stored locally."
]
}'Console APIs
User Console APIs
Manage profile, API Keys, quota, logs, wallet, subscription, and creator tasks after user login.
Method
SESSIONEndpoint
/api/console/*Base URL
https://api.api-zeno.comAuth
User login sessionNotes
- /api/console/profile: user profile.
- /api/console/keys: list, create, update, disable, and delete API Keys.
- /api/console/billing-groups: available groups.
- /api/console/quota/today: today's quota.
- /api/console/logs: request logs.
- /api/console/wallet and /api/console/subscription: wallet and subscription.
Console APIs
Admin operations APIs
Admins manage channels, account pools, model prices, logs, risk controls, system settings, and operations data.
Method
SESSIONEndpoint
/api/admin/*Base URL
https://api.api-zeno.comAuth
Admin login sessionNotes
- /api/admin/channels: channels and key pools.
- /api/admin/accounts: account pools.
- /api/admin/pricing: model pricing.
- /api/admin/logs: request logs.
- /api/admin/monitor: runtime monitor.
- /api/admin/ops: risk and operations overview.
- /api/admin/system: system settings.
Partnership
Become a Zeno Reseller
For channel partners who want to promote API-Zeno plans, model quota, and enterprise integration to customers.
Method
APPLYEndpoint
/auth/registerBase URL
https://api.api-zeno.comAuth
Register and contact platform operationsNotes
- Create an account and complete basic profile information for partner verification.
- Resellers can promote plans, API Key access, and enterprise model aggregation solutions to customers.
- Contact API-Zeno operations for dedicated pricing, settlement periods, customer attribution, or white-label support.