Skip to content

API 接口参考

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

基础信息

项目
Base URLhttps://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

请求体

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

参数说明

参数类型必填说明
modelstring模型名称,如 claude-sonnet-4-6
messagesarray对话消息列表
temperaturefloat随机性,0~2,默认 1
max_tokensinteger最大输出 Token 数
streamboolean是否开启流式输出,默认 false
top_pfloat核采样概率,0~1
stopstring/array停止序列

响应(非流式)

json
{
  "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 一致。


SDK 接入示例

Python (openai)

python
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)

javascript
import OpenAI from 'openai'

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

LangChain (Python)

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)
Embeddings暂不支持
Audio / TTS / STT暂不支持
Files / Assistants暂不支持

基于 OpenAI 兼容协议