POST
/
api
/
project
/
{projectId}
/
integration
/
api
/
session
创建会话
curl --request POST \
  --url https://app.pathors.com/api/project/{projectId}/integration/api/session \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "session_id": "<string>",
  "variables": {},
  "provider": "<string>"
}'
{
  "sessionId": "<string>",
  "pathwayId": "<string>"
}
创建一个新会话，可用于在多个 API 调用之间维护对话上下文。

​
创建会话

POST /api/project/{projectId}/integration/api/session

​
路径参数

​
projectId
string
required
您的项目 ID

​
请求头

​
Authorization
string
required
使用您的 API 密钥进行 Bearer 令牌认证

​
请求体

​
session_id
string
required
会话的唯一标识符。这可以是您选择的任何字符串来标识对话会话。
​
variables
object
可在路径内使用的可选初始会话变量。这些变量可以在您的路径配置中引用。
​
provider
string
会话的可选提供商规范（例如：“api”、“web”）

​
响应

​
sessionId
string
创建的会话 ID（与请求中提供的相同）
​
pathwayId
string
此项目的路径 ID

​
示例

​
请求

curl -X POST https://app.pathors.com/api/project/{projectId}/integration/api/session \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "session_id": "user-123-session-456",
    "variables": {
      "userName": "张三",
      "userRole": "admin",
      "customData": "value"
    },
    "provider": "api"
  }'

​
响应

{
  "sessionId": "user-123-session-456",
  "pathwayId": "project-id-xxx"
}

​
使用说明

  • 会话 ID: 为每个对话选择一个唯一标识符。这可以是 UUID、用户 ID + 时间戳或任何其他唯一字符串。
  • 变量: 会话变量可以在您的路径逻辑中使用。它们在整个会话期间持续存在，并可在对话流程中引用。
  • 可重用性: 创建后，通过包含 session_id 参数或 X-Session-ID 头部，会话可以在多个完成请求中使用。

​
错误响应

状态码描述
400缺少或无效的 session_id
401无效的认证
500内部服务器错误
错误响应示例： 400 请求错误: 
{
  "error": "session_id is required"
}
401 身份验证失败: 
{
  "error": {
    "message": "Invalid authentication"
  }
}