API 接口文档

Oimi API 提供统一的模型调用入口。你可以使用平台 API 密钥调用控制台中可见的模型，并通过「模型」「用量」「费用」查看模型、价格、用量和费用。

服务地址

https://api.oimi.xin

SDK 接入时通常使用：

https://api.oimi.xin/v1

实际地址请以控制台「API 访问」区域展示为准。

认证方式

OpenAI 兼容接口使用 Bearer Token：

Authorization: Bearer $API_KEY

Claude Messages 接口也支持 Claude 风格 Header：

x-api-key: $API_KEY
anthropic-version: 2023-06-01

Gemini 接口支持：

x-goog-api-key: $API_KEY

或：

?key=$API_KEY

OpenAI 兼容接口

Chat Completions

POST /v1/chat/completions

curl https://api.oimi.xin/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "model-id",
    "messages": [
      { "role": "user", "content": "写一个 API 接入说明" }
    ],
    "stream": true
  }'

model-id 请替换为「模型」页面展示的实际模型 ID。

模型列表

GET /v1/models

返回当前 API 密钥可访问的模型列表。模型是否可用会受到账号、模型变体和当前服务配置影响。建议以控制台「模型」页面展示为准。

OpenAI Responses 接口

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

适合使用 Responses API 形态的应用。所选模型是否支持该接口，以实际请求返回为准。

Claude Messages 接口

POST /v1/messages

curl https://api.oimi.xin/v1/messages \
  -H "x-api-key: $API_KEY" \
  -H "anthropic-version: 2023-06-01" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "model-id",
    "max_tokens": 1024,
    "messages": [
      { "role": "user", "content": "生成一份产品更新说明" }
    ]
  }'

Gemini 接口

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

curl https://api.oimi.xin/v1beta/models/model-id:generateContent \
  -H "x-goog-api-key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "contents": [
      { "parts": [{ "text": "写一封用户欢迎邮件" }] }
    ]
  }'

其他支持的端点

除上面的常用协议入口外，平台还可能开放图像、向量、重排等能力。具体能否调用取决于你的账号可见模型、模型能力和当前服务配置。

接入前建议先在「模型」页面确认模型 ID，再用对应协议发起测试请求。

能力	端点
Chat Completions	`POST /v1/chat/completions`
Responses	`POST /v1/responses`
Responses Compact	`POST /v1/responses/compact`
Claude Messages	`POST /v1/messages`
Gemini Generate Content	`POST /v1beta/models/{model}:generateContent`
Rerank	`POST /v1/rerank`
Images	`POST /v1/images/generations`
Embeddings	`POST /v1/embeddings`

错误格式

接口错误会返回 OpenAI 风格结构：

{
  "error": {
    "message": "错误说明",
    "type": "new_api_error",
    "code": "access_denied"
  }
}

常见错误包括 API 密钥无效、账户余额不足、API 密钥额度不足、模型不可用、服务地址错误、认证 Header 错误、请求频率超限或上游服务暂不可用。