Quick Start
Complete your first integration flow using the real console pages
Entry, Purpose, and When to Use It
- Entry: in the documentation sidebar, open Learn the Console, then Quick Start. The actual operation starts from the account center after you sign in to Routescope.
- Purpose: turn the first integration into executable steps, from account checks to the first API call and billing audit.
- Use it when: you are integrating Routescope API for the first time, validating a new model, or creating an isolated API Key for a new project.
Check the Dashboard
- Sign in to Routescope and enter the account center.
- Open Dashboard in the left navigation.
- Confirm that Current Balance is enough for testing.
- Review model consumption data, date statistics, and common API addresses.
- If you need the base endpoint, copy it from the page.
If balance is insufficient, top up first and then continue.
Top Up
- Open Top Up Balance from the left navigation.
- Check your current balance.
- Enter a top-up amount. The credited quota is denominated in USD.
- Review the credited quota shown on the page.
- If packages, promo codes, or payment methods are available, choose the options you need.
- After payment, return to the page and confirm that the balance has been credited.
Choose a Model
- Open Model Gallery.
- Search by model name or keyword.
- Filter by provider, token group, billing type, tags, or endpoint type.
- Review pricing and confirm the input, output, or task billing path.
- In card view or table view, find the target model and copy its model ID.
The model ID is the standard identifier you will use in playground tests and API calls.
Test the Model
- Open Playground.
- Enter Text Conversation.
- Select the model you confirmed.
- If you need visual input, fill in the image URL field shown on the page.
- Configure visible parameters such as max tokens and random seed.
- Send a test message.
- Review the response and debug information to confirm model behavior, latency, and error messages.
Create an API Key
- Open Token Management.
- Click Add Token.
- Enter a token name. Use a project or environment name such as
web-prodoragent-test. - Configure allowed models, quota, IP restrictions, and expiration as needed.
- Save, then view and copy the full secret.
Keep the full secret in server-side environment variables or protected client configuration. Do not publish it.
Make an API Call
- Prepare three values: the API address from the dashboard, the API Key from token management, and the model ID from the model gallery.
- Open the API reference and choose the capability page you need.
- Follow the example request and put the endpoint, API Key, and model ID into your code, script, or client configuration.
- Send a minimal test request to confirm authentication, model permission, and balance.
- For detailed field descriptions, continue to the matching API reference. This console guide only explains the integration flow.
Review Results and Billing
- Open Operation Records.
- In Usage Logs, search by date, token name, model name, group, or request ID.
- Review input, output, cost, RPM, TPM, and request details.
- For async image, audio, or video tasks, switch to Task Logs to check task status, result, or failure reason.
- For financial reconciliation, open Billing and Invoices to review billing records, order status, and consumption records.
Dashboard
Confirm balance, usage data, and API address first.
Top Up Balance
Complete top-up and confirm credit arrival on the page.
Model Gallery
Filter models and copy the model ID.
Text Conversation
Validate the model in the playground before coding.
Token Management
Create an API Key and configure permissions.
Operation Records
Review request results and billing details.
API Reference
Use endpoint docs when you need fields and request examples.
FAQ
Why can I not call the API after creating a key?
Check balance first, then confirm that the token is enabled, not expired, and not restricted away from the current model or source IP.
Should I write code first or test the model first?
Test the model in Playground > Text Conversation first, then use the same model ID and access settings in your code.
How is this guide?
Last updated on