外观
快速开始与认证
本文介绍壹通 API 的基本接入方式:基础地址、认证方式、通用约定与一个最小可用的请求示例。
Base URL
壹通网关的所有接口都挂载在同一个路由组下
统一使用 https://app.1in2.top/api 作为 Base URL。
认证方式
所有请求都需要在 HTTP 头 Authorization 中携带凭证。网关会根据凭证前缀自动区分两种身份:
Authorization: Bearer <credential>| 凭证类型 | 前缀 | 身份标识(agent) | 适用场景 |
|---|---|---|---|
| API Key | sk- 开头 | api | 第三方调用 OpenAI 兼容接口(/v1/*) |
最小可用示例
以下是一个非流式对话请求的完整示例:
bash
curl https://app.1in2.top/api/v1/chat/completions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer sk-your-api-key-here" \
-d '{
"model": "gpt-3.5-turbo",
"messages": [
{ "role": "user", "content": "你好,请介绍一下你自己" }
]
}'python
import requests
resp = requests.post(
"https://app.1in2.top/api/v1/chat/completions",
headers={
"Content-Type": "application/json",
"Authorization": "Bearer sk-your-api-key-here",
},
json={
"model": "gpt-3.5-turbo",
"messages": [{"role": "user", "content": "你好,请介绍一下你自己"}],
},
)
print(resp.json())javascript
const resp = await fetch('https://app.1in2.top/api/v1/chat/completions', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': 'Bearer sk-your-api-key-here',
},
body: JSON.stringify({
model: 'gpt-3.5-turbo',
messages: [{ role: 'user', content: '你好,请介绍一下你自己' }],
}),
})
console.log(await resp.json())通用约定
- 请求体:所有 POST 接口均为
application/json。 - 响应体:核心 OpenAI 兼容接口返回 OpenAI 风格结构。
- 鉴权失败:核心接口返回
authentication_error错误。 - 错误格式:核心接口统一返回
{ "error": { "message", "type" } },详见 错误处理。
下一步
- 查看 Chat Completions 接口详情。
- 查看 错误处理 了解错误码含义。
- 查看 公共类型定义 了解数据结构。
