跳至正文

聊天与任务 ​

使用 USER 或 APP_ADMIN 业务身份。所有 Run、事件、确认与会话按应用、用户和租户所有权校验。POST chat 显式使用 Accept,JSON 返回 202,SSE 返回 200 流。

字段类型见数据结构,通用身份和请求头见API 入口。

同次创建请求保留 Idempotency-Key,同键同正文复用 Run,同键不同正文冲突。会话只能有一个活动任务。confirm 正文只提交确认标识与决策,不能替换参数。取消不撤销已经到达业务系统的副作用。

POST /v1/apps/{app}/chat ​

参数 ​

名称位置必填类型与约束
apppath是string;—
Idempotency-Keyheader否string;—

请求正文 ​

Content-Type:application/json;正文必填。

类型:ChatRequest。—

响应 ​

HTTP响应类型数据结构
200text/event-streamstring
202application/jsonRun
400application/jsonError
401application/jsonError
403application/jsonError
404application/jsonError
409application/jsonError
410application/jsonError
412application/jsonError
413application/jsonError
429application/jsonError
500application/jsonError
502application/jsonError
503application/jsonError

GET /v1/apps/{app}/runs/ ​

参数 ​

名称位置必填类型与约束
apppath是string;—
runIdpath是string;—

响应 ​

HTTP响应类型数据结构
200application/jsonRun
400application/jsonError
401application/jsonError
403application/jsonError
404application/jsonError
409application/jsonError
410application/jsonError
412application/jsonError
413application/jsonError
429application/jsonError
500application/jsonError
502application/jsonError
503application/jsonError

GET /v1/apps/{app}/runs/{runId}/events ​

参数 ​

名称位置必填类型与约束
apppath是string;—
runIdpath是string;—
Last-Event-IDheader否string;—

响应 ​

HTTP响应类型数据结构
200application/json数组:AgentEvent
200text/event-streamstring
400application/jsonError
401application/jsonError
403application/jsonError
404application/jsonError
409application/jsonError
410application/jsonError
412application/jsonError
413application/jsonError
429application/jsonError
500application/jsonError
502application/jsonError
503application/jsonError

POST /v1/apps/{app}/runs/{runId}/cancel ​

参数 ​

名称位置必填类型与约束
apppath是string;—
runIdpath是string;—

响应 ​

HTTP响应类型数据结构
200application/jsonRun
400application/jsonError
401application/jsonError
403application/jsonError
404application/jsonError
409application/jsonError
410application/jsonError
412application/jsonError
413application/jsonError
429application/jsonError
500application/jsonError
502application/jsonError
503application/jsonError

POST /v1/apps/{app}/runs/{runId}/confirm ​

参数 ​

名称位置必填类型与约束
apppath是string;—
runIdpath是string;—

请求正文 ​

Content-Type:application/json;正文必填。

类型:Confirmation。—

响应 ​

HTTP响应类型数据结构
200application/jsonConfirmation
400application/jsonError
401application/jsonError
403application/jsonError
404application/jsonError
409application/jsonError
410application/jsonError
412application/jsonError
413application/jsonError
429application/jsonError
500application/jsonError
502application/jsonError
503application/jsonError

GET /v1/apps/{app}/conversations/ ​

参数 ​

名称位置必填类型与约束
apppath是string;—
conversationIdpath是string;—

响应 ​

HTTP响应类型数据结构
200application/jsonobject
400application/jsonError
401application/jsonError
403application/jsonError
404application/jsonError
409application/jsonError
410application/jsonError
412application/jsonError
413application/jsonError
429application/jsonError
500application/jsonError
502application/jsonError
503application/jsonError

会话属于发起主体;同一会话同时只有一个活动 Run。失败、超时与取消的用户消息保留在会话中并携带 status 与 errorCode,但不进入后续模型历史。删除仅移除会话正文,Run、事件、审计与幂等证据保留;带已删除会话号的 chat 返回 404。

PATCH /v1/apps/{app}/conversations/ ​

参数 ​

名称位置必填类型与约束
apppath是string;pattern: "^[a-z][a-z0-9-]{0,63}$"
conversationIdpath是string;—

请求正文 ​

Content-Type:application/json;正文必填。

类型:ConversationRename。—

响应 ​

HTTP响应类型数据结构
200application/jsonConversationRename
400application/jsonError
401application/jsonError
403application/jsonError
404application/jsonError
409application/jsonError

会话属于发起主体;同一会话同时只有一个活动 Run。失败、超时与取消的用户消息保留在会话中并携带 status 与 errorCode,但不进入后续模型历史。删除仅移除会话正文,Run、事件、审计与幂等证据保留;带已删除会话号的 chat 返回 404。

DELETE /v1/apps/{app}/conversations/ ​

参数 ​

名称位置必填类型与约束
apppath是string;pattern: "^[a-z][a-z0-9-]{0,63}$"
conversationIdpath是string;—

响应 ​

HTTP响应类型数据结构
200application/jsonConversationDeletion
401application/jsonError
403application/jsonError
404application/jsonError
409application/jsonError

会话属于发起主体;同一会话同时只有一个活动 Run。失败、超时与取消的用户消息保留在会话中并携带 status 与 errorCode,但不进入后续模型历史。删除仅移除会话正文,Run、事件、审计与幂等证据保留;带已删除会话号的 chat 返回 404。

GET /v1/apps/{app}/runs ​

参数 ​

名称位置必填类型与约束
apppath是string;—

响应 ​

HTTP响应类型数据结构
200application/json数组:Run
其他错误application/jsonError

GET /v1/apps/{app}/runs/{runId}/tool-executions ​

参数 ​

名称位置必填类型与约束
apppath是string;—
runIdpath是string;—

响应 ​

HTTP响应类型数据结构
200application/json数组:ToolExecution

GET /v1/apps/{app}/runs/{runId}/model-invocations ​

参数 ​

名称位置必填类型与约束
apppath是string;—
runIdpath是string;—
limitquery否integer;default: 50;minimum: 1;maximum: 100
offsetquery否integer;default: 0;minimum: 0;maximum: 1000000

响应 ​

HTTP响应类型数据结构
200application/jsonModelInvocationPage
400application/jsonError
401application/jsonError
403application/jsonError
404application/jsonError
409application/jsonError
412application/jsonError

GET /v1/apps/{app}/runs/{runId}/citations/{citationId}/preview ​

参数 ​

名称位置必填类型与约束
apppath是string;—
runIdpath是string;—
citationIdpath是string;pattern: "^cite_[a-zA-Z0-9_-]{1,123}$"

响应 ​

HTTP响应类型数据结构
200application/jsonCitationPreview
400application/jsonError
401application/jsonError
403application/jsonError
404application/jsonError
409application/jsonError
412application/jsonError

GET /v1/apps/{app}/runs/{runId}/trace ​

参数 ​

名称位置必填类型与约束
apppath是string;pattern: "^[a-z][a-z0-9-]{0,63}$"
runIdpath是string;—

响应 ​

HTTP响应类型数据结构
200application/jsonRunTrace
400application/jsonError
401application/jsonError
403application/jsonError
404application/jsonError

GET /v1/apps/{app}/conversations ​

参数 ​

名称位置必填类型与约束
apppath是string;pattern: "^[a-z][a-z0-9-]{0,63}$"
limitquery否integer;default: 50;minimum: 1;maximum: 200
offsetquery否integer;default: 0;minimum: 0;maximum: 1000000

响应 ​

HTTP响应类型数据结构
200application/jsonConversationPage
400application/jsonError
401application/jsonError
403application/jsonError

会话属于发起主体;同一会话同时只有一个活动 Run。失败、超时与取消的用户消息保留在会话中并携带 status 与 errorCode,但不进入后续模型历史。删除仅移除会话正文,Run、事件、审计与幂等证据保留;带已删除会话号的 chat 返回 404。

适用版本:0.1 发布线 · 最近核对:2026-10-03 · SparkTide 产品文档

汇聚智能,驱动涌现。