Quickstart

Coding agents

The Ramp CLI points Claude Code, Codex, OpenCode, and Pi at Router models. Create a key from API keys, then install the CLI and configure it in one command:

curl -fsSL https://agents.ramp.com/install.sh | sh && \
  ramp router configure --api-key 'your-router-key'

Re-run it when new models are added to refresh your agent configuration. On Windows, run it in Git Bash.

Setup also installs a Claude Code status line that shows your session's actual Router cost next to what the same tokens would have cost at Claude Opus 5 list prices — server-computed figures, since Claude Code's own estimate misprices Router-served model aliases. When Switchyard routing is enabled, the status line shows that mode above the cost comparison. On any failure it degrades to the plain model name.

The rest of this quickstart walks through the API directly with curl.

1. Create an API key

Open API keys in the Router dashboard and create a key.

The secret is shown once. Add it to your .env before closing the dialog:

RAMP_ROUTER_API_KEY=your-router-key

You can set a lifetime spend cap while creating the key.

2. List your models

Each key sees its own set of models:

curl --fail-with-body \
  "https://router-api.ramp.com/v1/models" \
  -H "Authorization: Bearer $RAMP_ROUTER_API_KEY"

The response uses the OpenAI model-list shape:

{
  "object": "list",
  "data": [
    {
      "id": "your-model-id",
      "object": "model",
      "owned_by": "openai"
    }
  ]
}

3. Create a response

Use an id from the previous step as model:

curl --fail-with-body \
  "https://router-api.ramp.com/v1/responses" \
  -H "Authorization: Bearer $RAMP_ROUTER_API_KEY" \
  -H "Content-Type: application/json" \
  -H "X-Request-Id: quickstart-001" \
  -d '{
    "model": "your-model-id",
    "input": "Reply with exactly one word: pong.",
    "max_output_tokens": 16
  }'

A successful call returns an OpenAI Response object. For a simple text result, look for an output_text content item inside output.

Router echoes x-request-id and x-trace-id. Log them so you can trace a failure later.

4. Try streaming

Set stream to true to receive OpenAI Responses server-sent events:

curl --no-buffer --fail-with-body \
  "https://router-api.ramp.com/v1/responses" \
  -H "Authorization: Bearer $RAMP_ROUTER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "your-model-id",
    "input": "Write one sentence about reliable software.",
    "stream": true
  }'

5. Verify usage

Open Logs after the request settles to see the model, provider, status, tokens, cost, and latency.

Next steps

Connect your app with an SDK or framework, or read Choose a model.