简介

欢迎使用AIMaxHug API文档。AIMaxHug是一个综合性AI聚合平台,让您能够通过单一接口访问多种顶尖AI模型和服务。

我们的API遵循RESTful原则,使用JSON进行数据交换。所有请求都需要使用API密钥进行认证。

通过AIMaxHug API,您可以:

  • 访问多种领先的AI模型,包括GPT、Claude、Gemini等
  • 生成文本、图像和进行对话
  • 比较不同模型的输出结果
  • 自定义和微调模型以满足您的特定需求

快速开始

要开始使用AIMaxHug API,请按照以下简单步骤操作:

  1. 在AIMaxHug平台创建账户
  2. 从您的控制面板生成API密钥
  3. 发送您的第一个API请求
示例请求
curl -X POST "https://aimaxhug.com/v1/chat/completions" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
  "model": "gpt-4",
  "prompt": "写一篇关于人工智能的短文。",
  "max_tokens": 150
}'

认证

所有API请求都必须在Authorization头中包含您的API密钥。

认证头
Authorization: Bearer YOUR_API_KEY

安全提示

请保管好您的API密钥,切勿在GitHub、客户端代码或网站源代码等公开访问区域分享。

AI模型

AIMaxHug集成了多种领先的AI模型,您可以根据您的需求选择最适合的模型。

支持的模型

模型类别 可用模型 特点
文本生成 GPT-4, GPT-3.5-Turbo, Claude, Gemini Pro 高质量文本生成,上下文理解能力强
图像生成 DALL-E 3, Stable Diffusion, Midjourney 高质量图像生成,支持多种风格和修改
向量嵌入 text-embedding-ada-002, Cohere Embed 将文本转换为向量表示,用于搜索和分析
多模态 GPT-4V, Gemini Pro Vision, Claude 3 同时处理文本和图像输入

发送请求

AIMaxHug API接受JSON格式的请求数据。始终将Content-Type头设置为application/json。

HTTP方法

  • GET 检索资源
  • POST 创建资源
  • PUT 更新资源
  • DELETE 删除资源

基础URL

所有API请求应发送至:

https://aimaxhug.com/v1/

处理响应

所有响应均以JSON格式返回。典型的成功响应包括:

示例响应
{
  "status": "success",
  "data": {
    "id": "gen_123",
    "model": "gpt-4",
    "text": "人工智能是当今科技领域最令人兴奋的发展之一。它结合了计算机科学、数据分析和机器学习,使计算机能够执行通常需要人类智能的任务。从虚拟助手到自动驾驶汽车,人工智能正在改变我们的生活和工作方式。尽管存在挑战,但人工智能的潜力是无限的,有望解决从医疗保健到气候变化等许多复杂问题。",
    "tokens_used": 120,
    "created_at": "2025-07-28T08:30:00Z"
  }
}

错误处理

当发生错误时,API会返回适当的HTTP状态码和包含错误详情的JSON对象。

错误响应
{
  "status": "error",
  "code": "invalid_request",
  "message": "请求不可接受。",
  "details": "缺少必填字段'model'。"
}

常见错误代码

HTTP状态 错误代码 描述
400 invalid_request 请求不可接受
401 unauthorized 无效的API密钥或未授权访问
404 not_found 请求的资源未找到
429 rate_limited 请求过多
500 server_error 服务器发生错误

文本生成 API

文本生成API允许您使用多种AI模型生成文本内容。

生成文本

POST /chat-completions

使用选定的模型生成文本。

请求参数

参数 类型 描述
model string 要使用的AI模型 (必填)
prompt string 用于生成文本的提示 (必填)
max_tokens integer 生成的最大令牌数 (默认: 100)
temperature number 采样温度,控制随机性 (0-2之间,默认: 0.7)

请求示例

文本生成请求
{
  "model": "gpt-4",
  "prompt": "介绍人工智能的主要应用领域。",
  "max_tokens": 200,
  "temperature": 0.7
}

图像生成 API

图像生成API允许您使用不同的模型创建自定义图像。

生成图像

POST /image-generation

根据文本提示生成图像。

请求参数

参数 类型 描述
model string 要使用的图像生成模型 (必填)
prompt string 描述所需图像的文本提示 (必填)
size string 图像尺寸 (默认: "1024x1024")
style string 图像风格 (如"photographic"、"digital art"等)

对话完成 API

对话完成API允许您创建和管理与AI模型的交互式对话。

创建对话消息

POST /chat-completion

发送对话消息并获取AI回复。

请求参数

参数 类型 描述
model string 要使用的对话模型 (必填)
messages array 对话消息数组 (必填)
temperature number 采样温度 (默认: 0.7)

请求示例

对话请求
{
  "model": "claude-instant",
  "messages": [
    {"role": "system", "content": "你是一个有用的AI助手。"},
    {"role": "user", "content": "解释量子计算的基本原理。"}
  ],
  "temperature": 0.7
}

向量嵌入 API

向量嵌入API将文本转换为数值向量表示,用于语义搜索、聚类和其他机器学习任务。

创建嵌入

POST /embeddings

为给定文本生成向量嵌入。

请求参数

参数 类型 描述
model string 要使用的嵌入模型 (必填)
input string or array 要嵌入的文本 (必填)

模型微调 API

模型微调API允许您使用自己的数据集自定义基础模型。

创建微调作业

POST /fine-tuning

创建新的模型微调作业。

请求参数

参数 类型 描述
base_model string 要微调的基础模型 (必填)
training_file string 训练数据文件的ID (必填)
validation_file string 验证数据文件的ID (可选)
epochs integer 训练轮数 (默认: 3)

最佳实践

遵循这些最佳实践,以获得最佳的API使用体验:

提示工程

编写清晰、具体的提示,以获得最佳结果。包括:

  • 明确指定所需输出的格式和风格
  • 提供足够的上下文信息
  • 分解复杂任务为更小的步骤
  • 使用示例说明所需的输出格式

模型选择

根据您的用例选择适当的模型:

  • 对于复杂任务,选择高级模型(如GPT-4、Claude 3)
  • 对于简单或高吞吐量需求,选择快速模型(如GPT-3.5-Turbo)
  • 对于多模态任务,选择支持图像的模型(如GPT-4V、Gemini Pro Vision)

错误处理

实现健壮的错误处理,包括:

  • 处理API超时和暂时性失败
  • 实现指数退避重试策略
  • 为用户提供有意义的错误信息

速率限制

为了确保服务质量和公平使用,AIMaxHug对API请求实施速率限制。

计划 限制 时间窗口
免费 50个请求 每小时
标准 1,000个请求 每小时
专业 10,000个请求 每小时
企业 自定义限制 按需定制

当您超过速率限制时,API将返回429状态码。响应头包含以下信息:

  • X-RateLimit-Limit: 您的计划允许的请求数
  • X-RateLimit-Remaining: 当前时间窗口内剩余的请求数
  • X-RateLimit-Reset: 速率限制重置的时间戳

示例代码

Python 示例

文本生成示例
import requests
import json

api_key = "YOUR_API_KEY"
url = "https://api.aimaxhug.com/v1/v1/chat/completions"

headers = {
    "Authorization": f"Bearer {api_key}",
    "Content-Type": "application/json"
}

data = {
    "model": "gpt-4",
    "prompt": "写一篇关于人工智能在医疗领域应用的短文。",
    "max_tokens": 200,
    "temperature": 0.7
}

response = requests.post(url, headers=headers, data=json.dumps(data))
result = response.json()

if response.status_code == 200:
    print("生成的文本:")
    print(result["data"]["text"])
else:
    print(f"错误: {result['message']}")

JavaScript 示例

对话完成示例
const apiKey = 'YOUR_API_KEY';
const url = 'https://aimaxhug.com/v1/chat-completions';

const data = {
  model: 'claude-instant',
  messages: [
    {role: 'system', content: '你是一个有用的AI助手。'},
    {role: 'user', content: '什么是机器学习?'}
  ],
  temperature: 0.7
};

async function getChatCompletion() {
  try {
    const response = await fetch(url, {
      method: 'POST',
      headers: {
        'Authorization': `Bearer ${apiKey}`,
        'Content-Type': 'application/json'
      },
      body: JSON.stringify(data)
    });
    
    const result = await response.json();
    
    if (response.ok) {
      console.log('AI回复:', result.data.message.content);
    } else {
      console.error('错误:', result.message);
    }
  } catch (error) {
    console.error('请求失败:', error);
  }
}

getChatCompletion();