For the complete documentation index, see llms.txt. This page is also available as Markdown.

Quickstart

Create your first Dispatch key, send a test request, and watch it arrive on Overview

This page takes you from no key to a working request in a few minutes. You'll create a personal API key, prove it works with a single request, connect the tool you actually use, and then watch the request arrive on Overview. Once one request has gone through, you know your key, the base URL and your model tier are all right, so anything that fails later is a tool's configuration rather than Dispatch.

Before You Start

  • You need to be able to open Dispatch. See Opening Dispatch.

  • Any Dispatch role can do everything on this page. Your requests spend from the allowance your Dispatch Admin set for you.

  • Don't hardcode a hostname from this page or anywhere else. Copy the base URL from the Cookbooks page, which always shows the right one for your organization.

Make Your First Request

1

Create a key Open API keys and click Create key. Give the key a Label named after where it will live, such as "My laptop", then click Create key.

2

Copy the key now The Key created dialog shows the full key, which starts with dr_live_. Copy it and keep it somewhere safe. This is the only time Dispatch shows it. If you lose it, revoke it and create another. See API Keys.

3

Copy the base URL and pick a tier Open Cookbooks. On Getting started, copy the Base URL (it ends in /v1) and click the tier you want under Model tier. If you're not sure which to choose, Auto is the usual place to start. See Models.

4

Send a test request Run the commands below in a terminal, replacing the three placeholder values. The first command lists the tiers your key can call. The second sends a short message.

5

Confirm it on Overview Open Overview and scroll to Recent requests. Your request appears there within a few seconds of finishing, with its tier, tokens, cost and how long it took.

export DARCY_BASE_URL="<Base URL from the Cookbooks page>"
export DARCY_API_KEY="dr_live_your_key_here"

# 1. Check the key works. A working key returns a list of your tiers.
curl $DARCY_BASE_URL/models \
  -H "Authorization: Bearer $DARCY_API_KEY"

# 2. Send a message to a tier.
curl $DARCY_BASE_URL/chat/completions \
  -H "Authorization: Bearer $DARCY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model": "<tier id>", "messages": [{"role": "user", "content": "Say hello"}]}'

The Cookbooks page fills these in for you. The HTTP request guide on Cookbooks shows the same request with your base URL and chosen tier already in place, so you only need to supply your key.

If the Request Fails

What you see
What it usually means

401

The key never arrived. Check it was pasted without a trailing space or line break, and that it's sent as Authorization: Bearer.

404

Usually a doubled /v1 in the URL, or a model name that isn't one of your tiers. Use the tier id exactly as the Models page shows it.

The request appears on Overview as Over budget

A spend limit has been reached. Ask your Dispatch Admin.

The request appears on Overview as Blocked

A content policy refused it. Try a plain message such as "Say hello".

Connect Your Tool

Once the test request works, point your coding agent or editor at Dispatch. Open Cookbooks, choose your tool from the list on the left, and follow its steps. Each guide is already filled in with your base URL and the tier you picked.

The fastest paths are:

  • Claude Code — set a block of environment variables and run claude. Claude Code is the one tool that needs the base URL without /v1. The guide shows the right value.

  • Cursor — paste your key and base URL into Cursor's model settings. Cursor's Verify button will fail even when everything is right, so test by sending a chat message instead.

See Cookbooks for every supported tool and its caveats.

Next Steps

Goal
Documentation

Set up Claude Code, Cursor, Codex, OpenCode, VS Code or Kilo Code

Choose the right tier

Manage, pause or revoke your keys

See what your requests cost

Last updated

Was this helpful?