TopxAI

Loading...

文档 · 快速开始

API 参考:全部端点,附 OpenAPI 规范

TopxAI 提供的端点、各自接受和返回什么、密钥的两种发送方式,以及给 SDK 生成器和 API 工具用的 OpenAPI 3.1 文件 /openapi.json。

TopxAI 原样转发请求体、原样返回响应,所以请求体的参考文档是厂商自己的文档。这一页只写 TopxAI 自己定义的部分:端点、每个端点提供哪些模型、密钥怎么传、中继会校验或计价哪些字段。同样的信息有机器可读版本 /openapi.json(OpenAPI 3.1),Postman、Insomnia、Bruno、Swagger UI、Redoc 和代码生成器都能直接加载。

基础地址

鉴权

密钥页创建的 TopxAI 密钥(sk-…),两种发法:

密钥的线路决定它能调哪些模型;自动路由的密钥能调全部模型。

端点

端点 格式 模型 说明
POST /v1/chat/completions OpenAI Chat Completions 除 Jev 外的全部文本模型 GLM-5.3-Abliterated 和 kimi-k3 只在这里;stream: true 走 SSE
POST /v1/responses OpenAI Responses gpt-6-astra、gpt-6.1-sol、grok-4.7 Codex CLI 用的就是它
POST /v1/messages Anthropic Messages Claude 系列 需要 anthropic-version;不带 max_tokens 按模型的输出上限;cache_control 原样转发
POST /v1/images/generations OpenAI Images gpt-image-2.5-sunburst、gpt-image-2.5-flare 按 size 档位每张计价;n 取 1 到 128
POST /v1/images/edits OpenAI Images(multipart) 同上两个 计价同生成
POST /v1/videos/generations 视频任务 grok-imagine-video-1.5 duration 1 到 15 秒,resolution 480p/720p/1080p;受理即扣费
GET /v1/videos/{request_id} 任务状态 pending、queued、processing、running、in_progress 继续轮询
GET /v1/videos/{request_id}/content 视频文件 done 之后
POST /v1/systemone TypeSafe System One jev-1.13.0、jev-latest、jev-preview model、state、questions;/v1/system_one 也可以
GET /v1/models OpenAI 模型列表 按密钥线路过滤
GET /api/pricing JSON 价格表 不需要密钥;/pricing 背后的数据

状态码

400 请求体校验失败,消息里写明字段。401 密钥缺失或无效。402 余额为零。403 模型不在售、不在这把密钥的线路上,或被密钥的模型限制排除。404 厂商回答模型不存在,或视频任务 ID 未知。422 TypeSafe 的校验详情(只有 System One)。429 触发限速,Retry-After 给出秒数。503 当前没有线路能提供该模型,重试。每条错误消息末尾都有请求 ID,联系 support@topxea.com 时带上。

使用规范文件

curl -O https://ai.topxea.com/openapi.json

把文件导入 Postman 或 Insomnia,每个端点各得一个填好示例的请求;或者交给 openapi-generator 生成带类型的客户端。文件里的 servers 是生产域名,不含任何密钥或账号信息。

不提供的

批处理、微调、文件、assistants、向量库、实时、音频、向量这些不转发,请求这些路径返回 404,继续用厂商自己的密钥。与厂商官方接口的对照列出了其他仍要直连的部分。

相关

上一页:接入你的 SDK · 下一页:Claude Code 接 TopxAI:ANTHROPIC_BASE_URL 和密钥

其他语言:English