Skip to content

API.md

Latest commit

 

History

History
71 lines (57 loc) · 2.02 KB

API.md

File metadata and controls

71 lines (57 loc) · 2.02 KB
Raw

AI API 对接文档

《逐日计划》通过用户配置的 AI API 调用大模型。尽量统一为 OpenAI 兼容协议。

1. 通用请求

端点：POST {baseUrl}/chat/completions

请求头：

Authorization: Bearer {apiKey}
Content-Type: application/json

请求体：

{
  "model": "{modelName}",
  "messages": [
    { "role": "system", "content": "{systemPrompt}" },
    { "role": "user", "content": "{userPrompt}" }
  ],
  "temperature": 0.7,
  "max_tokens": 4096,
  "response_format": { "type": "json_object" }
}

响应：

{
  "choices": [
    { "message": { "role": "assistant", "content": "{jsonContent}" }, "finish_reason": "stop" }
  ],
  "usage": { "prompt_tokens": 0, "completion_tokens": 0 }
}

2. Provider 对照表

Provider Base URL 兼容协议
OpenAI https://api.openai.com/v1 OpenAI
DeepSeek https://api.deepseek.com/v1 OpenAI
Qwen / 阿里百炼 https://dashscope.aliyuncs.com/compatible-mode/v1 OpenAI
硅基流动 https://api.siliconflow.cn/v1 OpenAI
OpenRouter https://openrouter.ai/api/v1 OpenAI
火山方舟 https://ark.cn-beijing.volces.com/api/v3 OpenAI
Gemini https://generativelanguage.googleapis.com 原生（单独适配）
Claude https://api.anthropic.com Anthropic（单独适配）

3. 测试连接

  • 发送最小请求（system + user 各一句，小 max_tokens）验证 Key 与模型
  • 错误码映射：401 Key 无效 / 402 余额不足 / 429 限流 / 5xx 服务器错误

4. 错误码与用户文案

情况 提示
网络不可用 网络连接失败，请检查网络
401 / 403 API Key 无效或未授权，请检查配置
402 账户余额不足
429 请求过于频繁，请稍后重试
超时 生成超时，请重试或更换模型
JSON 解析失败 返回格式异常，请重新生成

5. 安全

  • API Key 用 Android Keystore 加密存储。
  • Key 仅本机使用，绝不写入备份明文、绝不上传。