API REFERENCE

API 接口参考

OpenAI 兼容接口、认证方式、请求参数与响应结构。

API 接口参考

本站完全兼容 OpenAI API 协议，现有项目只需替换 base_url 即可无缝接入。

基础信息

项目	值
Base URL	`https://api.rootflowai.com`
认证方式	Bearer Token
数据格式	JSON
流式响应	支持（SSE）

认证

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

Authorization: Bearer sk-xxxxxxxxxxxxxxxx

接口列表

Chat Completions（对话补全）

这是最常用的接口，兼容 OpenAI v1/chat/completions。

请求

POST https://api.rootflowai.com/v1/chat/completions

请求体

{
  "model": "claude-sonnet-4-6",
  "messages": [
    {"role": "system", "content": "你是一个有帮助的助手"},
    {"role": "user", "content": "你好"}
  ],
  "temperature": 0.7,
  "max_tokens": 1024,
  "stream": false
}

参数说明

参数	类型	必填	说明
`model`	string	是	模型名称，如 `claude-sonnet-4-6`
`messages`	array	是	对话消息列表
`temperature`	float	否	随机性，0~2，默认 1
`max_tokens`	integer	否	最大输出 Token 数
`stream`	boolean	否	是否开启流式输出，默认 false
`top_p`	float	否	核采样概率，0~1
`stop`	string/array	否	停止序列

响应（非流式）

{
  "id": "chatcmpl-xxx",
  "object": "chat.completion",
  "created": 1748000000,
  "model": "claude-sonnet-4-6",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "你好！有什么我可以帮助你的吗？"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 20,
    "completion_tokens": 15,
    "total_tokens": 35
  }
}

响应（流式 stream: true）

data: {"id":"chatcmpl-xxx","object":"chat.completion.chunk","choices":[{"delta":{"content":"你好"},"index":0}]}

data: {"id":"chatcmpl-xxx","object":"chat.completion.chunk","choices":[{"delta":{"content":"！"},"index":0}]}

data: [DONE]

Models（模型列表）

GET https://api.rootflowai.com/v1/models

返回当前可用的所有模型列表，格式与 OpenAI 一致。

Responses（联网搜索等工具能力）

需要联网搜索、实时资料核验、官网依据或最新信息时，请按模型家族选择对应协议。GPT / OpenAI Responses 模型使用 v1/responses 并显式传入 web_search 工具；Claude 使用 v1/messages 的 web_search_20250305；Gemini 使用 v1beta/models/{model}:generateContent 的 google_search。

POST https://api.rootflowai.com/v1/responses

示例：

{
  "model": "gpt-5.5",
  "tools": [
    {
      "type": "web_search"
    }
  ],
  "tool_choice": "auto",
  "input": "请先联网搜索后回答：gemini3.5flash 是什么模型？"
}

详细说明见：联网搜索能力说明。

SDK 接入示例

Python (openai)

from openai import OpenAI

client = OpenAI(
    api_key="sk-xxxxxxxxxxxxxxxx",
    base_url="https://api.rootflowai.com/v1",
)

response = client.chat.completions.create(
    model="claude-sonnet-4-6",
    messages=[{"role": "user", "content": "Hello"}],
)

Node.js (openai)

import OpenAI from 'openai'

const client = new OpenAI({
  apiKey: 'sk-xxxxxxxxxxxxxxxx',
  baseURL: 'https://api.rootflowai.com/v1',
})

LangChain (Python)

from langchain_openai import ChatOpenAI

llm = ChatOpenAI(
    model="claude-sonnet-4-6",
    openai_api_key="sk-xxxxxxxxxxxxxxxx",
    openai_api_base="https://api.rootflowai.com/v1",
)

与 OpenAI 的差异

本站接口高度兼容 OpenAI API，以下为已知差异：

功能	支持情况
Chat Completions	✅ 完全支持
流式输出（SSE）	✅ 完全支持
Function Calling / Tools	✅ 支持（Claude/GPT）
Vision（图片输入）	✅ 支持（Claude/GPT）
Responses / Web Search	✅ 支持，GPT 使用 `/v1/responses` + `web_search`；Claude/Gemini 请参考原生协议
Embeddings	暂不支持
Audio / TTS / STT	暂不支持
Files / Assistants	暂不支持

注意：/v1/chat/completions 中的“请联网搜索”只是文字指令，不代表模型真的拥有联网能力。需要联网搜索时，请参考联网搜索能力说明。