开始使用

开始使用 agiapi.ai 开发

了解如何使用 MDAPI 服务,包括 API 文档、示例代码和最佳实践。

核心特性

1. 完全兼容 OpenAI

SDK我们的 API 完全兼容 OpenAI 的官方 SDK,您只需要替换两个参数即可无缝迁移:

配置项数值
Base URLhttps://agiapi.ai/v1
API Key您的平台 API Key

2. 完全兼容 Claude Code

我们提供的 Claude 系列模型完全支持 Claude Code,只需在环境变量做如下修改即可:

环境变量设置

export ANTHROPIC_BASE_URL=https://agiapi.ai
export ANTHROPIC_AUTH_TOKEN=${YOUR_API_KEY}
export API_TIMEOUT_MS=600000
配置项数值
Base URLhttps://agiapi.ai
API Key您的平台 API Key

快速开始

步骤 1:注册账号

  • 注册新账号即可获得 1 美元免费余额,可用于测试 API 功能。
  • 💡 提示:新注册用户立即获得测试余额,无需充值即可开始使用

步骤 2:生成 API Key

  • 在控制台的 API Keys 页面创建新的 API Key,创建后请立即保存,因为只会显示一次。* ⚠️ 重要:API Key 创建后只显示一次,请务必立即复制保存
  • 步骤 3:替换配置参数

    • 在您的 OpenAI SDK 配置中替换以下两个参数:
  • Base URL: https://agiapi.ai/v1
  • API Key: 您的平台 API Key

步骤 4:开始使用

  • 现在您可以使用所有 OpenAI 兼容的 API 接口了!
  • 🎉 恭喜:您的应用现在可以无缝使用我们的 API 服务了

代码示例

Python (OpenAI SDK)

import openai
# 配置客户端
client = openai.OpenAI(    base_url="https://agiapi.ai",  
# 替换为我们的 API 地址    
api_key="your-api-key-here"   
# 替换为您的 API Key)
# 调用聊天接口
response = client.chat.completions.create(    model="gpt-4o-mini",    messages=[        {"role": "user", "content": "Hello, world!"}    ])
print(response.choices[0].message.content)

JavaScript (OpenAI SDK)

import OpenAI from 'openai';
const openai = new OpenAI({  baseURL: 'https://agiapi.ai/v1',  
// 替换为我们的 API 地址  
apiKey: 'your-api-key-here',   
// 替换为您的 API Key});
const completion = await openai.chat.completions.create({  model: 'gpt-4o-mini',  messages: [    { role: 'user', content: 'Hello, world!' }  ],});
console.log(completion.choices[0].message.content);

错误码说明

当 API 调用出现错误时,系统会返回标准的错误响应格式,包含错误码、错误类型和错误信息。 所有错误码的详细说明:

错误码错误类型描述
10001invalid_request_error认证失败 - API Key 无效或未提供
10002invalid_request_error权限不足 - 没有访问权限
10003invalid_request_error资源不存在 - 请求的资源未找到
10004invalid_request_error请求参数错误 - 参数格式或值不正确
10005rate_limit_exceeded请求频率超限 - 超过速率限制
10006server_error服务器内部错误 - 系统内部错误
10007external_error外部服务错误
10008server_error服务不可用 - 服务暂时不可用
10009invalid_request_error请求验证失败 - 请求格式验证错误
10010invalid_request_error认证错误 - 认证失败
10011invalid_request_error授权错误 - 权限验证失败
10012invalid_request_error验证错误 - 数据验证失败
10013rate_limit_exceeded速率限制 - 请求频率过高
10014insufficient_quota余额不足 - 账户余额不足
10015invalid_request_error模型未找到 - 请求的模型不存在
10017invalid_request_error值错误 - 参数值不正确
10018invalid_request_error类型错误 - 请求格式或类型错误
10019invalid_request_error缺少参数 - 缺少必需的参数
10020invalid_request_errorJSON 格式错误 - 请求体 JSON 格式错误
10021api_error请求超时 - 请求处理超时
10022api_error连接错误 - 网络连接失败
10023api_errorHTTP 状态错误 - 外部 API 状态错误
10024api_errorHTTP 请求错误 - 外部服务请求错误
10025server_error通用异常 - 未捕获的系统异常

错误响应格式所有错误响应都遵循 OpenAI 兼容的格式:

{"error": 
{"message": "错误描述信息",
"type": "错误类型",
"param": "相关参数","code": 10001}
}

常见问题

1. 如何从 OpenAI 迁移到你们的服务?

非常简单!只需要替换两个参数:

2. 新用户可以获得多少免费额度?

新注册用户立即获得 1 美元免费余额,可用于测试所有 API 功能。

3. 支持哪些编程语言?

我们完全兼容 OpenAI 官方 SDK,支持所有官方支持的编程语言,包括 Python、JavaScript、Go、Java、C# 等。

4. 如何查看 API 使用情况?

登录控制台后,在 “用量 “页面可以查看详细的 API 调用记录、Token 消耗量和费用统计。

获取帮助需要更多帮助?

如果您在使用过程中遇到任何问题,我们随时为您提供支持。 联系支持