1. Prepare your Allgate API key
The setup command asks for your full key with hidden input, then saves and configures the agent credential automatically.
01Developer experience
From your first request to production: connect your SDK, choose a model and protocol, and keep usage and cost in view.
Keep your SDK. Check parameters and capabilities per model.
A new destination for your requests
https://api.allgate.ai/v1# export ALLGATE_API_KEY='YOUR_ALLGATE_API_KEY'curl --fail-with-body 'https://api.allgate.ai/v1/chat/completions' \ -H "Authorization: Bearer $ALLGATE_API_KEY" \ -H "Content-Type: application/json" \ --data-raw '{ "model": "gpt-5.5", "messages": [ { "role": "user", "content": "Hello, Allgate!" } ]}'Each protocol has its own request format.
/v1/chat/completionsResponses/v1/responsesAnthropic Messages/v1/messagesExample model: gpt-5.5Selected from available chat models. Check the catalogue for capabilities and pricing.
Your coding agent, through Allgate
Configure the native API, model and API key for Claude Code or Codex in one setup flow.
https://api.allgate.ai/v1Install a current agent CLI first. macOS / Linux need Bash 3.2+, curl and standard system tools; Windows needs PowerShell 5.1+. Codex configuration is verified with 0.163 and requires separate profile files and command-backed credentials.
Create a key in your account, then return here to configure your agent.
Create an Allgate keybash <(curl -fsSL https://allgate.ai/setup/allgate-setup.sh) --agent 'codex' --model 'gpt-5.5' --base-url 'https://api.allgate.ai' After running the command, paste your key at “Allgate API key (hidden)” and press Enter.
codex --profile allgateCodex uses a separate allgate.config.toml, preserving your default configuration and sign-in.
The setup command asks for your full key with hidden input, then saves and configures the agent credential automatically.
Keep unrelated settings and permission rules. Matching configuration is left alone. Restore with the exact backup directory printed by setup.
Setup checks the public catalogue and configures local credentials. It makes no model call. Your first message is billed by actual usage.
02 / Choose. Connect. Verify.
Check availability and pricing units, create a key, then verify the result, usage and cost in your request logs.
Find its current availability, exact model ID and pricing unit in the catalogue. The broader model library is a reference, not a list of callable models.
Explore the catalogueSign in, create an API key and set model allowlists, quota and RPM / TPM. Save the full key when it is created and keep it on your server.
Manage API keysGet your configuration in the connection workspace. Send a first request, then check the model, status and cost in your logs. Real model calls are billed by usage.
Open the connection workspaceExport your Allgate key before running the example above. The Python and Node.js tabs include their install commands. Replace the placeholder key with your own.
export ALLGATE_BASE_URL='https://api.allgate.ai/v1'
export ALLGATE_API_KEY='YOUR_ALLGATE_API_KEY' 03 / Work with familiar tools
Compatibility describes the request protocol. Tool calls, structured output, image input and individual parameters still depend on the model and upstream capabilities.
Use the official openai packages for Python and Node.js. The SDK base URL includes /v1. Authenticate with Authorization: Bearer and your Allgate key.
https://api.allgate.ai/v1POST /v1/chat/completionsPOST /v1/responsesSend a Messages-shaped request to /v1/messages. Our HTTP examples use Authorization: Bearer. With the Anthropic SDK, set the API origin as the base URL; do not add /v1 twice.
https://api.allgate.aiPOST /v1/messagesAuthorization: Bearer $ALLGATE_API_KEYVerify model, protocol and parameter support before moving production traffic.
04 / Language meets multimodal
These capabilities are covered by the gateway documentation. Counts reflect the current available catalogue; a documented endpoint does not guarantee model supply.
Chat, code, analysis and agents. Check context, tool support and output formats against the task you are building.
/v1/chat/completions Turn a prompt into an image. Check which sizes, counts and response formats your chosen model actually supports.
/v1/images/generations Create an asynchronous task, then poll its status. Read the result after success, and avoid creating the same task twice.
/v1/videos/generations Speech synthesis and transcription have API references. Confirm model supply, voices, formats and pricing units before integrating.
/v1/audio/speech /v1/audio/transcriptions Embeddings and reranking use their own models and request formats.
05 / From a request to a product
Keep keys out of websites, mobile bundles and public repositories. Separate environments and apply model and quota limits. Revoke and rotate a key if it leaks.
Authentication & securityRequest SSE with stream: true and consume events incrementally. Chat, Messages and Responses have different terminators. Inspect a failed stream before deciding to repeat it.
Streaming protocolsOn 429, respect Retry-After and use bounded backoff. Check credentials for 401, balance or quota for 402, and model access for 404. Avoid blindly replaying generation jobs.
Errors & rate limitsRecord x-allgate-request-id. Unary responses expose x-allgate-cost-micros; reconcile final usage and charges in console logs. Pricing units come from the catalogue.
View request logs06 / Questions
For standard chat calls, keep the SDK and change the base URL, Allgate key and model ID. Validate your parameters, tools and stream handling first. Other endpoints follow their individual reference formats.
The model library is a broader reference. The model catalogue is the source for callable models, availability and public pricing. Examples select an available chat model; your key allowlist may further restrict access.
Video creation returns a task ID. Poll /v1/videos/generations/{id} with the same key, handle success or failure states, and set a reasonable polling interval and deadline.
Protocol compatibility, model availability and model capabilities are separate checks. Language, images, video, audio, embeddings and reranking also have different inputs, outputs and pricing units.
Request shapes, streaming events, errors and limits. Validate the details for your workflow.
Catalogue snapshot: · Public model data · Models and prices · Image and video Studio · API reference