API 文档

XHuoAPI 提供与 OpenAI 完全兼容的 API 接口，支持 500+ 主流 AI 模型。

Base URL

https://api.xhuoapi.ai

快速开始

  1. 访问 控制台 注册账号
  2. 在控制台获取您的 API Key
  3. 将 Base URL 替换为 https://api.xhuoapi.ai
  4. 开始调用 API

认证方式

所有 API 请求都需要在 HTTP Header 中携带 API Key：

Authorization: Bearer YOUR_API_KEY

⚠️ 安全提示：请勿在客户端代码中暴露您的 API Key，建议通过后端服务器代理请求。

对话补全

创建一个对话补全请求，支持所有主流模型。

POST /v1/chat/completions

请求参数

参数 类型 必填 说明
model string ✅ 模型名称，如 gpt-4o
messages array ✅ 对话消息列表
temperature number ❌ 采样温度 (0-2)，默认 1
max_tokens integer ❌ 最大生成 token 数
stream boolean ❌ 是否流式输出，默认 false

请求示例

curl https://api.xhuoapi.ai/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "model": "gpt-4o",
    "messages": [
      {
        "role": "user",
        "content": "你好，介绍一下你自己"
      }
    ],
    "temperature": 0.7
  }'

响应示例

{
  "id": "chatcmpl-abc123",
  "object": "chat.completion",
  "created": 1677652288,
  "model": "gpt-4o",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "你好！我是一个AI助手..."
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 12,
    "completion_tokens": 20,
    "total_tokens": 32
  }
}

模型列表

获取所有可用模型列表。

GET /v1/models

请求示例

curl https://api.xhuoapi.ai/v1/models \
  -H "Authorization: Bearer YOUR_API_KEY"

热门模型

gpt-4o

OpenAI 最新多模态模型

claude-3-5-sonnet-20241022

Anthropic Claude 3.5 Sonnet

gemini-2.0-flash-exp

Google Gemini 2.0 Flash

deepseek-chat

DeepSeek V3 对话模型

流式输出

通过设置 stream: true 启用流式输出，实时接收生成内容。

请求示例

curl https://api.xhuoapi.ai/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "model": "gpt-4o",
    "messages": [{"role": "user", "content": "讲个笑话"}],
    "stream": true
  }'

响应格式

流式响应使用 Server-Sent Events (SSE) 格式，每行以 data: 开头：

data: {"id":"chatcmpl-123","choices":[{"delta":{"content":"你"}}]}

data: {"id":"chatcmpl-123","choices":[{"delta":{"content":"好"}}]}

data: [DONE]

错误处理

API 使用标准 HTTP 状态码表示请求结果。

状态码 说明
200 请求成功
400 请求参数错误
401 API Key 无效或未提供
429 请求频率超限
500 服务器内部错误

错误响应示例

{
  "error": {
    "message": "Invalid API key",
    "type": "invalid_request_error",
    "code": "invalid_api_key"
  }
}

代码示例

Python

from openai import OpenAI

client = OpenAI(
    api_key="YOUR_API_KEY",
    base_url="https://api.xhuoapi.ai/v1"
)

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

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

Node.js

import OpenAI from 'openai';

const client = new OpenAI({
  apiKey: 'YOUR_API_KEY',
  baseURL: 'https://api.xhuoapi.ai/v1'
});

const response = await client.chat.completions.create({
  model: 'gpt-4o',
  messages: [{ role: 'user', content: '你好' }]
});

console.log(response.choices[0].message.content);

cURL

curl https://api.xhuoapi.ai/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "model": "gpt-4o",
    "messages": [{"role": "user", "content": "你好"}]
  }'

需要帮助？访问 控制台 或联系技术支持

© 2024 XHuoAPI. All rights reserved.