Skip to main content
An instance serves an OpenAI-compatible API at its gateway_url, and the Anthropic Messages API beside it. An OpenAI or Anthropic client works against it unchanged:
Beta. Every instance serves the models below, and models from other providers cannot be added.

Set Up

An instance serves models from Telnyx Inference as soon as it is ready, with nothing to add, and GET /v2/agent_gateways/{id}/models lists them. Requests name a model by the instance’s name for it, which differs from its Telnyx Inference model ID: A model has no settings of its own. Each key and team has: A request sets its own retries, timeout, and fallbacks.

Use

A request comes from a host on the instance’s Network, goes to gateway_url, and carries a key as a bearer token. The commands below read both from the host’s environment, as GATEWAY_URL and AGW_KEY.

List the Models

Host
Output

Send a Chat Completion

POST {gateway_url}/v1/chat/completions takes an OpenAI chat completion request:
Host
The instance answers in the OpenAI chat completion format:
Output
The models behave as they do on Telnyx Inference, including reasoning, streaming, and function calling.