API documentation
Rocket Relay is compatible with OpenAI-style client integrations. Point your SDK to the relay endpoint, authenticate with a Rocket Relay API key, and route traffic across models with one integration surface.
Keep your existing client SDK and replace the base URL with Rocket Relay.
Standard balance billing
BYOK routing (use credentials from your own pool)
Point any OpenAI-compatible client at /byok/v1. The upstream provider is inferred from the requested model, just like the shared pool — call a Claude model and your Anthropic key is used; call a GPT model and your OpenAI key is used.
curl https://relay.rcapalpha.com/v1/chat/completions \
-H "Authorization: Bearer sk-rr-YOUR-KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "claude-sonnet-4-6",
"messages": [{"role": "user", "content": "Summarize our changelog"}]
}'Rocket Relay normalizes reasoning controls across OpenAI, Claude, Gemini, Kimi, DeepSeek, and xAI-compatible upstreams. The relay recognizes the controls below, but the exact values accepted by a request depend on the selected model.
| Control | Standard budget equivalent | Behavior |
|---|---|---|
| none | 0 | Disables reasoning when the selected model allows it. |
| auto | -1 | Uses dynamic reasoning, or a model-appropriate fallback when dynamic mode is unavailable. |
| minimal | 512 | Minimum standardized reasoning effort. |
| low | 1,024 | Fast responses with lighter reasoning. |
| medium | 8,192 | Balanced speed and reasoning depth. |
| high | 24,576 | Greater reasoning depth for complex tasks. |
| xhigh | 32,768 | Extra-high reasoning depth on supported models. |
| max | 128,000 | Maximum available reasoning depth on supported models. |
OpenAI-compatible request
curl https://relay.rcapalpha.com/v1/chat/completions \
-H "Authorization: Bearer sk-rr-YOUR-KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "gpt-5.4",
"messages": [{"role": "user", "content": "Solve this carefully"}],
"reasoning_effort": "high"
}'Responses API request
curl https://relay.rcapalpha.com/v1/responses \
-H "Authorization: Bearer sk-rr-YOUR-KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "gpt-5.4",
"input": "Solve this carefully",
"reasoning": {"effort": "high"}
}'You can also append a control or numeric token budget to the model name, for example gpt-5.4(high), gemini-3.5-flash(minimal), claude-opus-4-8(max), or gemini-2.5-pro(8192).
Typical model-family support: OpenAI/Codex models generally accept low, medium, high, and xhigh, with selected newer models adding max; Claude adaptive-thinking models use low through max; Gemini 3 models use a model-specific subset of minimal through high; Kimi and most xAI reasoning models use low, medium, and high; DeepSeek V4 uses high and max.
Unsupported request-body levels return a validation error for the target model. Numeric budgets and model-name suffixes may be converted or clamped to that model's supported range. ultrais not currently accepted by the relay's unified reasoning parser; use max as the highest documented control.
Use gpt-image-2 on the Images API endpoints. Chat and text-generation requests should continue to use text models such as gpt-5.5 orclaude-sonnet-4-6.
Generate an image
curl https://relay.rcapalpha.com/v1/images/generations \
-H "Authorization: Bearer sk-rr-YOUR-KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "gpt-image-2",
"prompt": "A clean product render of a transparent glass teapot on a walnut table",
"size": "1024x1024",
"response_format": "b64_json"
}'Edit an image
curl https://relay.rcapalpha.com/v1/images/edits \ -H "Authorization: Bearer sk-rr-YOUR-KEY" \ -F model="gpt-image-2" \ -F image="@input.png" \ -F prompt="Replace the background with a bright studio setup" \ -F response_format="b64_json"
GPT Image 2 is billed from image-token usage. Official list pricing is $8 input, $2 cached input, and $30 output per 1M image tokens; Rocket Relay shows the configured sell-side price in the model catalog below.
If your tool only supports an OpenAI-style base URL and API key, switch the base URL to a BYOK endpoint instead of adding custom headers.
| Use case | Base URL |
|---|---|
| Standard shared upstream billing | https://relay.rcapalpha.com/v1 |
| BYOK (use credentials from your own pool) | https://relay.rcapalpha.com/byok/v1 |
`/byok/v1` is the single BYOK entry point. The upstream provider is chosen from the model name (e.g. `gpt-5.5` → your OpenAI key, `claude-sonnet-4-6` → your Anthropic key). Requests that map to a provider you have not stored a credential for return an error — they are never served from the shared account pool.
| Method | Endpoint | Description |
|---|---|---|
| POST | /v1/chat/completions | OpenAI-compatible chat completions |
| POST | /v1/messages | Claude Messages API compatibility |
| POST | /v1/embeddings | Embeddings and vector-ready workflows |
| POST | /v1/images/generations | GPT Image 2 image generation |
| POST | /v1/images/edits | GPT Image 2 image edits with multipart or JSON image inputs |
| GET | /v1/models | Available models exposed by the relay |
| ANY | /byok/v1/... | Same OpenAI-compatible endpoints, but forced through your stored BYOK credential pool (provider chosen from the requested model) |
| Tier | RPM | TPM |
|---|---|---|
| Starter | 60 | 100,000 |
| Professional | 300 | 500,000 |
| Enterprise | 1,000 | 2,000,000 |
Response headers include `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset`.
Loading model catalog...