API 参考

快速开始

欢迎使用 APIPod API 文档。本指南将帮助你在几分钟内将 APIPod 强大的 AI 能力集成到你的应用中。

基础地址

所有 API 请求应发送至: https://api.apipod.ai/v1

OpenAI 兼容

APIPod 提供 OpenAI 兼容Anthropic 兼容 接口。如果你已经在使用 OpenAI SDK,只需更改 base_url 即可立即开始使用 APIPod。

认证方式

APIPod 使用 Bearer Token 认证。在所有请求的 Authorization 请求头中包含你的 API Key:

Authorization: Bearer sk-your-api-key

登录 APIPod 控制台,前往 API 密钥 页面创建你的第一个密钥。

安全最佳实践

切勿在客户端代码中暴露你的 API Key。请始终在服务端发起 API 调用,或使用环境变量存储密钥。

# 设置为环境变量
export APIPOD_API_KEY="sk-your-api-key"

快速开始

60 秒内完成你的第一次 API 调用:

from openai import OpenAI

client = OpenAI(
    base_url="https://api.apipod.ai/v1",
    api_key="sk-your-api-key"
)

response = client.chat.completions.create(
    model="gpt-4o",
    messages=[
        {"role": "system", "content": "你是一个有帮助的助手。"},
        {"role": "user", "content": "你好!"}
    ]
)

print(response.choices[0].message.content)
import OpenAI from 'openai';

const client = new OpenAI({
  baseURL: 'https://api.apipod.ai/v1',
  apiKey: 'sk-your-api-key',
});

async function main() {
  const response = await client.chat.completions.create({
    model: 'gpt-4o',
    messages: [
      { role: 'system', content: '你是一个有帮助的助手。' },
      { role: 'user', content: '你好!' }
    ],
  });

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

main();
curl https://api.apipod.ai/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-your-api-key" \
  -d '{
    "model": "gpt-4o",
    "messages": [
      {"role": "system", "content": "你是一个有帮助的助手。"},
      {"role": "user", "content": "你好!"}
    ]
  }'

可用 API

APIPod 为多种 AI 模态提供统一的 API 接口:

通用响应格式

所有成功响应遵循一致的 JSON 结构:

{
  "id": "chatcmpl-abc123",
  "object": "chat.completion",
  "created": 1699876543,
  "model": "gpt-4o",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "你好!有什么可以帮助你的吗?"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 20,
    "completion_tokens": 10,
    "total_tokens": 30
  }
}

错误处理

APIPod 返回标准 HTTP 状态码和详细的错误信息:

代码中的错误处理

from openai import OpenAI, APIError, RateLimitError

client = OpenAI(
    base_url="https://api.apipod.ai/v1",
    api_key="sk-your-api-key"
)

try:
    response = client.chat.completions.create(
        model="gpt-4o",
        messages=[{"role": "user", "content": "你好!"}]
    )
except RateLimitError as e:
    print(f"请求频率受限。重试时间:{e.response.headers.get('Retry-After')}")
except APIError as e:
    print(f"API 错误:{e.message}")
import OpenAI from 'openai';

const client = new OpenAI({
  baseURL: 'https://api.apipod.ai/v1',
  apiKey: 'sk-your-api-key',
});

try {
  const response = await client.chat.completions.create({
    model: 'gpt-4o',
    messages: [{ role: 'user', content: '你好!' }],
  });
} catch (error) {
  if (error.status === 429) {
    console.log('请求频率受限,请稍后重试。');
  } else {
    console.error('API 错误:', error.message);
  }
}

流式输出

启用 stream: true 获取实时流式响应:

stream = client.chat.completions.create(
    model="gpt-4o",
    messages=[{"role": "user", "content": "给我讲一个故事"}],
    stream=True
)

for chunk in stream:
    if chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="")
const stream = await client.chat.completions.create({
  model: 'gpt-4o',
  messages: [{ role: 'user', content: '给我讲一个故事' }],
  stream: true,
});

for await (const chunk of stream) {
  process.stdout.write(chunk.choices[0]?.delta?.content || '');
}
curl https://api.apipod.ai/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-your-api-key" \
  -d '{
    "model": "gpt-4o",
    "messages": [{"role": "user", "content": "给我讲一个故事"}],
    "stream": true
  }'

SDK 支持

APIPod 兼容官方 SDK:

Python
pip install openai
Node.js
npm install openai
Go
go get github.com/sashabaranov/go-openai

下一步

On this page

快速开始 | APIPod Docs