{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-contactcenterai/analyze-audio-sync":{"post":{"operationId":"cloud_aliyun_contactcenterai_analyze_audio_sync","summary":"Analyzes conversations in audio files in real time. Applications send HTTPS requests to retrieve responses","description":"POST /{workspaceId}/ccai/app/{appId}/analyzeAudioSync","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","appId","stream"],"properties":{"endpoint":{"type":"string","enum":["https://contactcenterai.cn-shanghai.aliyuncs.com"],"default":"https://contactcenterai.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://contactcenterai.cn-shanghai.aliyuncs.com"},"workspaceId":{"type":"string","description":"The workspace ID"},"appId":{"type":"string","description":"The application ID"},"categoryTags":{"type":"array","description":"The list of tag categorizations"},"customPrompt":{"type":"string","description":"The custom instruction"},"fields":{"type":"array","description":"The structure of the fields"},"modelCode":{"type":"string","description":"The model code"},"responseFormatType":{"type":"string","description":"The format of the output. Valid values: jsonObject (JSON structure) and text (raw string)"},"resultTypes":{"type":"array","description":"The task types"},"serviceInspection":{"type":"object","description":"The structure for service quality inspection"},"stream":{"type":"string","description":"Specifies whether to return the result in a stream. Set to true for streaming output, or false for a complete response"},"templateIds":{"type":"array","description":"The template IDs"},"transcription":{"type":"object","description":"The runtime parameters for audio"},"variables":{"type":"array","description":"The list of variables"}}}}}},"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-contactcenterai/analyze-conversation":{"post":{"operationId":"cloud_aliyun_contactcenterai_analyze_conversation","summary":"Retrieves conversation analysis results including conversation summary, title generation, keywords, field…","description":"POST /{workspaceId}/ccai/app/{appId}/analyze_conversation","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","appId","resultTypes","stream"],"properties":{"endpoint":{"type":"string","enum":["https://contactcenterai.cn-shanghai.aliyuncs.com"],"default":"https://contactcenterai.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://contactcenterai.cn-shanghai.aliyuncs.com"},"workspaceId":{"type":"string","description":"The workspace ID"},"appId":{"type":"string","description":"The application ID"},"categoryTags":{"type":"array","description":"The tag categorization list"},"customPrompt":{"type":"string","description":"The custom instruction. The instruction must contain ${dialogue}"},"dialogue":{"type":"object","description":"The list of dialogue content"},"examples":{"type":"array","description":"The list of instruction examples"},"fields":{"type":"array","description":"The list of fields to extract during information extraction"},"modelCode":{"type":"string","description":"The model code"},"responseFormatType":{"type":"string","description":"The output result format type. Valid values: jsonObject (JSON structure) and text (raw string)"},"resultTypes":{"type":"array","description":"The instruction task types"},"sceneName":{"type":"string","description":"The scenario name"},"serviceInspection":{"type":"object","description":"The service quality inspection structure information"},"sourceCallerUid":{"type":"string","description":"Not required"},"stream":{"type":"string","description":"Required. Specifies whether to use streaming output. Valid values: true (returns the answer in streaming mode) and false (returns the…"},"timeConstraintList":{"type":"array","description":"The time constraints that specify the time ranges the model should focus on or be limited to during analysis"},"userProfiles":{"type":"array","description":"The list of user profiles"}}}}}},"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-contactcenterai/analyze-image":{"post":{"operationId":"cloud_aliyun_contactcenterai_analyze_image","summary":"Use the Tongyi Xiaomi CCAI Conversation Analysis AIO application to analyze image content, including…","description":"POST /{workspaceId}/ccai/app/{appId}/analyzeImage","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","appId","stream"],"properties":{"endpoint":{"type":"string","enum":["https://contactcenterai.cn-shanghai.aliyuncs.com"],"default":"https://contactcenterai.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://contactcenterai.cn-shanghai.aliyuncs.com"},"workspaceId":{"type":"string","description":"Workspace ID"},"appId":{"type":"string","description":"Application ID"},"imageUrls":{"type":"array","description":"List of image URLs"},"responseFormatType":{"type":"string","description":"The responseFormatType"},"resultTypes":{"type":"array","description":"List of task types"},"stream":{"type":"string","description":"Required. Set to true to return results in streaming mode. Set to false to return the full result at once"}}}}}},"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-contactcenterai/create-task":{"post":{"operationId":"cloud_aliyun_contactcenterai_create_task","summary":"You can perform conversation analysis by creating an offline asynchronous job. The application supports HTTP…","description":"POST /{workspaceId}/ccai/app/{appId}/createTask","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","appId","modelCode","taskType"],"properties":{"endpoint":{"type":"string","enum":["https://contactcenterai.cn-shanghai.aliyuncs.com"],"default":"https://contactcenterai.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://contactcenterai.cn-shanghai.aliyuncs.com"},"workspaceId":{"type":"string","description":"Workspace ID"},"appId":{"type":"string","description":"Application ID"},"callBackUrl":{"type":"string","description":"Callback parameter after the job is completed"},"categoryTags":{"type":"array","description":"Tag categorization list"},"customPrompt":{"type":"string","description":"Custom instruction"},"dialogue":{"type":"object","description":"List of Conversation Content"},"examples":{"type":"object","description":"Instruction Sample"},"fields":{"type":"array","description":"Field structure information"},"modelCode":{"type":"string","description":"Model code"},"responseFormatType":{"type":"string","description":"Output result format type: jsonObject for JSON structure, text for raw string"},"resultTypes":{"type":"array","description":"LLM processing types"},"serviceInspection":{"type":"object","description":"Service quality inspection structure information"},"taskType":{"type":"string","description":"Task Type: audio - audio file, text - text"},"templateIds":{"type":"array","description":"List of template IDs"},"transcription":{"type":"object","description":"Runtime parameters for Audio jobs"},"variables":{"type":"array","description":"List of variables"}}}}}},"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-contactcenterai/create-vocab":{"post":{"operationId":"cloud_aliyun_contactcenterai_create_vocab","summary":"Uploads a set of hotwords to the server and returns a vocabulary ID","description":"POST /vocab/createVocab","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["name","wordWeightList","workspaceId"],"properties":{"endpoint":{"type":"string","enum":["https://contactcenterai.cn-shanghai.aliyuncs.com"],"default":"https://contactcenterai.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://contactcenterai.cn-shanghai.aliyuncs.com"},"audioModelCode":{"type":"string","description":"The speech-to-text model"},"description":{"type":"string","description":"The version description"},"name":{"type":"string","description":"The name"},"wordWeightList":{"type":"array","description":"The hotword group"},"workspaceId":{"type":"string","description":"The workspace ID"}}}}}},"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-contactcenterai/delete-vocab":{"post":{"operationId":"cloud_aliyun_contactcenterai_delete_vocab","summary":"Delete a vocabulary by its ID","description":"POST /vocab/deleteVocab","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["vocabularyId","workspaceId"],"properties":{"endpoint":{"type":"string","enum":["https://contactcenterai.cn-shanghai.aliyuncs.com"],"default":"https://contactcenterai.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://contactcenterai.cn-shanghai.aliyuncs.com"},"vocabularyId":{"type":"string","description":"Vocabulary ID"},"workspaceId":{"type":"string","description":"Workspace ID"}}}}}},"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-contactcenterai/general-analyze-image":{"post":{"operationId":"cloud_aliyun_contactcenterai_general_analyze_image","summary":"Performs general image analysis","description":"POST /{workspaceId}/ccai/app/{appId}/generalanalyzeImage","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","appId","imageUrls"],"properties":{"endpoint":{"type":"string","enum":["https://contactcenterai.cn-shanghai.aliyuncs.com"],"default":"https://contactcenterai.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://contactcenterai.cn-shanghai.aliyuncs.com"},"workspaceId":{"type":"string","description":"Workspace ID"},"appId":{"type":"string","description":"Application ID"},"customPrompt":{"type":"string","description":"Custom instruction"},"imageUrls":{"type":"array","description":"List of image URLs"},"stream":{"type":"string","description":"Required. Set to true for streaming output or false for full output"},"templateIds":{"type":"array","description":"Template ID. If both template ID and customPrompt are provided, the template ID takes precedence"}}}}}},"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-contactcenterai/get-task-result":{"get":{"operationId":"cloud_aliyun_contactcenterai_get_task_result","summary":"Retrieves the conversation analysis results of an offline task by task ID. The application supports HTTPS…","description":"GET /ccai/app/getTaskResult","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://contactcenterai.cn-shanghai.aliyuncs.com","schema":{"type":"string","enum":["https://contactcenterai.cn-shanghai.aliyuncs.com"],"default":"https://contactcenterai.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://contactcenterai.cn-shanghai.aliyuncs.com"}},{"name":"taskId","in":"query","required":false,"description":"The task ID","schema":{"type":"string","description":"The task ID"},"example":"20240905-********-93E9-5D45-B4EF-045743A34071\n"},{"name":"requiredFieldList","in":"query","required":false,"description":"The list of optional fields (JSON-encoded)","schema":{"type":"string","description":"The list of optional fields (JSON-encoded)"}}],"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-contactcenterai/get-vocab":{"post":{"operationId":"cloud_aliyun_contactcenterai_get_vocab","summary":"Retrieves vocabulary information by its ID","description":"POST /vocab/getVocab","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["vocabularyId","workspaceId"],"properties":{"endpoint":{"type":"string","enum":["https://contactcenterai.cn-shanghai.aliyuncs.com"],"default":"https://contactcenterai.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://contactcenterai.cn-shanghai.aliyuncs.com"},"vocabularyId":{"type":"string","description":"The vocabulary ID"},"workspaceId":{"type":"string","description":"The workspace ID"}}}}}},"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-contactcenterai/list-vocab":{"post":{"operationId":"cloud_aliyun_contactcenterai_list_vocab","summary":"List hot words in a specified workspace","description":"POST /vocab/listVocab","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId"],"properties":{"endpoint":{"type":"string","enum":["https://contactcenterai.cn-shanghai.aliyuncs.com"],"default":"https://contactcenterai.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://contactcenterai.cn-shanghai.aliyuncs.com"},"workspaceId":{"type":"string","description":"Workspace ID"}}}}}},"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-contactcenterai/run-completion":{"post":{"operationId":"cloud_aliyun_contactcenterai_run_completion","summary":"Calls the Tongyi Xiaomi CCAI-Dialog Analysis AIO application to retrieve dialog summaries, extract key…","description":"POST /{workspaceId}/ccai/app/{appId}/completion","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","appId","Dialogue","TemplateIds"],"properties":{"endpoint":{"type":"string","enum":["https://contactcenterai.cn-shanghai.aliyuncs.com"],"default":"https://contactcenterai.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://contactcenterai.cn-shanghai.aliyuncs.com"},"workspaceId":{"type":"string","description":"The ID of the sub-workspace"},"appId":{"type":"string","description":"The ID of the application"},"Dialogue":{"type":"object","description":"The structure of the dialog"},"Fields":{"type":"array","description":"The list of fields to extract during information extraction"},"ModelCode":{"type":"string","description":"The model specification"},"ServiceInspection":{"type":"object","description":"The structure of the service quality inspection"},"Stream":{"type":"string","description":"Specifies whether to enable Server-Sent Events (SSE) responses. Default value: false"},"TemplateIds":{"type":"array","description":"The list of template IDs under the CCAI application"},"responseFormatType":{"type":"string","description":"The format type of the output result. Valid values: jsonObject: JSON structure. text: Raw string"},"variables":{"type":"array","description":"The list of variables"}}}}}},"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-contactcenterai/run-completion-message":{"post":{"operationId":"cloud_aliyun_contactcenterai_run_completion_message","summary":"Calls the Tongyi Xiaomi CCAI-Dialog Analysis AIO application in the Message protocol format to retrieve…","description":"POST /{workspaceId}/ccai/app/{appId}/completion_message","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspaceId","appId","Messages"],"properties":{"endpoint":{"type":"string","enum":["https://contactcenterai.cn-shanghai.aliyuncs.com"],"default":"https://contactcenterai.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://contactcenterai.cn-shanghai.aliyuncs.com"},"workspaceId":{"type":"string","description":"The ID of the sub-workspace"},"appId":{"type":"string","description":"The ID of the application"},"Messages":{"type":"array","description":"The list of messages in the model request"},"ModelCode":{"type":"string","description":"The model specification"},"Stream":{"type":"string","description":"Specifies whether to enable Server-Sent Events (SSE) responses. Valid values: true: Enables SSE responses. false: Disables SSE responses.…"},"responseFormatType":{"type":"string","description":"The responseFormatType"}}}}}},"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-contactcenterai/update-vocab":{"post":{"operationId":"cloud_aliyun_contactcenterai_update_vocab","summary":"Updates a vocabulary's information based on its ID, including its name, description, words, and weights","description":"POST /vocab/updateVocab","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["vocabularyId","workspaceId"],"properties":{"endpoint":{"type":"string","enum":["https://contactcenterai.cn-shanghai.aliyuncs.com"],"default":"https://contactcenterai.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://contactcenterai.cn-shanghai.aliyuncs.com"},"description":{"type":"string","description":"Description"},"name":{"type":"string","description":"The name of the vocabulary"},"vocabularyId":{"type":"string","description":"The vocabulary ID"},"wordWeightList":{"type":"array","description":"The words and their weights in the vocabulary"},"workspaceId":{"type":"string","description":"The workspace ID"}}}}}},"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-contactcenterai/version":{"post":{"operationId":"cloud_aliyun_contactcenterai_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://contactcenterai.cn-shanghai.aliyuncs.com"],"default":"https://contactcenterai.cn-shanghai.aliyuncs.com","description":"Regional endpoint, for example https://contactcenterai.cn-shanghai.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"}}}}}}}