{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-openagent/cancel-run":{"post":{"operationId":"cloud_aliyun_openagent_cancel_run","summary":"协作式取消 run","description":"POST /openapi/v1/agent/sessions/{sessionId}/runs/{runId}/cancel","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["sessionId","runId"],"properties":{"sessionId":{"type":"string","description":"The sessionId"},"runId":{"type":"string","description":"The runId"},"reason":{"type":"string","description":"可选取消原因"},"X-OpenAgent-Idempotency-Key":{"type":"string","description":"可选幂等键；相同身份、键和请求摘要安全重试，摘要冲突返回 IdempotencyKey.Conflict"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-openagent/create-session":{"post":{"operationId":"cloud_aliyun_openagent_create_session","summary":"创建会话","description":"POST /openapi/v1/agent/sessions","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"title":{"type":"string","description":"会话标题"},"X-OpenAgent-Idempotency-Key":{"type":"string","description":"可选幂等键；相同身份、键和请求摘要安全重试，摘要冲突返回 IdempotencyKey.Conflict"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-openagent/delete-session":{"post":{"operationId":"cloud_aliyun_openagent_delete_session","summary":"删除会话","description":"DELETE /openapi/v1/agent/sessions/{sessionId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["sessionId"],"properties":{"sessionId":{"type":"string","description":"The sessionId"},"X-OpenAgent-Idempotency-Key":{"type":"string","description":"可选幂等键；仅首次删除成功返回200，删除后的重复调用（含同键重试）返回404 Session.NotFound，不回放首次成功结果；目标尚未删除时同键不同摘要返回409 IdempotencyKey.Conflict"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-openagent/get-readonly-mode":{"get":{"operationId":"cloud_aliyun_openagent_get_readonly_mode","summary":"读只读模式","description":"GET /openapi/v1/user/configs/readonly","tags":["cloud"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-openagent/get-run":{"get":{"operationId":"cloud_aliyun_openagent_get_run","summary":"查询 run 详情/终态","description":"GET /openapi/v1/agent/sessions/{sessionId}/runs/{runId}","tags":["cloud"],"parameters":[{"name":"sessionId","in":"query","required":true,"description":"The sessionId","schema":{"type":"string","description":"The sessionId"}},{"name":"runId","in":"query","required":true,"description":"The runId","schema":{"type":"string","description":"The runId"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-openagent/get-session":{"get":{"operationId":"cloud_aliyun_openagent_get_session","summary":"查询会话详情","description":"GET /openapi/v1/agent/sessions/{sessionId}","tags":["cloud"],"parameters":[{"name":"sessionId","in":"query","required":true,"description":"要查询的 Session","schema":{"type":"string","description":"要查询的 Session"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-openagent/list-messages":{"get":{"operationId":"cloud_aliyun_openagent_list_messages","summary":"拉取可渲染历史 timeline","description":"GET /openapi/v1/agent/sessions/{sessionId}/messages","tags":["cloud"],"parameters":[{"name":"sessionId","in":"query","required":true,"description":"The sessionId","schema":{"type":"string","description":"The sessionId"}},{"name":"runId","in":"query","required":false,"description":"仅查询指定 Run","schema":{"type":"string","description":"仅查询指定 Run"},"example":"run_example_001"},{"name":"maxResults","in":"query","required":false,"description":"正整数分页大小；POP 以原始 query 字符串转发，由 Gateway/Core 校验并返回标准错误结构","schema":{"type":"string","description":"正整数分页大小；POP 以原始 query 字符串转发，由 Gateway/Core 校验并返回标准错误结构"},"example":"20"},{"name":"nextToken","in":"query","required":false,"description":"opaque 分页游标","schema":{"type":"string","description":"opaque 分页游标"},"example":"example-next-token"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-openagent/list-sessions":{"get":{"operationId":"cloud_aliyun_openagent_list_sessions","summary":"查询会话列表","description":"GET /openapi/v1/agent/sessions","tags":["cloud"],"parameters":[{"name":"maxResults","in":"query","required":false,"description":"正整数分页大小；POP 以原始 query 字符串转发，由 Gateway/Core 校验并返回标准错误结构","schema":{"type":"string","description":"正整数分页大小；POP 以原始 query 字符串转发，由 Gateway/Core 校验并返回标准错误结构"},"example":"20"},{"name":"nextToken","in":"query","required":false,"description":"opaque 分页游标","schema":{"type":"string","description":"opaque 分页游标"},"example":"example-next-token"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-openagent/send-message":{"post":{"operationId":"cloud_aliyun_openagent_send_message","summary":"统一对话端点(POST→SSE,AG-UI 事件流)","description":"POST /openapi/v1/agent/sessions/{sessionId}/messages","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["sessionId"],"properties":{"sessionId":{"type":"string","description":"The sessionId"},"content":{"type":"string","description":"type=MESSAGE 时必填且非空"},"resume":{"type":"array","description":"type=RESUME 时必填且非空；必须覆盖全部待处理 Interrupt"},"runId":{"type":"string","description":"type=RECONNECT 时必填且非空"},"type":{"type":"string","description":"请求判别式；省略时为 MESSAGE"},"X-OpenAgent-Idempotency-Key":{"type":"string","description":"可选幂等键；相同身份、键和请求摘要安全重试，摘要冲突返回 IdempotencyKey.Conflict"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-openagent/update-readonly-mode":{"post":{"operationId":"cloud_aliyun_openagent_update_readonly_mode","summary":"写只读模式","description":"PUT /openapi/v1/user/configs/readonly","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"value":{"type":"string","description":"true/false(大小写不敏感)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-openagent/update-session":{"post":{"operationId":"cloud_aliyun_openagent_update_session","summary":"原子更新标题/置顶/会话 Toolset","description":"PATCH /openapi/v1/agent/sessions/{sessionId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["sessionId"],"properties":{"sessionId":{"type":"string","description":"The sessionId"},"pinned":{"type":"string","description":"是否置顶；省略表示不修改"},"title":{"type":"string","description":"新标题；省略表示不修改"},"X-OpenAgent-Idempotency-Key":{"type":"string","description":"可选幂等键；相同身份、键和请求摘要安全重试，摘要冲突返回 IdempotencyKey.Conflict"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-openagent/version":{"post":{"operationId":"cloud_aliyun_openagent_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}