跳转到主要内容
OpenAI 兼容的对话补全端点。如果你已经在使用 OpenAI SDK,只需更改 base_urlapi_key 即可无缝迁移。

认证

支持两种认证方式:
  • API KeyAuthorization: Bearer sk-pro-xxxx
  • OAuth BearerAuthorization: Bearer <access_token>

请求体

model
string
必填
模型标识符。使用 GET /v1/models 查询可用模型。
messages
array
必填
对话消息数组。每条消息包含 rolecontent 字段。
stream
boolean
默认值:"false"
是否使用 SSE 流式返回。
temperature
number
采样温度,范围 0-2。值越高输出越随机。部分模型不支持此参数(参见模型 capabilities)。
max_tokens
integer
生成的最大 token 数。
top_p
number
Nucleus sampling 参数。
frequency_penalty
number
频率惩罚参数,范围 -2.0 到 2.0。
presence_penalty
number
存在惩罚参数,范围 -2.0 到 2.0。
stop
string | string[]
停止生成的标记。
tools
array
Function Calling 工具定义数组(与 OpenAI 格式一致)。
tool_choice
string | object
工具选择策略:"auto""none" 或指定工具。

非流式请求示例

非流式响应

响应中额外包含 balance_remaining 字段,返回调用后的剩余积分余额。这是与 OpenAI 的主要差异之一。

流式请求示例

作为 OpenAI 替代

如果你正在使用 OpenAI 的官方 SDK,只需修改 base_urlapi_key

调用袋袋专家(Expert-as-Model)

除了直接调用裸模型,你还可以通过 profy-<identifier> 格式的模型名调用袋袋平台上已发布的专家(AI Agent)。专家背后是完整的 Agent 能力栈:人格、工具调用、记忆、技能——而你只需像调用普通模型一样使用它。

模型命名约定

使用 GET /v1/models 可以查询所有可用的专家模型(type: "expert")。

请求示例(非流式)

默认行为(stream 省略或为 false):Agent 完成全部推理和工具调用后,一次性返回完整 JSON 响应。

请求示例(流式)

设置 stream: true 可实时接收增量内容,适合需要即时展示文字的场景。

多轮对话(Session)

首次调用时系统自动创建 session,session ID 通过响应头 X-Session-Id 返回。后续调用通过以下任一方式传入 session ID 来续接对话:
  • 请求体 session_id 字段(推荐,OpenAI SDK 通过 extra_body 传递)
  • 请求头 X-Session-Id

Expert-as-Model 与 Agents Run 的对比

如果你需要观测 Agent 的完整工具调用过程(如展示”正在搜索…”、“正在分析数据…”等中间状态),请使用 /v1/agents/run 端点配合 Profy SDK。

与 OpenAI 的差异

使用 GET /v1/models 查询每个模型的 capabilities,了解该模型是否支持 temperature、tools、vision 等功能。

错误码

下一步

模型列表

查询可用模型及其能力

上报计费事件

上报自定义计费事件