Skip to content

GPT 模型接口文档

兼容 OpenAI Chat Completions 接口,支持 GPT 系列模型的普通消息、流式输出与工具调用。

Base URLhttps://agentpivot.ai/


登录平台


接口概览

方法路径说明
POST/v1/chat/completions统一消息接口(普通 / 流式 / 工具调用)

鉴权

二选一,任选一种即可:

Header说明
x-api-key: <API_KEY>使用 API Key
Authorization: Bearer <token>使用 JWT 或 Bearer Token

示例:

bash
curl -X POST "https://api.agentpivot.ai/v1/chat/completions" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5",
    "messages": [{"role": "user", "content": "Hello, how are you?"}],
    "max_tokens": 1024,
    "temperature": 0.7
  }'

POST /v1/chat/completions

请求

  • Content-Typeapplication/json
  • Body
字段类型必填说明
modelstring模型标识,如 gpt-5.4gpt-4ogpt-4.1
messagesarray对话消息列表,每项含 rolesystem/user/assistant)、content(字符串)
max_tokensnumber回复最大 token 数
temperaturenumber采样温度,范围 0~2,默认 1
top_pnumber核采样概率,范围 0~1,默认 1
streambooleantrue 时返回 SSE 流式 响应
toolsarray工具定义列表,有且 length > 0 时走 工具调用
tool_choicestring/object工具选择策略,如 autononerequired

messages 单项结构:

字段类型说明
rolestringsystem | user | assistant | tool
contentstring消息内容

tools 单项结构(工具调用时):

字段类型说明
typestring固定为 function
function.namestring函数名称,如 get_weather
function.descriptionstring函数描述
function.parametersobject参数 JSON Schema:type: "object"propertiesrequired

行为说明

  1. 流式:当 stream === true 时,响应为 SSEContent-Type: text/event-stream),每行以 data: 开头,最终以 data: [DONE] 结束。
  2. 工具调用:当 tools 存在且长度 > 0 时,模型可能返回 tool_calls,需将工具执行结果作为 role: tool 消息追加后继续请求。
  3. 普通消息:其余情况为普通对话,支持 max_tokenstemperature 等参数,响应为 JSON。

响应

普通消息(JSON)

json
{
  "id": "chatcmpl-xxx",
  "object": "chat.completion",
  "created": 1700000000,
  "model": "gpt-5.4",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "I'm doing well, thank you!"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 12,
    "completion_tokens": 10,
    "total_tokens": 22
  }
}
字段类型说明
idstring请求 ID
objectstring固定为 chat.completion
choicesarray回复列表,通常只有一项
choices[].message.rolestring角色,固定为 assistant
choices[].message.contentstring回复内容
choices[].finish_reasonstring结束原因:stop / length / tool_calls
usage.prompt_tokensnumber输入 token 数
usage.completion_tokensnumber输出 token 数

流式(SSE)

  • Content-Typetext/event-stream
  • 每行格式:data: {"id":"...","object":"chat.completion.chunk","choices":[{"delta":{"content":"..."},"index":0}]}
  • 结束标志:data: [DONE]

工具调用

模型返回 finish_reason: "tool_calls" 时,message.tool_calls 包含调用信息:

json
{
  "choices": [{
    "message": {
      "role": "assistant",
      "content": null,
      "tool_calls": [{
        "id": "call_xxx",
        "type": "function",
        "function": {
          "name": "get_weather",
          "arguments": "{\"location\":\"北京\"}"
        }
      }]
    },
    "finish_reason": "tool_calls"
  }]
}

模型列表

GPT-3.5 系列

模型名称
gpt-3.5-turbo
gpt-3.5-turbo-0125
gpt-3.5-turbo-1106
gpt-3.5-turbo-16k
gpt-3.5-turbo-16k-0613

GPT-4 系列

模型名称
gpt-4
gpt-4-0613
gpt-4-32k
gpt-4-32k-0613
gpt-4-turbo
gpt-4-turbo-preview
gpt-4-turbo-2024-04-09
gpt-4-0125-preview
gpt-4-1106-preview

GPT-4o 系列

模型名称
gpt-4o
gpt-4o-2024-05-13
gpt-4o-2024-08-06
gpt-4o-2024-11-20
gpt-4o-mini
gpt-4o-mini-2024-07-18
gpt-4o-mini-tts
gpt-4o-realtime-preview
gpt-4o-realtime-preview-2024-12-17
gpt-4o-transcribe
gpt-4o-transcribe-diarize

GPT-4.1 系列

模型名称
gpt-4.1
gpt-4.1-2025-04-14
gpt-4.1-mini
gpt-4.1-mini-2025-04-14
gpt-4.1-nano
gpt-4.1-nano-2025-04-14

GPT-5 系列

模型名称
gpt-5
gpt-5-2025-08-07
gpt-5-chat
gpt-5-chat-2025-08-07
gpt-5-chat-latest
gpt-5-codex
gpt-5-mini
gpt-5-mini-2025-08-07
gpt-5-nano
gpt-5-nano-2025-08-07

GPT-5.1 系列

模型名称
gpt-5.1
gpt-5.1-2025-11-13
gpt-5.1-chat
gpt-5.1-chat-2025-11-13
gpt-5.1-chat-latest
gpt-5.1-codex-max

GPT-5.2 系列

模型名称
gpt-5.2
gpt-5.2-2025-12-11
gpt-5.2-chat
gpt-5.2-chat-latest
gpt-5.2-chat-2025-12-11

GPT-5.3 系列

模型名称
gpt-5.3-codex
gpt-5.3-chat
gpt-5.3-chat-latest
gpt-5.3-chat-2026-03-03

GPT-5.4 系列

模型名称
gpt-5.4
gpt-5.4-2026-03-05
gpt-5.4-mini
gpt-5.4-nano
gpt-5.4-pro

GPT 扩展能力模型

模型名称说明
gpt-image-1图像生成
gpt-image-1.5图像生成
gpt-realtime实时语音
gpt-realtime-2025-08-28实时语音
gpt-oss-120b开源大模型

请求示例

1. 普通消息

json
{
  "model": "gpt-5.4",
  "messages": [
    {"role": "system", "content": "You are a helpful assistant."},
    {"role": "user", "content": "Hello, how are you?"}
  ],
  "max_tokens": 1024,
  "temperature": 0.7
}

2. 流式

json
{
  "model": "gpt-4o",
  "messages": [
    {"role": "user", "content": "用一句话介绍自己"}
  ],
  "stream": true
}

流式 curl 示例:

bash
curl -X POST "https://api.agentpivot.ai/v1/chat/completions" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4o",
    "messages": [{"role": "user", "content": "Hello"}],
    "stream": true
  }'

3. 工具调用

json
{
  "model": "gpt-4o",
  "messages": [
    {"role": "user", "content": "今天北京的天气怎么样?"}
  ],
  "tools": [{
    "type": "function",
    "function": {
      "name": "get_weather",
      "description": "获取指定城市的当前天气",
      "parameters": {
        "type": "object",
        "properties": {
          "location": {"type": "string", "description": "城市名称,如:北京"}
        },
        "required": ["location"]
      }
    }
  }],
  "tool_choice": "auto"
}

4. 多轮对话

json
{
  "model": "gpt-4o",
  "messages": [
    {"role": "system", "content": "你是一个专业的助手。"},
    {"role": "user", "content": "什么是机器学习?"},
    {"role": "assistant", "content": "机器学习是人工智能的一个分支..."},
    {"role": "user", "content": "能举个例子吗?"}
  ]
}

5. 图像生成(gpt-image-1)

bash
curl -X POST "https://api.agentpivot.ai/v1/chat/completions" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-image-1",
    "messages": [
      {"role": "user", "content": "画一只在草地上奔跑的金毛犬"}
    ]
  }'

测试脚本

bash
export API_KEY="YOUR_API_KEY"

curl -X POST "https://api.agentpivot.ai/v1/chat/completions" \
  -H "x-api-key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.4",
    "messages": [{"role": "user", "content": "Hello, how are you?"}],
    "max_tokens": 1024,
    "temperature": 0.7
  }'