{"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-ada/create-agent":{"post":{"operationId":"cloud_aliyun_ada_create_agent","summary":"Creates an Agent","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name"],"properties":{"endpoint":{"type":"string","enum":["https://ada.cn-beijing.aliyuncs.com","https://ada.cn-hangzhou.aliyuncs.com","https://ada.cn-shanghai.aliyuncs.com"],"default":"https://ada.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://ada.cn-hangzhou.aliyuncs.com"},"Name":{"type":"string","description":"The Agent name, which is also the unique identifier that cannot be modified after creation"},"DisplayName":{"type":"string","description":"The display name of the Agent"},"Description":{"type":"string","description":"The description of the Agent"},"SystemPrompt":{"type":"string","description":"The system prompt"},"Tools":{"type":"string","description":"The reference list of MCP Server and Connector names. The same array supports both types of entries. Each entry specifies one type of…"},"Skills":{"type":"string","description":"The Skill reference list. For specific fields, see \"Supplementary description of request parameters\""},"KnowledgeBases":{"type":"string","description":"The knowledge base reference list, which contains at most one element"},"Visibility":{"type":"string","enum":["user","tenant"],"description":"The visibility scope of the Agent. Valid values: user tenant Default value: user"}}}}}},"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-ada/create-skill":{"post":{"operationId":"cloud_aliyun_ada_create_skill","summary":"Creates a Skill","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name","Description","Metadata"],"properties":{"endpoint":{"type":"string","enum":["https://ada.cn-beijing.aliyuncs.com","https://ada.cn-hangzhou.aliyuncs.com","https://ada.cn-shanghai.aliyuncs.com"],"default":"https://ada.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://ada.cn-hangzhou.aliyuncs.com"},"Name":{"type":"string","description":"The unique identifier of the Skill. Only letters, digits, underscores, and hyphens are supported. The value can be up to 64 characters in…"},"Description":{"type":"string","description":"The description of the Skill"},"Metadata":{"type":"string","description":"The Skill metadata in JSON object format. Exactly one content source must be provided. For more information about the fields, see \"Request…"},"Visibility":{"type":"string","description":"The visibility of the Skill. Valid values: user tenant Default value: user"}}}}}},"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-ada/create-transit-upload-policy":{"post":{"operationId":"cloud_aliyun_ada_create_transit_upload_policy","summary":"Generates a credential for direct file upload. The caller can use the returned upload policy to upload a…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["FileShowName"],"properties":{"endpoint":{"type":"string","enum":["https://ada.cn-beijing.aliyuncs.com","https://ada.cn-hangzhou.aliyuncs.com","https://ada.cn-shanghai.aliyuncs.com"],"default":"https://ada.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://ada.cn-hangzhou.aliyuncs.com"},"PathPrefix":{"type":"string","description":"The path prefix used for object key isolation. This prefix has no Artifact business directory semantics. Default value: `default`"},"ExpireMs":{"type":"integer","description":"The validity period of the upload policy and the Transit record, in milliseconds. Valid values: 1000 to 604800000. The value is rounded…"},"FileShowName":{"type":"string","description":"The display name of the file. The value must be 1 to 512 characters in length. The object key is generated by the server and is not…"},"Network":{"type":"string","description":"The network type of the upload address. Valid values: `public` and `internal`. Default value: `public`"}}}}}},"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-ada/delete-agent":{"post":{"operationId":"cloud_aliyun_ada_delete_agent","summary":"Deletes a specified Agent","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name"],"properties":{"endpoint":{"type":"string","enum":["https://ada.cn-beijing.aliyuncs.com","https://ada.cn-hangzhou.aliyuncs.com","https://ada.cn-shanghai.aliyuncs.com"],"default":"https://ada.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://ada.cn-hangzhou.aliyuncs.com"},"Name":{"type":"string","description":"The name of the Agent to delete"}}}}}},"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-ada/delete-skill":{"post":{"operationId":"cloud_aliyun_ada_delete_skill","summary":"Soft-deletes a Skill that the current caller has permission to modify","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name"],"properties":{"endpoint":{"type":"string","enum":["https://ada.cn-beijing.aliyuncs.com","https://ada.cn-hangzhou.aliyuncs.com","https://ada.cn-shanghai.aliyuncs.com"],"default":"https://ada.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://ada.cn-hangzhou.aliyuncs.com"},"Name":{"type":"string","description":"The name of the Skill to delete"}}}}}},"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-ada/get-agent":{"post":{"operationId":"cloud_aliyun_ada_get_agent","summary":"Queries an agent visible to the current identity by name","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name"],"properties":{"endpoint":{"type":"string","enum":["https://ada.cn-beijing.aliyuncs.com","https://ada.cn-hangzhou.aliyuncs.com","https://ada.cn-shanghai.aliyuncs.com"],"default":"https://ada.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://ada.cn-hangzhou.aliyuncs.com"},"Name":{"type":"string","description":"The name of the agent"}}}}}},"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-ada/get-skill":{"post":{"operationId":"cloud_aliyun_ada_get_skill","summary":"Queries a Skill by name that is visible to the current caller","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name"],"properties":{"endpoint":{"type":"string","enum":["https://ada.cn-beijing.aliyuncs.com","https://ada.cn-hangzhou.aliyuncs.com","https://ada.cn-shanghai.aliyuncs.com"],"default":"https://ada.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://ada.cn-hangzhou.aliyuncs.com"},"Name":{"type":"string","description":"The Skill name"},"SkillVersion":{"type":"integer","description":"The release history version number to query. If omitted, the current Skill main record is returned"},"Network":{"type":"string","description":"The network type of the download URL. Valid values: public and internal. If omitted, no download URL is generated"}}}}}},"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-ada/get-transit-meta":{"post":{"operationId":"cloud_aliyun_ada_get_transit_meta","summary":"Queries the metadata of a Transit file, including the upload status, file size, and expiration time, and…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://ada.cn-beijing.aliyuncs.com","https://ada.cn-hangzhou.aliyuncs.com","https://ada.cn-shanghai.aliyuncs.com"],"default":"https://ada.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://ada.cn-hangzhou.aliyuncs.com"},"TransitId":{"type":"string","description":"The Transit ID. Specify at least one of this parameter and `FilePath`. If both are specified, this parameter takes precedence"},"FilePath":{"type":"string","description":"The opaque object path returned by `CreateTransitUploadPolicy`. Specify at least one of this parameter and `TransitId`"},"Network":{"type":"string","description":"The network type for the download URL. Valid values: `public` and `internal`. If this parameter is not specified, no download URL is…"},"ExpireMs":{"type":"integer","description":"The validity period of the temporary download URL, in milliseconds. The value must be an integer greater than or equal to 1000 and is…"}}}}}},"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-ada/list-agents":{"post":{"operationId":"cloud_aliyun_ada_list_agents","summary":"Queries agents visible to the current identity by paging","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://ada.cn-beijing.aliyuncs.com","https://ada.cn-hangzhou.aliyuncs.com","https://ada.cn-shanghai.aliyuncs.com"],"default":"https://ada.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://ada.cn-hangzhou.aliyuncs.com"},"MaxResults":{"type":"integer","description":"The number of entries per page for cursor-based pagination. Valid values: 1 to 100. Default value: 20"},"NextToken":{"type":"string","description":"The next page token returned in the previous response"},"PageNumber":{"type":"integer","description":"The page number for page number-based pagination. Minimum value: 1. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page for page number-based pagination. Valid values: 1 to 100. Default value: 20"},"CreatorId":{"type":"string","description":"Filters agents by the exact creator ID"},"Q":{"type":"string","description":"The search keyword. Matches the name, display name, or description"},"Visibility":{"type":"string","enum":["user","tenant"],"description":"Filters agents by visibility scope. Valid values: `user` and `tenant`"},"Scope":{"type":"string","enum":["SYSTEM","CUSTOM"],"description":"The query scope. Valid values: `SYSTEM` and `CUSTOM`"},"RequiredRuntime":{"type":"string","description":"Filters agents by runtime label"}}}}}},"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-ada/list-skills":{"post":{"operationId":"cloud_aliyun_ada_list_skills","summary":"Queries Skills visible to the current caller by paging","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://ada.cn-beijing.aliyuncs.com","https://ada.cn-hangzhou.aliyuncs.com","https://ada.cn-shanghai.aliyuncs.com"],"default":"https://ada.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://ada.cn-hangzhou.aliyuncs.com"},"MaxResults":{"type":"integer","description":"The number of entries per page for cursor-based pagination. Valid values: 1 to 100. Default value: `20`. If explicitly specified,…"},"NextToken":{"type":"string","description":"The token returned by the server for the next page. Do not pass this parameter for the first query. For subsequent queries, use the value…"},"PageNumber":{"type":"integer","description":"The page number for compatible page-number-based pagination. Pages start from 1. Default value: `1`"},"PageSize":{"type":"integer","description":"The number of entries per page for compatible page-number-based pagination. Valid values: 1 to 100. Default value: `20`"},"CreatorId":{"type":"string","description":"Filters Skills by creator ID"},"Q":{"type":"string","description":"Performs a fuzzy match on the Skill name or description"},"Visibility":{"type":"string","description":"Filters Skills by visibility. Common values are `user` and `tenant`"},"Scope":{"type":"string","description":"The query scope for Skills. Valid values: `SYSTEM` and `CUSTOM`. If omitted, both official and custom Skills are queried"}}}}}},"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-ada/update-agent":{"post":{"operationId":"cloud_aliyun_ada_update_agent","summary":"Updates the configuration of an Agent","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name"],"properties":{"endpoint":{"type":"string","enum":["https://ada.cn-beijing.aliyuncs.com","https://ada.cn-hangzhou.aliyuncs.com","https://ada.cn-shanghai.aliyuncs.com"],"default":"https://ada.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://ada.cn-hangzhou.aliyuncs.com"},"Name":{"type":"string","description":"The name of the Agent to update"},"ExpectedVersion":{"type":"integer","description":"The expected current configuration revision number. This parameter is omitted by default. For concurrency protection, pass in the…"},"DisplayName":{"type":"string","description":"The new display name. If not specified, the existing value is retained"},"Description":{"type":"string","description":"The new description. If not specified, the existing value is retained"},"SystemPrompt":{"type":"string","description":"The new system prompt. If not specified, the existing value is retained"},"Tools":{"type":"string","description":"The list of MCP Server and Connector name references. The same array supports both types of entries. Each entry specifies one type of…"},"Skills":{"type":"string","description":"The list of Skill references. If not specified, the existing value is retained. A non-empty array replaces the entire value. Passing `[ ]`…"},"KnowledgeBases":{"type":"string","description":"The list of knowledge base bindings, which contains at most one element. If not specified, the existing value is retained. A non-empty…"},"Visibility":{"type":"string","enum":["user","tenant"],"description":"The new visibility scope. Valid values: user tenant If not specified, the existing value is retained"}}}}}},"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-ada/update-skill":{"post":{"operationId":"cloud_aliyun_ada_update_skill","summary":"Updates a Skill","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name"],"properties":{"endpoint":{"type":"string","enum":["https://ada.cn-beijing.aliyuncs.com","https://ada.cn-hangzhou.aliyuncs.com","https://ada.cn-shanghai.aliyuncs.com"],"default":"https://ada.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://ada.cn-hangzhou.aliyuncs.com"},"Name":{"type":"string","description":"The name of the Skill to update. This parameter is used only to locate the Skill and cannot be used to modify the name"},"ExpectedVersion":{"type":"integer","description":"The expected version number"},"Description":{"type":"string","description":"The updated description of the Skill"},"Metadata":{"type":"string","description":"The updated Skill metadata. The JSON object is replaced as a whole. The content supports exactly one of Transit ID, bundleUrl, or skillMd"},"Visibility":{"type":"string","description":"The updated visibility. Valid values: `user` and `tenant`"}}}}}},"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-ada/version":{"post":{"operationId":"cloud_aliyun_ada_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://ada.cn-beijing.aliyuncs.com","https://ada.cn-hangzhou.aliyuncs.com","https://ada.cn-shanghai.aliyuncs.com"],"default":"https://ada.cn-hangzhou.aliyuncs.com","description":"Regional endpoint, for example https://ada.cn-hangzhou.aliyuncs.com"}}}}}},"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"}}}}}}}