{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-realtranslationagent/cancel-translation-task":{"post":{"operationId":"cloud_aliyun_realtranslationagent_cancel_translation_task","summary":"Cancels a translation task that is currently running","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://realtranslationagent.aliyuncs.com"],"default":"https://realtranslationagent.aliyuncs.com","description":"Regional endpoint, for example https://realtranslationagent.aliyuncs.com"},"TaskId":{"type":"string","description":"The task ID. The TaskId is returned after a task is submitted by calling SubmitTranslationTask. Only running tasks can be canceled"},"APIKey":{"type":"string","description":"The API key, the identity of member accounts. You can obtain it from the RuiYiBao console"}}}}}},"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-realtranslationagent/get-original-file-url":{"post":{"operationId":"cloud_aliyun_realtranslationagent_get_original_file_url","summary":"Retrieves the download URL of the original file for a translation task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://realtranslationagent.aliyuncs.com"],"default":"https://realtranslationagent.aliyuncs.com","description":"Regional endpoint, for example https://realtranslationagent.aliyuncs.com"},"TaskId":{"type":"string","description":"The task ID. The TaskId is returned after a task is submitted by calling SubmitTranslationTask"},"APIKey":{"type":"string","description":"The API key that identifies a member account. You can obtain it from the Ruiyi Bao console"}}}}}},"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-realtranslationagent/get-translated-file-url":{"post":{"operationId":"cloud_aliyun_realtranslationagent_get_translated_file_url","summary":"Retrieves the download URL of the translated file for a translation task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://realtranslationagent.aliyuncs.com"],"default":"https://realtranslationagent.aliyuncs.com","description":"Regional endpoint, for example https://realtranslationagent.aliyuncs.com"},"TaskId":{"type":"string","description":"The task ID. The TaskId is returned after a task is submitted by calling SubmitTranslationTask"},"APIKey":{"type":"string","description":"The API key that identifies a member accounts identity. You can obtain the key from the RuiYiBao console"}}}}}},"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-realtranslationagent/get-translation-task":{"post":{"operationId":"cloud_aliyun_realtranslationagent_get_translation_task","summary":"Retrieves the details of a translation task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskId"],"properties":{"endpoint":{"type":"string","enum":["https://realtranslationagent.aliyuncs.com"],"default":"https://realtranslationagent.aliyuncs.com","description":"Regional endpoint, for example https://realtranslationagent.aliyuncs.com"},"TaskId":{"type":"string","description":"The translation task ID, which is the TaskId obtained from UploadTranslationFile"},"APIKey":{"type":"string","description":"The API key that identifies a member accounts identity. You can obtain it from the RuiYiBao console"}}}}}},"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-realtranslationagent/list-translation-tasks":{"post":{"operationId":"cloud_aliyun_realtranslationagent_list_translation_tasks","summary":"Queries translation tasks by paging","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://realtranslationagent.aliyuncs.com"],"default":"https://realtranslationagent.aliyuncs.com","description":"Regional endpoint, for example https://realtranslationagent.aliyuncs.com"},"MaxResults":{"type":"integer","description":"The maximum number of results to return per request when using the NextToken-based pagination. Valid values: 1 to 100. Default value: 10"},"NextToken":{"type":"string","description":"The pagination token"},"TaskId":{"type":"string","description":"The translation task ID, which is the TaskId obtained from UploadTranslationFile"},"OriginalFileName":{"type":"string","description":"The name of the source file"},"SourceLanguage":{"type":"string","description":"The language of the source file"},"TargetLanguage":{"type":"string","description":"The target language"},"Status":{"type":"string","description":"The task status. Valid values: CANCELLED: Cancelled. COMPLETED: Completed. FAILED: Failed. PROCESSING: Processing. PENDING: Pending.…"},"StartTime":{"type":"string","description":"The start time of the task. Format: YYYY-MM-dd HH:mm:ss"},"EndTime":{"type":"string","description":"The end time of the task. Format: YYYY-MM-dd HH:mm:ss"},"APIKey":{"type":"string","description":"The API key that identifies the identity of member accounts. You can obtain it from the RuiYiBao console"}}}}}},"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-realtranslationagent/submit-translation-task":{"post":{"operationId":"cloud_aliyun_realtranslationagent_submit_translation_task","summary":"Submits a translation task. You can submit a new translation task by passing in a TaskId, or resubmit a…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Config"],"properties":{"endpoint":{"type":"string","enum":["https://realtranslationagent.aliyuncs.com"],"default":"https://realtranslationagent.aliyuncs.com","description":"Regional endpoint, for example https://realtranslationagent.aliyuncs.com"},"TaskId":{"type":"string","description":"The translation task ID. Obtained from the TaskId returned by UploadTranslationFile. You must pass in either this parameter or BaseTaskId"},"BaseTaskId":{"type":"string","description":"The translation task ID of a previously submitted translation task. Pass in this parameter when resubmitting a translation task. You must…"},"Config":{"type":"string","description":"The translation configuration (JSON-encoded)"},"APIKey":{"type":"string","description":"The API key that identifies the identity of the member account. You can obtain this from the RuiYiBao console"},"CustomTerms":{"type":"string","description":"The custom terms. Custom terms are for reference only. Actual translation results may differ. Refer to the final output for the definitive…"}}}}}},"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-realtranslationagent/upload-translation-file":{"post":{"operationId":"cloud_aliyun_realtranslationagent_upload_translation_file","summary":"Uploads a document, parses document-related information, and generates a translation task. After a…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["File","FileName"],"properties":{"endpoint":{"type":"string","enum":["https://realtranslationagent.aliyuncs.com"],"default":"https://realtranslationagent.aliyuncs.com","description":"Regional endpoint, for example https://realtranslationagent.aliyuncs.com"},"APIKey":{"type":"string","description":"The API key that identifies the identity of the member accounts. You can obtain it from the RuiYiBao console"},"File":{"type":"string","description":"The file. The SDK supports direct upload and temporary authorized upload. Direct upload: Use UploadTranslationFileAdvance in the SDK for…"},"FileName":{"type":"string","description":"The name of the uploaded file. Make sure the correct file name (including the extension) is provided. Otherwise, file parsing will fail."}}}}}},"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-realtranslationagent/version":{"post":{"operationId":"cloud_aliyun_realtranslationagent_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://realtranslationagent.aliyuncs.com"],"default":"https://realtranslationagent.aliyuncs.com","description":"Regional endpoint, for example https://realtranslationagent.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"}}}}}}}