DEVELOPER DOCUMENTATION

开发文档

从第一条请求到图片、视频和音频任务，使用一套兼容 OpenAI 的接口快速接入Allapi API。

OpenAI SDK 兼容统一鉴权全链路请求 ID

QUICK START

5 分钟快速接入

安装 OpenAI SDK，将 API Key 和 Base URL 替换为Allapi平台提供的值即可。密钥请只放在服务端环境变量中。

安装 SDKpip install openai

创建客户端并发起请求示例使用 Python，其他 OpenAI 兼容 SDK 配置方式相同。

PythonAllapi

from openai import OpenAI

client = OpenAI(
    api_key="sk-wl_your_key",
    base_url="https://openai.allapi.ren/v1"
)

response = client.chat.completions.create(
    model="gpt-5.4",
    messages=[{"role": "user", "content": "你好，Allapi"}]
)

print(response.choices[0].message.content)

AUTHENTICATION

鉴权与密钥

API Key 通过 HTTP Bearer Token 传递。新密钥可在接口密钥页面再次查看和复制。

Authorization 请求头Authorization: Bearer sk-wl_your_key

不要把 API Key 写入浏览器代码、移动端安装包或公开仓库。

响应头	说明
`X-Request-Id`	平台请求唯一标识，排障时请一并提供。
`Content-Type`	JSON 接口通常返回 application/json；媒体接口按内容类型返回。

TEXT API

文本与推理

POST /chat/completions

兼容 OpenAI Chat Completions 协议，支持普通响应与流式输出。模型名称以模型定价页面当前上线列表为准。

cURLAllapi

curl https://openai.allapi.ren/v1/chat/completions \
  -H "Authorization: Bearer sk-wl_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.4",
    "messages": [{"role": "user", "content": "写一句产品介绍"}]
  }'

流式响应请求体增加 "stream": true，响应将使用 Server-Sent Events 返回。

IMAGE API

图片生成

POST /images/generations

提交提示词、模型和目标尺寸生成图片。不同模型支持的尺寸、编辑能力和计费单位可能不同。

cURLAllapi

curl https://openai.allapi.ren/v1/images/generations \
  -H "Authorization: Bearer sk-wl_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gemini-3-pro-image",
    "prompt": "Allapi品牌的紫色科技数据中心",
    "size": "1024x1024",
    "n": 1
  }'

VIDEO API

视频生成

POST /videos

视频采用异步任务模式。创建成功后保存任务 ID，并通过查询接口获取进度和最终结果。

cURLAllapi

curl https://openai.allapi.ren/v1/videos \
  -H "Authorization: Bearer sk-wl_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "veo-3.1-fast",
    "prompt": "Allapi品牌的科技城市夜景，镜头缓慢向前移动",
    "duration": 8
  }'

查询任务GET /v1/videos/:id 查询状态；完成后使用 GET /v1/videos/:id/content 获取结果。

AUDIO API

音频能力

POST /audio/speech

支持语音合成与语音识别。语音识别使用 /audio/transcriptions，通过 multipart/form-data 上传音频文件。

cURLAllapi

curl https://openai.allapi.ren/v1/audio/speech \
  -H "Authorization: Bearer sk-wl_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "tts-standard",
    "voice": "alloy",
    "input": "欢迎使用Allapi API"
  }' --output speech.mp3

ERROR HANDLING

错误码

错误响应包含可读消息、错误类型、错误码和 request_id。

HTTP	错误码	说明
401	`invalid_api_key`	密钥无效、已过期或已停用。
402	`insufficient_balance`	账户余额不足，请先充值。
403	`model_not_allowed`	当前密钥无权调用该模型。
429	`daily_budget_exceeded`	已达到 API Key 每日预算上限。
502	`upstream_error`	上游服务连接失败，请稍后重试。
503	`upstream_not_configured`	目标上游尚未配置可用密钥。