跳转到主要内容
开发者文档

User Guide

平台介绍

闽都睿词为应用提供统一的大模型调用入口。首期公开文档聚焦聊天推理与模型目录,帮助开发者用稳定、清晰的合同完成服务端集成。

兼容调用

聊天接口采用 OpenAI 兼容的消息结构,支持普通与流式响应。

模型目录

通过公开模型列表和详情选择模型,并确认能力与参数。

安全接入

API Key 仅保存在服务端环境变量中,不应写入浏览器代码或仓库。

Get Started

快速上手

  1. 1

    准备 API Key

    在控制台创建并启用 API Key,然后仅通过服务端环境变量 AIFLOW_API_KEY 使用。

  2. 2

    选择模型

    先查询模型列表,再通过模型详情确认模型 ID、能力与可用参数。

  3. 3

    发起聊天请求

    向聊天补全接口提交 messages,可选指定 model;需要增量输出时设置 stream=true。

  4. 4

    处理失败与限流

    根据 HTTP 状态和请求 ID 排障;收到 429 时采用带抖动的指数退避。

示例中的 Base URL、API Key 和模型 ID 均为占位值。不要将真实密钥写入前端代码、URL、日志或版本控制。

Security

认证

公开推理接口使用 API Key。请在服务端请求的 Authorization 请求头中传入 Bearer <API_KEY>,不要把真实密钥放入浏览器、URL、日志或仓库。

认证失败检查

收到 HTTP 401 时,检查 Bearer 格式、Key 状态与有效期。文档中的 Key 均为占位符,页面不会读取或保存真实密钥。

Errors

错误码

客户端应同时记录 HTTP 状态和服务端返回的请求 ID,用于安全排障;不要记录请求中的密钥或敏感内容。

HTTP 400
请求格式或参数不符合公开合同,请修正后重试。
HTTP 401
API Key 缺失、无效、停用或已过期。
HTTP 429
请求超过当前限制,请遵循重试提示并采用带抖动的指数退避。
HTTP 500
服务暂时不可用,请保留请求 ID,稍后重试或联系支持。

Help

常见问题

为什么返回 401?

确认 Authorization 使用 Bearer 方案,并检查 API Key 是否存在、启用且未过期。

普通响应和流式响应有什么区别?

普通响应在推理完成后一次返回;流式响应通过 SSE 持续发送增量内容。

收到 429 应如何处理?

降低并发或请求频率,并使用带抖动的指数退避;不要立即高频重试。

为什么查不到模型?

确认模型 ID、筛选条件和分页参数;模型目录仅返回当前已发布模型。

可以在浏览器中保存 API Key 吗?

不建议。生产应用应由自己的服务端持有密钥并代理业务请求。

限速与 429 错误

收到 HTTP 429 时,请保留请求 ID,遵循服务端返回的重试提示,并采用带抖动的指数退避。模型专属 RPM、TPM 或并发限制以模型详情和实际响应为准。

Reference

API Reference

公开边界固定为以下三个接口。未列出的接口不会进入导航、搜索、示例或在线调试。