Skip to content

Developers

OpenAI compatible

Developer documentation

Zenith is OpenAI-compatible. Point the official OpenAI SDK at Cloud or your self-hosted Gateway — there is no proprietary Zenith SDK.

Your Gateway domain

Enter the hostname your application uses to reach Zenith Gateway. Every Enterprise example below updates instantly.

Hostname only, or paste a full URL. Saved in this browser.

SDK openai (official)

Auth Authorization: Bearer <key>

Cloud base https://zenithgw.com/api/v1

Gateway base https://your-domain.demo/v1

Choose a path

Hosted Cloud and self-hosted Enterprise share the same OpenAI request shapes. They differ on base URL path prefix, how you obtain keys, and what the model field means.

Surface	Base URL for OpenAI SDK	API key	model field
Zenith Cloud	https://zenithgw.com/api/v1	zk_… from /app	auto or catalog id; BYOK uses openai/…
Enterprise Gateway	https://your-domain.demo/v1	Gateway API key	Pool alias (for example chat-pool)

Capability	Cloud /api/v1	Gateway /v1
Models, chat completions, responses	Supported	Supported
Embeddings, images, audio, moderations, rerank	Not hosted	Supported when configured
model field	auto or catalog model	Configured pool alias

What stays the same

Authorization: Bearer <api-key> on inference routes
POST …/chat/completions and GET …/models shapes
stream: true returns text/event-stream
tools, tool_choice, and response_format are accepted on chat and forwarded upstream

Where to go next

Getting started — first request in under five minutes
Cloud OpenAI SDK — hosted and Your Own Keys examples
Install Gateway — install.sh quick path and activation
Docker / Swarm — manual Compose and Swarm runbook
Gateway OpenAI SDK — pool aliases and the full /v1 surface
Cloud API reference — interactive Scalar at /docs/api/cloud
Gateway API reference — interactive Scalar at /docs/api/gateway