Quick Start Your First Call
API Basics
Understand API, Base URL, API Key, model ID, and how different protocols relate
Core Concepts
| Concept | Meaning | Where to Get It |
|---|---|---|
| API | A programmable interface used by code or clients to call Routescope capabilities. | Choose the matching section under API documentation. |
| Base URL | The root endpoint for requests, such as the OpenAI-compatible /v1 entry. | Copy it from the dashboard or the relevant client guide. |
| API Key | The credential used for authentication. It is usually the full sk-... secret. | Create and copy it in Token Management. |
| Model ID | The value passed to model, such as a text, image, audio, or video model identifier. | Copy it from Model Gallery or the model list endpoint. |
| Protocol | The request format expected by the client or model family, such as OpenAI-style, Claude Messages, or Gemini native. | Follow the corresponding API or tool page. |
Do Not Mix Protocols
Different clients and model families may use different paths and payload structures:
- OpenAI-compatible clients usually use
/v1and endpoints such as/v1/chat/completions. - Claude Code uses Anthropic-style settings and does not normally include
/v1inANTHROPIC_BASE_URL. - Gemini native APIs use paths such as
/v1beta/models/{model}:generateContent.
When a request fails, first confirm that the Base URL, path, API Key, model ID, and request body all belong to the same protocol.
How is this guide?
Last updated on