{"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-tingwu/create-task":{"post":{"operationId":"cloud_aliyun_tingwu_create_task","summary":"Creates a Tingwu task, including an offline transcription task or a real-time meeting task","description":"PUT /openapi/tingwu/v2/tasks","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["type"],"properties":{"endpoint":{"type":"string","enum":["https://tingwu.cn-beijing.aliyuncs.com"],"default":"https://tingwu.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://tingwu.cn-beijing.aliyuncs.com"},"type":{"type":"string","description":"The task type. Valid values: offline: indicates an offline task, such as offline transcription. realtime: indicates a real-time task, such…"},"operation":{"type":"string","description":"The operation to perform. Valid values: start: creates the task. This is the default value. In most cases, you do not need to explicitly…"},"AppKey":{"type":"string","description":"The AppKey of the project created in the console"},"Input":{"type":"object","description":"The basic information parameters configured when you create a task. Note that the required parameters vary based on the task type. When…"},"Parameters":{"type":"object","description":"The algorithm-related parameters set when creating a task. You can set them as needed"}}}}}},"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-tingwu/create-transcription-phrases":{"post":{"operationId":"cloud_aliyun_tingwu_create_transcription_phrases","summary":"Creates a custom vocabulary of transcription phrases","description":"POST /openapi/tingwu/v2/resources/phrases","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name","WordWeights"],"properties":{"endpoint":{"type":"string","enum":["https://tingwu.cn-beijing.aliyuncs.com"],"default":"https://tingwu.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://tingwu.cn-beijing.aliyuncs.com"},"Description":{"type":"string","description":"The description of the phrases list"},"Name":{"type":"string","description":"The name of the phrases list"},"WordWeights":{"type":"string","description":"A JSON-formatted string that represents a map of words and their corresponding weights"}}}}}},"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-tingwu/delete-transcription-phrases":{"post":{"operationId":"cloud_aliyun_tingwu_delete_transcription_phrases","summary":"Deletes a vocabulary","description":"DELETE /openapi/tingwu/v2/resources/phrases/{PhraseId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PhraseId"],"properties":{"endpoint":{"type":"string","enum":["https://tingwu.cn-beijing.aliyuncs.com"],"default":"https://tingwu.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://tingwu.cn-beijing.aliyuncs.com"},"PhraseId":{"type":"string","description":"The vocabulary 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-tingwu/get-task-info":{"get":{"operationId":"cloud_aliyun_tingwu_get_task_info","summary":"Query the job status and job result.","description":"GET /openapi/tingwu/v2/tasks/{TaskId}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://tingwu.cn-beijing.aliyuncs.com","schema":{"type":"string","enum":["https://tingwu.cn-beijing.aliyuncs.com"],"default":"https://tingwu.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://tingwu.cn-beijing.aliyuncs.com"}},{"name":"TaskId","in":"query","required":true,"description":"The TaskId returned when the job was created","schema":{"type":"string","description":"The TaskId returned when the job was created"}}],"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-tingwu/get-transcription-phrases":{"get":{"operationId":"cloud_aliyun_tingwu_get_transcription_phrases","summary":"Queries information about hotword lists","description":"GET /openapi/tingwu/v2/resources/phrases/{PhraseId}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://tingwu.cn-beijing.aliyuncs.com","schema":{"type":"string","enum":["https://tingwu.cn-beijing.aliyuncs.com"],"default":"https://tingwu.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://tingwu.cn-beijing.aliyuncs.com"}},{"name":"PhraseId","in":"query","required":true,"description":"Hotword list ID","schema":{"type":"string","description":"Hotword list 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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-tingwu/list-transcription-phrases":{"get":{"operationId":"cloud_aliyun_tingwu_list_transcription_phrases","summary":"Lists all of a user's hot phrase lists","description":"GET /openapi/tingwu/v2/resources/phrases","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://tingwu.cn-beijing.aliyuncs.com","schema":{"type":"string","enum":["https://tingwu.cn-beijing.aliyuncs.com"],"default":"https://tingwu.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://tingwu.cn-beijing.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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-tingwu/update-transcription-phrases":{"post":{"operationId":"cloud_aliyun_tingwu_update_transcription_phrases","summary":"Update a hotword list","description":"PUT /openapi/tingwu/v2/resources/phrases/{PhraseId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PhraseId","Name","WordWeights"],"properties":{"endpoint":{"type":"string","enum":["https://tingwu.cn-beijing.aliyuncs.com"],"default":"https://tingwu.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://tingwu.cn-beijing.aliyuncs.com"},"PhraseId":{"type":"string","description":"The ID of the hotword list"},"Description":{"type":"string","description":"A description of the hotword list"},"Name":{"type":"string","description":"The name of the hotword list"},"WordWeights":{"type":"string","description":"A JSON map string that defines hotwords and their weights"}}}}}},"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-tingwu/version":{"post":{"operationId":"cloud_aliyun_tingwu_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://tingwu.cn-beijing.aliyuncs.com"],"default":"https://tingwu.cn-beijing.aliyuncs.com","description":"Regional endpoint, for example https://tingwu.cn-beijing.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"}}}}}}}