新手指引

欢迎使用 RealmRouter 界云模型 API 服务！本指南将帮助您快速上手，从注册账户到第一次成功调用 API 的完整流程。

前置准备

在开始之前，请确保您已具备以下条件：

有效的邮箱地址
基础的编程知识（推荐 Python 或 JavaScript）
了解 HTTP API 基础概念
稳定的网络连接

步骤一：注册账户

1. 访问官网

前往 RealmRouter 界云官网并点击"注册"按钮。

2. 填写注册信息

邮箱地址：使用真实有效的邮箱
密码：设置强密码，包含大小写字母、数字和特殊字符
确认密码：再次输入密码进行确认
验证码：完成邮箱或手机验证

3. 完善个人信息

姓名：填写真实姓名
公司/组织：可选，填写您的公司或组织名称
使用场景：描述您计划使用 API 的场景
联系方式：提供备用联系方式

4. 邮箱验证

查收注册邮箱中的验证邮件
点击验证链接完成邮箱验证
如未收到邮件，请检查垃圾邮件文件夹

步骤二：创建应用

1. 登录控制台

使用注册的邮箱和密码登录开发者控制台。

2. 进入应用管理

在控制台左侧导航栏中找到"应用管理"并点击进入。

3. 创建新应用

点击"创建应用"按钮
填写应用信息：
- 应用名称：为您的应用起一个描述性名称
- 应用描述：简要描述应用用途和功能
- 应用类型：选择合适的应用类型（Web应用、移动应用、后端服务等）
- 使用场景：详细描述应用场景和预期使用量

4. 配置应用设置

访问权限：设置 API 访问权限范围
调用限制：设置日调用次数和并发限制
IP 白名单：可选，限制 API 调用来源 IP
回调地址：可选，设置 Webhook 回调地址

5. 获取 API 密钥

应用创建完成后，系统会自动生成：

API Key：用于 API 认证的主要密钥
App ID：应用唯一标识符
Secret Key：用于高级认证的密钥

安全提示

请妥善保管您的 API 密钥，不要在代码中硬编码或在公共场合暴露。建议使用环境变量或密钥管理服务存储密钥。

步骤三：选择模型

1. 浏览模型广场

在控制台中进入"模型广场"，查看所有可用的模型：

大语言模型

GPT-3.5-turbo：通用对话，性价比高
GPT-4：复杂推理，能力强
Claude-3：长文本处理，安全性好
文心一言：中文优化，本土化好

视觉语言模型

GPT-4-vision：图像理解和描述
LLaVA：开源多模态模型
Qwen-VL：中文视觉语言模型

专用模型

CodeLlama：代码生成和优化
DeepSeek-Coder：中文代码模型
MathGPT：数学推理专用

2. 查看模型详情

点击模型名称查看详细信息：

模型规格：参数量、上下文长度等
性能指标：响应时间、吞吐量等
计费标准：Token 价格、调用费用等
使用限制：频率限制、并发限制等
适用场景：推荐使用场景和案例

3. 选择合适模型

根据您的需求选择模型：

使用场景	推荐模型	特点
日常对话	GPT-3.5-turbo	成本低，速度快
复杂推理	GPT-4, Claude-3	能力强，准确性高
中文应用	文心一言，通义千问	中文优化
代码生成	CodeLlama, DeepSeek-Coder	代码专业
图像理解	GPT-4-vision, Qwen-VL	多模态支持

步骤四：API 调用示例

Python 示例

python

import requests
import json

# 配置 API 信息
API_KEY = "your_api_key_here"
BASE_URL = "https://realmrouter.cn/v1"

# 设置请求头
headers = {
    "Authorization": f"Bearer {API_KEY}",
    "Content-Type": "application/json"
}

# 构建请求数据
data = {
    "model": "gpt-3.5-turbo",
    "messages": [
        {
            "role": "user",
            "content": "你好，请介绍一下 RealmRouter 界云"
        }
    ],
    "max_tokens": 1000,
    "temperature": 0.7
}

# 发送请求
response = requests.post(
    f"{BASE_URL}/chat/completions",
    headers=headers,
    json=data
)

# 处理响应
if response.status_code == 200:
    result = response.json()
    print("AI 回复：", result['choices'][0]['message']['content'])
else:
    print("请求失败：", response.status_code, response.text)

JavaScript 示例

javascript

// 配置 API 信息
const API_KEY = "your_api_key_here";
const BASE_URL = "https://realmrouter.cn/v1";

// 发送请求
async function chatWithAI(message) {
    const response = await fetch(`${BASE_URL}/chat/completions`, {
        method: 'POST',
        headers: {
            'Authorization': `Bearer ${API_KEY}`,
            'Content-Type': 'application/json'
        },
        body: JSON.stringify({
            model: 'gpt-3.5-turbo',
            messages: [
                {
                    role: 'user',
                    content: message
                }
            ],
            max_tokens: 1000,
            temperature: 0.7
        })
    });

    if (response.ok) {
        const result = await response.json();
        return result.choices[0].message.content;
    } else {
        throw new Error(`请求失败: ${response.status}`);
    }
}

// 使用示例
chatWithAI("你好，请介绍一下 RealmRouter 界云")
    .then(reply => console.log("AI 回复：", reply))
    .catch(error => console.error("错误：", error));

cURL 示例

bash

curl -X POST "https://realmrouter.cn/v1/chat/completions" \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-3.5-turbo",
    "messages": [
      {
        "role": "user",
        "content": "你好，请介绍一下 RealmRouter 界云"
      }
    ],
    "max_tokens": 1000,
    "temperature": 0.7
  }'

步骤五：测试和验证

1. 验证 API 连接

运行上述示例代码，确认能够正常获取 AI 回复。

2. 检查响应格式

API 响应格式如下：

json

{
  "id": "chatcmpl-123",
  "object": "chat.completion",
  "created": 1677652288,
  "model": "gpt-3.5-turbo",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "AI 的回复内容"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 10,
    "completion_tokens": 20,
    "total_tokens": 30
  }
}

3. 监控使用情况

在控制台中查看：

调用统计：API 调用次数和成功率
Token 使用量：输入和输出 Token 统计
费用统计：实时费用和账单信息
错误日志：调用失败的原因和详情

步骤六：集成到应用

1. 错误处理

python

import time
import requests
from requests.exceptions import RequestException

def safe_api_call(data, max_retries=3):
    for attempt in range(max_retries):
        try:
            response = requests.post(
                f"{BASE_URL}/chat/completions",
                headers=headers,
                json=data,
                timeout=30
            )
            
            if response.status_code == 200:
                return response.json()
            elif response.status_code == 429:
                # 速率限制，等待后重试
                time.sleep(2 ** attempt)
                continue
            else:
                response.raise_for_status()
                
        except RequestException as e:
            if attempt == max_retries - 1:
                raise e
            time.sleep(1)
    
    raise Exception("API 调用失败")

2. 配置管理

python

import os
from dotenv import load_dotenv

# 加载环境变量
load_dotenv()

class RealmRouterClient:
    def __init__(self):
        self.api_key = os.getenv('REALMROUTER_API_KEY')
        self.base_url = os.getenv('REALMROUTER_BASE_URL', 'https://realmrouter.cn/v1')
        self.default_model = os.getenv('REALMROUTER_DEFAULT_MODEL', 'gpt-3.5-turbo')
    
    def chat(self, messages, **kwargs):
        # 实现聊天逻辑
        pass

3. 日志记录

python

import logging

# 配置日志
logging.basicConfig(level=logging.INFO)
logger = logging.getLogger(__name__)

def log_api_call(model, messages, response):
    logger.info(f"模型调用: {model}")
    logger.info(f"输入消息数: {len(messages)}")
    logger.info(f"响应状态: {response.get('object')}")
    logger.info(f"Token 使用: {response.get('usage', {})}")

常见问题

Q: API 调用失败怎么办？

A: 检查以下几点：

API 密钥是否正确
网络连接是否正常
请求格式是否符合规范
是否超出调用限制

Q: 如何控制成本？

A: 建议：

选择合适的模型规格
优化 Prompt 长度
设置合理的 max_tokens
使用缓存机制

Q: 支持哪些编程语言？

A: RealmRouter API 是标准的 RESTful API，支持所有能够发送 HTTP 请求的编程语言。

下一步

恭喜！您已经成功集成了 RealmRouter API，可以：

获取帮助

如果您在使用过程中遇到问题，可以：

查看官方文档
联系技术支持
加入开发者社区
提交工单反馈

新手指引 ​

前置准备 ​

步骤一：注册账户 ​

1. 访问官网 ​

2. 填写注册信息 ​

3. 完善个人信息 ​

4. 邮箱验证 ​

步骤二：创建应用 ​

1. 登录控制台 ​

2. 进入应用管理 ​

3. 创建新应用 ​

4. 配置应用设置 ​

5. 获取 API 密钥 ​

步骤三：选择模型 ​

1. 浏览模型广场 ​

大语言模型 ​

视觉语言模型 ​

专用模型 ​

2. 查看模型详情 ​

3. 选择合适模型 ​

步骤四：API 调用示例 ​

Python 示例 ​

JavaScript 示例 ​

cURL 示例 ​

步骤五：测试和验证 ​

1. 验证 API 连接 ​

2. 检查响应格式 ​

3. 监控使用情况 ​

步骤六：集成到应用 ​

1. 错误处理 ​

2. 配置管理 ​

3. 日志记录 ​

常见问题 ​

Q: API 调用失败怎么办？ ​

Q: 如何控制成本？ ​

Q: 支持哪些编程语言？ ​

下一步 ​

新手指引

前置准备

步骤一：注册账户

1. 访问官网

2. 填写注册信息

3. 完善个人信息

4. 邮箱验证

步骤二：创建应用

1. 登录控制台

2. 进入应用管理

3. 创建新应用

4. 配置应用设置

5. 获取 API 密钥

步骤三：选择模型

1. 浏览模型广场

大语言模型

视觉语言模型

专用模型

2. 查看模型详情

3. 选择合适模型

步骤四：API 调用示例

Python 示例

JavaScript 示例

cURL 示例

步骤五：测试和验证

1. 验证 API 连接

2. 检查响应格式

3. 监控使用情况

步骤六：集成到应用

1. 错误处理

2. 配置管理

3. 日志记录

常见问题

Q: API 调用失败怎么办？

Q: 如何控制成本？

Q: 支持哪些编程语言？

下一步