切换主题
运维接口
指标、审计、应用活动、托管文档和应用租约需要管理身份。归档与全局供应商租约只允许平台管理员；机器契约下载需要有效身份。
GET /v1/apps/{app}/audit
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | 数组：object |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 410 | application/json | Error |
| 412 | application/json | Error |
| 413 | application/json | Error |
| 429 | application/json | Error |
| 500 | application/json | Error |
| 502 | application/json | Error |
| 503 | application/json | Error |
GET /v1/apps/{app}/metrics
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | object |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 410 | application/json | Error |
| 412 | application/json | Error |
| 413 | application/json | Error |
| 429 | application/json | Error |
| 500 | application/json | Error |
| 502 | application/json | Error |
| 503 | application/json | Error |
返回 runCount、byStatus、configuredCost（币种→十进制金额字符串）、unknownCostRuns。费用为配置统计，不是供应商账单。
GET /v1/openapi
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | object |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 410 | application/json | Error |
| 412 | application/json | Error |
| 413 | application/json | Error |
| 429 | application/json | Error |
| 500 | application/json | Error |
| 502 | application/json | Error |
| 503 | application/json | Error |
GET /v1/schemas/agent-event
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | object |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 410 | application/json | Error |
| 412 | application/json | Error |
| 413 | application/json | Error |
| 429 | application/json | Error |
| 500 | application/json | Error |
| 502 | application/json | Error |
| 503 | application/json | Error |
GET /v1/apps/{app}/activity/runs
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| limit | query | 否 | integer；default: 50；minimum: 1；maximum: 200 |
| offset | query | 否 | integer；default: 0；minimum: 0；maximum: 1000000 |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | object |
| 其他错误 | application/json | Error |
返回 {items:Run[],nextOffset:number|null}，按创建时间倒序，nextOffset 为 null 表示结束。
POST /v1/apps/{app}/knowledge/{resourceId}/versions/{version}/documents
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| resourceId | path | 是 | string；— |
| version | path | 是 | string；— |
请求正文
Content-Type：application/json；正文必填。
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | ManagedDocumentResult |
| 其他错误 | application/json | Error |
文档写入只允许 MANAGED 草稿；id/text 必填，text 上限 65536 字符，每版本最多 1000 篇。GET 返回元数据，已发布文档不可修改或删除。
GET /v1/apps/{app}/knowledge/{resourceId}/versions/{version}/documents
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| resourceId | path | 是 | string；— |
| version | path | 是 | string；— |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | 数组：ManagedDocumentSummary |
| 其他错误 | application/json | Error |
文档写入只允许 MANAGED 草稿；id/text 必填，text 上限 65536 字符，每版本最多 1000 篇。GET 返回元数据，已发布文档不可修改或删除。
DELETE /v1/apps/{app}/knowledge/{resourceId}/versions/{version}/documents/
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| resourceId | path | 是 | string；— |
| version | path | 是 | string；— |
| documentId | path | 是 | string；— |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | object |
| 其他错误 | application/json | Error |
文档写入只允许 MANAGED 草稿；id/text 必填，text 上限 65536 字符，每版本最多 1000 篇。GET 返回元数据，已发布文档不可修改或删除。
POST /v1/apps/{app}/maintenance/archive
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
请求正文
Content-Type：application/json；正文必填。
| 字段 | 类型 | 本层必填 | 默认值与约束 |
|---|---|---|---|
| dryRun | boolean | 否 | default: true |
| limit | integer | 否 | default: 100；minimum: 1；maximum: 100 |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | object |
| 其他错误 | application/json | Error |
默认只预览。dryRun=false 才修改热数据，返回本批处理结果；不会默认永久删除归档。
GET /v1/apps/{app}/maintenance/archive/
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| runId | path | 是 | string；— |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | object |
| 其他错误 | application/json | Error |
POST /v1/apps/{app}/leases
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
请求正文
Content-Type：application/json；正文必填。
| 字段 | 类型 | 本层必填 | 默认值与约束 |
|---|---|---|---|
| kind | 枚举 | 是 | enum: ["tools","knowledge","model-providers"] |
| id | string | 是 | — |
| version | string | 是 | — |
| instanceId | string | 是 | — |
| ttlSeconds | integer | 是 | minimum: 10；maximum: 300 |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | object |
| 其他错误 | application/json | Error |
kind/id/version/instanceId 为必填字符串；ttlSeconds 为 10–300。能力定义必须启用 leaseRequired，且知识必须为 REMOTE；全局路径仅支持 model-providers。返回 instanceId/expiresAt。
POST /v1/leases
请求正文
Content-Type：application/json；正文必填。
| 字段 | 类型 | 本层必填 | 默认值与约束 |
|---|---|---|---|
| kind | string | 是 | const: "model-providers" |
| id | string | 是 | — |
| version | string | 是 | — |
| instanceId | string | 是 | — |
| ttlSeconds | integer | 是 | minimum: 10；maximum: 300 |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | object |
| 其他错误 | application/json | Error |
kind/id/version/instanceId 为必填字符串；ttlSeconds 为 10–300。能力定义必须启用 leaseRequired，且知识必须为 REMOTE；全局路径仅支持 model-providers。返回 instanceId/expiresAt。
POST /v1/apps/{app}/tool-executions/{executionId}/reconcile
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| executionId | path | 是 | string；— |
| If-Match | header | 是 | string；— |
请求正文
Content-Type：application/json；正文必填。
| 字段 | 类型 | 本层必填 | 默认值与约束 |
|---|---|---|---|
| status | 枚举 | 是 | enum: ["SUCCEEDED","FAILED"] |
| reason | string | 是 | minLength: 1；maxLength: 1024 |
| evidence | string | 是 | minLength: 1；maxLength: 2048 |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | ToolExecution |
| 403 | application/json | Error |
| 409 | application/json | Error |
| 412 | application/json | Error |
GET /v1/apps/{app}/knowledge/{knowledgeId}/documents/{documentId}/access
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；maxLength: 64 |
| knowledgeId | path | 是 | string；maxLength: 64 |
| documentId | path | 是 | string；maxLength: 128 |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | DocumentAccess |
| 400 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 412 | application/json | Error |
PUT /v1/apps/{app}/knowledge/{knowledgeId}/documents/{documentId}/access
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；maxLength: 64 |
| knowledgeId | path | 是 | string；maxLength: 64 |
| documentId | path | 是 | string；maxLength: 128 |
| If-Match | header | 是 | string；— |
请求正文
Content-Type：application/json；正文必填。
| 字段 | 类型 | 本层必填 | 默认值与约束 |
|---|---|---|---|
| enabled | boolean | 是 | — |
| subjects | 数组：string | 否 | maxItems: 256；uniqueItems: true |
| tenants | 数组：string | 否 | maxItems: 256；uniqueItems: true |
| roles | 数组：string | 否 | maxItems: 256；uniqueItems: true |
| reason | string | 是 | minLength: 1；maxLength: 1024 |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | DocumentAccess |
| 400 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 412 | application/json | Error |
GET /v1/apps/{app}/model-invocations/
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| invocationId | path | 是 | string；— |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | ModelInvocation |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 412 | application/json | Error |
POST /v1/apps/{app}/model-invocations/{invocationId}/reconcile
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| invocationId | path | 是 | string；— |
| If-Match | header | 是 | string；— |
请求正文
Content-Type：application/json；正文必填。
类型：ModelReconciliationRequest。—
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | ModelInvocation |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 412 | application/json | Error |
GET /v1/apps/{app}/model-bindings/{resourceId}/versions/{version}/health
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| resourceId | path | 是 | string；— |
| version | path | 是 | string；— |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | ModelHealthState |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 412 | application/json | Error |
| 429 | application/json | Error |
| 503 | application/json | Error |
GET /v1/apps/{app}/model-bindings/{resourceId}/versions/{version}/probes
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| resourceId | path | 是 | string；— |
| version | path | 是 | string；— |
| limit | query | 否 | integer；default: 20；minimum: 1；maximum: 100 |
| offset | query | 否 | integer；default: 0；minimum: 0；maximum: 1000000 |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | ModelProbePage |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 412 | application/json | Error |
| 429 | application/json | Error |
| 503 | application/json | Error |
POST /v1/apps/{app}/model-bindings/{resourceId}/versions/{version}/probes
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| resourceId | path | 是 | string；— |
| version | path | 是 | string；— |
请求正文
Content-Type：application/json；正文必填。
类型：ModelProbeRequest。—
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | ModelProbeResult |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 412 | application/json | Error |
| 429 | application/json | Error |
| 503 | application/json | Error |
POST /v1/apps/{app}/model-bindings/{resourceId}/versions/{version}/health/reset
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| resourceId | path | 是 | string；— |
| version | path | 是 | string；— |
| If-Match | header | 是 | string；— |
请求正文
Content-Type：application/json；正文必填。
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | ModelHealthState |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 412 | application/json | Error |
| 429 | application/json | Error |
| 503 | application/json | Error |
GET /v1/apps/{app}/quotas
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | QuotaConfiguration |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 412 | application/json | Error |
PUT /v1/apps/{app}/quotas
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| If-Match | header | 是 | string；— |
请求正文
Content-Type：application/json；正文必填。
类型：QuotaConfigurationRequest。—
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | QuotaConfiguration |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 412 | application/json | Error |
GET /v1/apps/{app}/quotas/usage
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| limit | query | 否 | integer；default: 50；minimum: 1；maximum: 100 |
| offset | query | 否 | integer；default: 0；minimum: 0；maximum: 1000000 |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | QuotaUsagePage |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 412 | application/json | Error |
GET /v1/apps/{app}/quota-reservations
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| limit | query | 否 | integer；default: 50；minimum: 1；maximum: 100 |
| offset | query | 否 | integer；default: 0；minimum: 0；maximum: 1000000 |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | QuotaReservationPage |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 412 | application/json | Error |
POST /v1/apps/{app}/quota-reservations/{reservationId}/reconcile
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| reservationId | path | 是 | string；— |
| If-Match | header | 是 | string；— |
请求正文
Content-Type：application/json；正文必填。
类型：ModelReconciliationRequest。—
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | QuotaReservation |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 412 | application/json | Error |
POST /v1/apps/{app}/knowledge/{resourceId}/versions/{version}/documents/preview
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| resourceId | path | 是 | string；— |
| version | path | 是 | string；— |
请求正文
Content-Type：application/json；正文必填。
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | ManagedDocumentPreview |
| 其他错误 | application/json | Error |
文档写入只允许 MANAGED 草稿；id/text 必填，text 上限 65536 字符，每版本最多 1000 篇。GET 返回元数据，已发布文档不可修改或删除。
POST /v1/apps/{app}/knowledge/{resourceId}/versions/{version}/documents/batch
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| resourceId | path | 是 | string；— |
| version | path | 是 | string；— |
请求正文
Content-Type：application/json；正文必填。
类型：ManagedDocumentBatchRequest。—
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | ManagedDocumentBatchResult |
| 其他错误 | application/json | Error |
文档写入只允许 MANAGED 草稿；id/text 必填，text 上限 65536 字符，每版本最多 1000 篇。GET 返回元数据，已发布文档不可修改或删除。
POST /v1/apps/{app}/knowledge/{resourceId}/versions/{version}/documents/rebuild
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| resourceId | path | 是 | string；— |
| version | path | 是 | string；— |
请求正文
Content-Type：application/json；正文必填。
类型：ManagedDocumentRebuildRequest。—
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | ManagedDocumentBatchResult |
| 其他错误 | application/json | Error |
文档写入只允许 MANAGED 草稿；id/text 必填，text 上限 65536 字符，每版本最多 1000 篇。GET 返回元数据，已发布文档不可修改或删除。
POST /v1/apps/{app}/knowledge/{knowledgeId}/versions/{version}/ingestions
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| knowledgeId | path | 是 | string；— |
| version | path | 是 | string；— |
请求正文
Content-Type：multipart/form-data；正文必填。
| 字段 | 类型 | 本层必填 | 默认值与约束 |
|---|---|---|---|
| file | string | 是 | format: "binary"；1..4 MiB original. Allowed extension TXT/MD/PDF/DOCX/XLSX/PPTX/PNG/JPEG; parser validates contents. |
| metadata | DocumentUploadMetadata | 是 | — |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 202 | application/json | IngestionJob |
| 其他错误 | application/json | Error |
GET /v1/apps/{app}/knowledge/{knowledgeId}/versions/{version}/ingestions
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| knowledgeId | path | 是 | string；— |
| version | path | 是 | string；— |
| limit | query | 否 | integer；default: 20；minimum: 1；maximum: 100 |
| offset | query | 否 | integer；default: 0；minimum: 0；maximum: 1000000 |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | IngestionPage |
| 其他错误 | application/json | Error |
GET /v1/apps/{app}/knowledge/{knowledgeId}/versions/{version}/ingestions/
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| knowledgeId | path | 是 | string；— |
| version | path | 是 | string；— |
| jobId | path | 是 | string；— |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | IngestionJob |
| 其他错误 | application/json | Error |
DELETE /v1/apps/{app}/knowledge/{knowledgeId}/versions/{version}/ingestions/
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| knowledgeId | path | 是 | string；— |
| version | path | 是 | string；— |
| jobId | path | 是 | string；— |
| If-Match | header | 是 | string；— |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | object |
| 其他错误 | application/json | Error |
POST /v1/apps/{app}/knowledge/{knowledgeId}/versions/{version}/ingestions/{jobId}/cancel
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| knowledgeId | path | 是 | string；— |
| version | path | 是 | string；— |
| jobId | path | 是 | string；— |
| If-Match | header | 是 | string；— |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | IngestionJob |
| 其他错误 | application/json | Error |
POST /v1/apps/{app}/knowledge/{knowledgeId}/versions/{version}/ingestions/{jobId}/retry
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| knowledgeId | path | 是 | string；— |
| version | path | 是 | string；— |
| jobId | path | 是 | string；— |
| If-Match | header | 是 | string；— |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | IngestionJob |
| 其他错误 | application/json | Error |
GET /v1/apps/{app}/knowledge/{knowledgeId}/versions/{version}/ingestions/{jobId}/original
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| knowledgeId | path | 是 | string；— |
| version | path | 是 | string；— |
| jobId | path | 是 | string；— |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/octet-stream | string |
| 其他错误 | application/json | Error |
GET /v1/apps/{app}/knowledge/{knowledgeId}/versions/{version}/ingestions/{jobId}/parsed
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| knowledgeId | path | 是 | string；— |
| version | path | 是 | string；— |
| jobId | path | 是 | string；— |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | text/plain | string |
| 其他错误 | application/json | Error |
POST /v1/apps/{app}/knowledge/{knowledgeId}/versions/{version}/retrieval-debug
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| knowledgeId | path | 是 | string；— |
| version | path | 是 | string；— |
请求正文
Content-Type：application/json；正文必填。
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | KnowledgeDebugResult |
| 其他错误 | application/json | Error |
POST /v1/apps/{app}/knowledge/{knowledgeId}/evaluations
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| knowledgeId | path | 是 | string；— |
请求正文
Content-Type：application/json；正文必填。
类型：KnowledgeEvaluationRequest。—
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | KnowledgeEvaluation |
| 其他错误 | application/json | Error |
GET /v1/apps/{app}/knowledge/{knowledgeId}/evaluations
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| knowledgeId | path | 是 | string；— |
| limit | query | 否 | integer；default: 10；minimum: 1；maximum: 20 |
| offset | query | 否 | integer；default: 0；minimum: 0；maximum: 1000000 |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | KnowledgeEvaluationPage |
| 其他错误 | application/json | Error |
GET /v1/apps/{app}/knowledge/{knowledgeId}/evaluations/
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| knowledgeId | path | 是 | string；— |
| evaluationId | path | 是 | string；— |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | KnowledgeEvaluation |
| 其他错误 | application/json | Error |
DELETE /v1/apps/{app}/knowledge/{knowledgeId}/evaluations/
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| knowledgeId | path | 是 | string；— |
| evaluationId | path | 是 | string；— |
| If-Match | header | 是 | string；— |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | object |
| 其他错误 | application/json | Error |
GET /v1/apps/{app}/knowledge/{knowledgeId}/versions/{version}/vectors
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| knowledgeId | path | 是 | string；— |
| version | path | 是 | string；— |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | VectorIndexHealth |
| 其他错误 | application/json | Error |
POST /v1/apps/{app}/knowledge/{knowledgeId}/versions/{version}/vectors/jobs
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| knowledgeId | path | 是 | string；— |
| version | path | 是 | string；— |
请求正文
Content-Type：application/json；正文必填。
类型：VectorBuildRequest。—
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 202 | application/json | VectorBuildJob |
| 其他错误 | application/json | Error |
GET /v1/apps/{app}/knowledge/{knowledgeId}/versions/{version}/vectors/jobs
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| knowledgeId | path | 是 | string；— |
| version | path | 是 | string；— |
| limit | query | 否 | integer；default: 10；minimum: 1；maximum: 20 |
| offset | query | 否 | integer；default: 0；minimum: 0；maximum: 1000000 |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | VectorBuildPage |
| 其他错误 | application/json | Error |
GET /v1/apps/{app}/knowledge/{knowledgeId}/versions/{version}/vectors/jobs/
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| knowledgeId | path | 是 | string；— |
| version | path | 是 | string；— |
| jobId | path | 是 | string；— |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | VectorBuildJob |
| 其他错误 | application/json | Error |
DELETE /v1/apps/{app}/knowledge/{knowledgeId}/versions/{version}/vectors/jobs/
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| knowledgeId | path | 是 | string；— |
| version | path | 是 | string；— |
| jobId | path | 是 | string；— |
| If-Match | header | 是 | string；— |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | object |
| 其他错误 | application/json | Error |
POST /v1/apps/{app}/knowledge/{knowledgeId}/versions/{version}/vectors/jobs/{jobId}/cancel
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| knowledgeId | path | 是 | string；— |
| version | path | 是 | string；— |
| jobId | path | 是 | string；— |
| If-Match | header | 是 | string；— |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | VectorBuildJob |
| 其他错误 | application/json | Error |
POST /v1/apps/{app}/knowledge/{knowledgeId}/versions/{version}/vectors/jobs/{jobId}/retry
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| knowledgeId | path | 是 | string；— |
| version | path | 是 | string；— |
| jobId | path | 是 | string；— |
| If-Match | header | 是 | string；— |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 202 | application/json | VectorBuildJob |
| 其他错误 | application/json | Error |
GET /v1/apps/{app}/audit/records
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
| action | query | 否 | string；minLength: 1；maxLength: 256 |
| subjectId | query | 否 | string；minLength: 1；maxLength: 256 |
| tenantId | query | 否 | string；maxLength: 256 |
| runId | query | 否 | string；minLength: 1；maxLength: 256 |
| executionId | query | 否 | string；minLength: 1；maxLength: 256 |
| from | query | 否 | integer；minimum: 0；format: "int64" |
| to | query | 否 | integer；minimum: 0；format: "int64" |
| limit | query | 否 | integer；default: 50；minimum: 1；maximum: 100 |
| cursor | query | 否 | string；minLength: 1；maxLength: 2048；pattern: "^[A-Za-z0-9_-]+$" |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | AuditPage |
| 409 | application/json | Error |
| 410 | application/json | Error |
| 429 | application/json | Error |
| 其他错误 | application/json | Error |
POST /v1/apps/{app}/audit/export
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
请求正文
Content-Type：application/json；正文必填。
类型：AuditQuery。—
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | AuditExport |
| 409 | application/json | Error |
| 410 | application/json | Error |
| 429 | application/json | Error |
| 其他错误 | application/json | Error |
POST /v1/apps/{app}/audit/retention/preview
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
请求正文
Content-Type：application/json；正文必填。
类型：AuditRetentionPreviewRequest。—
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | AuditRetentionPreview |
| 409 | application/json | Error |
| 410 | application/json | Error |
| 429 | application/json | Error |
| 其他错误 | application/json | Error |
POST /v1/apps/{app}/audit/retention/apply
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；— |
请求正文
Content-Type：application/json；正文必填。
类型：AuditRetentionApply。—
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | AuditRetentionReceipt |
| 409 | application/json | Error |
| 410 | application/json | Error |
| 429 | application/json | Error |
| 其他错误 | application/json | Error |
GET /v1/apps/{app}/observability
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；pattern: "^[a-z][a-z0-9-]{0,63}$" |
| hours | query | 否 | integer；default: 24；minimum: 1；maximum: 168 |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | ObservationSummary |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
GET /v1/operations/observability
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | ObservationStatus |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
GET /v1/operations/metrics
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | text/plain | string |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
返回 runCount、byStatus、configuredCost（币种→十进制金额字符串）、unknownCostRuns。费用为配置统计，不是供应商账单。
GET /v1/apps/{app}/alert-rules
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；pattern: "^[a-z][a-z0-9-]{0,63}$" |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | AlertRuleList |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
POST /v1/apps/{app}/alert-rules
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；pattern: "^[a-z][a-z0-9-]{0,63}$" |
| If-Match | header | 否 | string；— |
请求正文
Content-Type：application/json；正文必填。
类型：AlertRuleInput。—
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | AlertRule |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 412 | application/json | Error |
DELETE /v1/apps/{app}/alert-rules/
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；pattern: "^[a-z][a-z0-9-]{0,63}$" |
| ruleId | path | 是 | string；pattern: "^[a-z][a-z0-9-]{0,63}$" |
| If-Match | header | 是 | string；— |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | AlertRuleDeletion |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 412 | application/json | Error |
GET /v1/apps/{app}/alerts
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；pattern: "^[a-z][a-z0-9-]{0,63}$" |
| state | query | 否 | string；enum: ["FIRING","ACKNOWLEDGED","RESOLVED"] |
| limit | query | 否 | integer；default: 50；minimum: 1；maximum: 100 |
| offset | query | 否 | integer；default: 0；minimum: 0；maximum: 1000000 |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | AlertPage |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
GET /v1/apps/{app}/alerts/
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；pattern: "^[a-z][a-z0-9-]{0,63}$" |
| alertId | path | 是 | string；— |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | AlertInstance |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
POST /v1/apps/{app}/alerts/{alertId}/acknowledge
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；pattern: "^[a-z][a-z0-9-]{0,63}$" |
| alertId | path | 是 | string；— |
| If-Match | header | 是 | string；— |
请求正文
Content-Type：application/json；正文必填。
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | AlertInstance |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 412 | application/json | Error |
POST /v1/apps/{app}/alerts/{alertId}/resolve
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；pattern: "^[a-z][a-z0-9-]{0,63}$" |
| alertId | path | 是 | string；— |
| If-Match | header | 是 | string；— |
请求正文
Content-Type：application/json；正文必填。
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | AlertInstance |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 412 | application/json | Error |
POST /v1/apps/{app}/alerts/evaluate
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；pattern: "^[a-z][a-z0-9-]{0,63}$" |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | AlertEvaluation |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
GET /v1/operations/alerts
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| limit | query | 否 | integer；default: 50；minimum: 1；maximum: 100 |
| offset | query | 否 | integer；default: 0；minimum: 0；maximum: 1000000 |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | PlatformAlertPage |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
POST /v1/operations/alerts/evaluate
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | AlertEvaluation |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
POST /v1/operations/alerts/{alertId}/acknowledge
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| alertId | path | 是 | string；— |
| If-Match | header | 是 | string；— |
请求正文
Content-Type：application/json；正文必填。
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | AlertInstance |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 412 | application/json | Error |
POST /v1/operations/alerts/{alertId}/resolve
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| alertId | path | 是 | string；— |
| If-Match | header | 是 | string；— |
请求正文
Content-Type：application/json；正文必填。
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | AlertInstance |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 412 | application/json | Error |
GET /v1/operations/status
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | OpsStatus |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
GET /v1/apps/{app}/eval-datasets
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；pattern: "^[a-z][a-z0-9-]{0,63}$" |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | EvalDatasetList |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 412 | application/json | Error |
POST /v1/apps/{app}/eval-datasets
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；pattern: "^[a-z][a-z0-9-]{0,63}$" |
| If-Match | header | 否 | string；— |
请求正文
Content-Type：application/json；正文必填。
类型：EvalDatasetInput。—
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | EvalDataset |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 412 | application/json | Error |
GET /v1/apps/{app}/eval-runs
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；pattern: "^[a-z][a-z0-9-]{0,63}$" |
| limit | query | 否 | integer；default: 50；minimum: 1；maximum: 100 |
| offset | query | 否 | integer；default: 0；minimum: 0；maximum: 1000000 |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | EvalRunPage |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 412 | application/json | Error |
POST /v1/apps/{app}/eval-runs
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；pattern: "^[a-z][a-z0-9-]{0,63}$" |
请求正文
Content-Type：application/json；正文必填。
类型：EvalRunStart。—
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | EvalRun |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 412 | application/json | Error |
| 429 | application/json | Error |
GET /v1/apps/{app}/eval-runs/
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；pattern: "^[a-z][a-z0-9-]{0,63}$" |
| evalId | path | 是 | string；— |
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | EvalRun |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 412 | application/json | Error |
POST /v1/apps/{app}/eval-runs/{evalId}/cases/{caseId}/score
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| app | path | 是 | string；pattern: "^[a-z][a-z0-9-]{0,63}$" |
| evalId | path | 是 | string；— |
| caseId | path | 是 | string；pattern: "^[a-z][a-z0-9-]{0,63}$" |
| If-Match | header | 否 | string；— |
请求正文
Content-Type：application/json；正文必填。
类型：EvalManualScore。—
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | EvalRun |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 412 | application/json | Error |
GET /v1/operations/evaluations
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | EvaluationEngineStatus |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 404 | application/json | Error |
| 409 | application/json | Error |
| 412 | application/json | Error |
GET /v1/operations/retention
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | RetentionPreview |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 412 | application/json | Error |
PUT /v1/operations/retention
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| If-Match | header | 是 | string；— |
请求正文
Content-Type：application/json；正文必填。
类型：RetentionPolicyInput。—
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | RetentionPolicy |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 412 | application/json | Error |
GET /v1/operations/retention/status
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | RetentionStatus |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 412 | application/json | Error |
POST /v1/operations/retention/sweep
请求正文
Content-Type：application/json；正文必填。
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | RetentionSweepResult / RetentionSweepPreview |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 412 | application/json | Error |
GET /v1/operations/redaction
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | RedactionPolicy |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 412 | application/json | Error |
PUT /v1/operations/redaction
参数
| 名称 | 位置 | 必填 | 类型与约束 |
|---|---|---|---|
| If-Match | header | 是 | string；— |
请求正文
Content-Type：application/json；正文必填。
类型：RedactionPolicyInput。—
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | RedactionPolicy |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 412 | application/json | Error |
GET /v1/operations/redaction/status
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | RedactionStatus |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 412 | application/json | Error |
POST /v1/operations/redaction/preview
请求正文
Content-Type：application/json；正文必填。
响应
| HTTP | 响应类型 | 数据结构 |
|---|---|---|
| 200 | application/json | RedactionPreview |
| 400 | application/json | Error |
| 401 | application/json | Error |
| 403 | application/json | Error |
| 412 | application/json | Error |