API & Docs

Introduction#

Every request goes to a single base URL. Because the gateway speaks the OpenAI wire format, existing SDKs and tools work unchanged — you only swap the base URL and key.

Authentication#

Authenticate with a bearer token in the Authorization header. Create a sk--prefixed key on the API keys page — the secret is shown only once, so store it somewhere safe.

Authorization: Bearer sk-xxxxxxxxxxxxxxxxxxxxxxxx

Quickstart#

Send your first chat completion. Set WAYJET_API_KEY to your API key.

curl http://localhost:8080/v1/chat/completions \
  -H "Authorization: Bearer $WAYJET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4o",
    "messages": [{"role": "user", "content": "Hello"}]
  }'

Chat completions#

POST /v1/chat/completions — the core endpoint. Requests and responses follow the OpenAI schema; the gateway adds provider and cache_status to the response.

* required

Streaming#

Set stream: true to receive tokens as server-sent events. Each event is a data: line with a delta; the stream ends with data: [DONE].

curl http://localhost:8080/v1/chat/completions \
  -H "Authorization: Bearer $WAYJET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4o",
    "messages": [{"role": "user", "content": "Hello"}],
    "stream": true
  }'
# → server-sent events: lines of  data: {...}  terminated by  data: [DONE]

Embeddings#

POST /v1/embeddings — vectorize text for search and RAG. Accepts a string or an array of strings.

curl http://localhost:8080/v1/embeddings \
  -H "Authorization: Bearer $WAYJET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "text-embedding-3-small",
    "input": "The quick brown fox"
  }'

Audio (speech)#

POST /v1/audio/speech turns text into spoken audio (billed per input character), and POST /v1/audio/transcriptions turns an uploaded audio file into text (billed per audio-minute). Both are OpenAI-compatible.

Text-to-speech

curl http://localhost:8080/v1/audio/speech \
  -H "Authorization: Bearer $WAYJET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "tts-1",
    "input": "The quick brown fox jumped over the lazy dog.",
    "voice": "alloy"
  }' \
  --output speech.mp3

Speech-to-text

Upload the file as multipart/form-data. Set response_format to srt, vtt, or verbose_json for timestamped subtitles instead of plain text.

curl http://localhost:8080/v1/audio/transcriptions \
  -H "Authorization: Bearer $WAYJET_API_KEY" \
  -F "model=whisper-1" \
  -F "file=@audio.mp3" \
  -F "response_format=json"   # json (default) · text · srt · vtt · verbose_json

Models#

GET /v1/models returns the catalog available to your key, each with pricing and capability metadata.

curl http://localhost:8080/v1/models \
  -H "Authorization: Bearer $WAYJET_API_KEY"

CLI tools (Claude Code, Codex)#

The gateway speaks the Anthropic Messages API (POST /v1/messages) and the OpenAI Responses API (POST /v1/responses), so the popular coding CLIs point straight at WayJet and bill through your own key — no proxy, no per-vendor SDK. Point each tool at a model you can call.

Claude Code

Add to ~/.claude/settings.json. The key rides ANTHROPIC_AUTH_TOKEN (or ANTHROPIC_API_KEY as the x-api-key header), and each tier maps to a model of your choice.

{
  "hasCompletedOnboarding": true,
  "env": {
    "ANTHROPIC_BASE_URL": "http://localhost:8080",
    "ANTHROPIC_AUTH_TOKEN": "sk-your-key",
    "ANTHROPIC_DEFAULT_OPUS_MODEL": "your-opus-squad",
    "ANTHROPIC_DEFAULT_SONNET_MODEL": "your-sonnet-squad",
    "ANTHROPIC_DEFAULT_HAIKU_MODEL": "your-haiku-squad"
  }
}

Codex

Codex uses the OpenAI Responses API by default — no wire_api = "chat" override needed.

model = "your-squad"
model_provider = "wayjet"

[model_providers.wayjet]
name = "WayJet"
base_url = "http://localhost:8080/v1"
wire_api = "responses"

{
  "auth_mode": "apikey",
  "OPENAI_API_KEY": "sk-your-key"
}

Tip: append :online to a model name for live web search, or pass models: ["fallback"] for automatic fallback.

Errors#

Errors use standard HTTP status codes and an OpenAI-style envelope.

{
  "error": {
    "message": "Incorrect API key provided.",
    "type": "authentication_error",
    "code": null,
    "param": null
  }
}

Endpoints#

The endpoints you can call with an API key. Keys, usage, and budgets are managed from the dashboard.

Changelog#

Notable changes to the public API. The base URL stays /v1 for backward compatibility.

• Jul 2026CLI tools: use Claude Code (/v1/messages) and Codex (/v1/responses) directly. Web search via :online, request-level models[] fallback, and generation stats (/v1/generation).
• Jul 2026Audio: text-to-speech (/v1/audio/speech) and speech-to-text (/v1/audio/transcriptions, with srt/vtt/verbose_json formats).
• Jun 2026Provider passthrough (/p/{provider}) documented; reasoning_effort added.
• May 2026Embeddings endpoint + JSON mode (response_format) support.
• Apr 2026Streaming (SSE) on chat completions; provider pinning.