POST
/
api
/
project
/
{projectId}
/
integration
/
api
/
chat
/
completions
curl --request POST \
  --url https://app.pathors.com/api/project/{projectId}/integration/api/chat/completions \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "messages": [
    {}
  ],
  "stream": true,
  "session_id": "<string>"
}'
{
  "id": "<string>",
  "object": "<string>",
  "created": 123,
  "model": "<string>",
  "choices": [
    {}
  ],
  "session_id": "<string>"
}

API 集成提供了一个 OpenAI 兼容的聊天完成端点，您可以用它来与您的 Pathors 项目进行交互。

​
聊天完成

​
路径参数

​
projectId
string
required

您的项目 ID

​
请求头

​
Authorization
string
required

使用您的 API 密钥进行 Bearer 令牌认证

​
X-Session-ID
string

会话 ID，用于对话连续性。强烈建议使用此标头传递会话 ID，而不是请求体中的 session_id 参数。

​
请求体

​
messages
array
required

对话中的消息数组。每条消息都应该有一个 role（“system”、“user” 或 “assistant”）和 content。

​
stream
boolean

是否流式传输响应。默认为 false。

​
session_id
string

(deprecated) 会话 ID，用于对话连续性。建议使用 X-Session-ID 标头代替。仅在不支持自定义标头的环境中使用此参数。

请求示例：

{
  "messages": [
    {
      "role": "user",
      "content": "你好！"
    }
  ],
  "stream": false
}

​
响应头

​
X-Session-ID
string

对话的会话 ID。此头部会在响应中返回，可用于后续请求。

​
响应

​
id
string

完成的唯一标识符

​
object
string

对象类型（“chat.completion”）

​
created
number

完成创建时的 Unix 时间戳

​
model
string

用于完成的模型

​
choices
array

完成选项数组

​
session_id
string

对话的会话 ID

响应示例：

{
  "id": "chatcmpl-abc123",
  "object": "chat.completion",
  "created": 1677858242,
  "model": "pathway-default",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "你好！我能帮你什么忙？"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": -1,
    "completion_tokens": -1,
    "total_tokens": -1
  },
  "session_id": "session-xyz789"
}

​
流式响应

当 stream 设置为 true 时，响应将以服务器发送事件（SSE）的形式流式传输。每个事件包含以下格式的响应块：

{
  "id": "chatcmpl-abc123",
  "object": "chat.completion.chunk",
  "created": 1677858242,
  "model": "pathway-default",
  "choices": [
    {
      "index": 0,
      "delta": {
        "content": "你好"
      },
      "finish_reason": null
    }
  ],
  "session_id": "session-xyz789"
}

最后一个块将有 finish_reason: "stop"，并跟随 data: [DONE]。

​
错误响应

状态码描述
400无效的请求体
401无效的认证
500内部服务器错误

​
设置指南

  1. 在您的 Pathors 项目设置中启用 API 集成
  2. 在您项目的集成设置中生成 API 密钥
  3. 在您的请求中使用 API 密钥作为 Authorization 头部