快速开始

接入点说明

API 接入点地址、认证方式和使用方法

接入点说明

本文档详细说明所有 API 接入点(Endpoints)的地址、认证方式和使用方法。

1. 基础信息

项目说明
BASE URLhttps://www.yunsell.com
协议HTTPS(推荐) / HTTP
编码UTF-8
请求格式JSON
认证方式Bearer Token

2. 认证方式

所有 API 请求都需要在请求头中包含认证信息:

Authorization: Bearer sk-your-api-key

2.1 获取 API Key

  1. 登录用户中心
  2. 点击模型广场
  3. 进入 API 密钥页面
  4. 创建或复制已有密钥的 API Key
  5. 格式为 sk- 开头的字符串

2.2 认证失败响应

HTTP 状态码错误码说明
401invalid_api_keyAPI Key 无效或已过期
401missing_authorization缺少认证头
403insufficient_quota额度不足

3. API 接入点列表

3.1 OpenAI 兼容接口

模型列表

GET /v1/models

获取当前可用的模型列表。

Chat Completions

POST /v1/chat/completions

创建聊天对话补全。

Embeddings

POST /v1/embeddings

创建文本嵌入向量。

Images Generations

POST /v1/images/generations

生成图像(OpenAI 兼容格式)。

Audio Transcriptions

POST /v1/audio/transcriptions

语音转文字。

Audio Translations

POST /v1/audio/translations

语音翻译。

Audio Speech

POST /v1/audio/speech

文字转语音。

Moderations

POST /v1/moderations

内容审核。

Rerank

POST /v1/rerank

重排序。

Responses(OpenAI 新接口)

POST /v1/responses
POST /v1/responses/compact

3.2 Anthropic Claude 接口

Messages

POST /v1/messages

Claude Messages API 兼容接口。

模型列表(Anthropic 格式)

GET /v1/models

请求头包含 x-api-keyanthropic-version 时返回 Anthropic 格式。

3.3 Google Gemini 接口

Gemini 模型列表

GET /v1beta/models
GET /v1/models

请求头包含 x-goog-api-key 或查询参数包含 key 时返回 Gemini 格式。

Gemini 对话

POST /v1beta/models/{model}:generateContent
POST /v1beta/models/{model}:streamGenerateContent

4. 响应格式

4.1 成功响应

HTTP 状态码:200 OK

响应体为 JSON 格式,具体结构取决于调用的 API。

4.2 错误响应

HTTP 状态码:4xx5xx

错误响应格式:

{
  "error": {
    "message": "错误描述信息",
    "type": "错误类型",
    "code": "错误代码"
  }
}

常见错误代码:

HTTP 状态码错误代码说明
400invalid_request_error请求参数错误
401invalid_api_keyAPI Key 无效
403insufficient_quota额度不足
404model_not_found模型不存在
429rate_limit_exceeded请求频率超限
500internal_server_error服务器内部错误
502bad_gateway上游服务错误

5. 流式响应

对于聊天补全等支持流式的接口,设置 stream: true 可以获取 SSE 流式响应:

POST /v1/chat/completions
Content-Type: application/json
Authorization: Bearer sk-your-api-key

{
  "model": "gpt-4o",
  "messages": [{"role": "user", "content": "你好"}],
  "stream": true
}

响应头:

Content-Type: text/event-stream
Cache-Control: no-cache
Connection: keep-alive

响应体格式:

data: {"id":"...","object":"chat.completion.chunk","choices":[{"delta":{"content":"你"}}]}
data: {"id":"...","object":"chat.completion.chunk","choices":[{"delta":{"content":"好"}}]}

data: [DONE]

6. 相关文档