{"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:azure-translation-document-translation/document-translation-operations-get-translations-status":{"get":{"operationId":"cloud_azure_translation_document_translation_document_translation_operations_get_translations_status","summary":"Returns a list of batch requests submitted and the status for each request","description":"GET /document/batches","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Supported document Translation endpoint, protocol and hostname, for example:…","schema":{"type":"string","description":"Supported document Translation endpoint, protocol and hostname, for example:…"}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-03-01","description":"The API version to use for this operation."}},{"name":"top","in":"query","required":false,"description":"top indicates the total number of records the user wants to be returned across all pages. Clients MAY use top and skip query parameters to…","schema":{"type":"integer","description":"top indicates the total number of records the user wants to be returned across all pages. Clients MAY use top and skip query parameters to…"}},{"name":"skip","in":"query","required":false,"description":"skip indicates the number of records to skip from the list of records held by the server based on the sorting method specified. By…","schema":{"type":"integer","description":"skip indicates the number of records to skip from the list of records held by the server based on the sorting method specified. By…"}},{"name":"maxpagesize","in":"query","required":false,"description":"maxpagesize is the maximum items returned in a page. If more items are requested via top (or top is not specified and there are more items…","schema":{"type":"integer","default":50,"description":"maxpagesize is the maximum items returned in a page. If more items are requested via top (or top is not specified and there are more items…"}},{"name":"ids","in":"query","required":false,"description":"Ids to use in filtering","schema":{"type":"array","description":"Ids to use in filtering"}},{"name":"statuses","in":"query","required":false,"description":"Statuses to use in filtering","schema":{"type":"array","description":"Statuses to use in filtering"}},{"name":"createdDateTimeUtcStart","in":"query","required":false,"description":"the start datetime to get items after","schema":{"type":"string","description":"the start datetime to get items after"}},{"name":"createdDateTimeUtcEnd","in":"query","required":false,"description":"the end datetime to get items before","schema":{"type":"string","description":"the end datetime to get items before"}},{"name":"orderby","in":"query","required":false,"description":"the sorting query for the collection (ex: 'CreatedDateTimeUtc asc','CreatedDateTimeUtc desc')","schema":{"type":"array","description":"the sorting query for the collection (ex: 'CreatedDateTimeUtc asc','CreatedDateTimeUtc desc')"}}],"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:azure-translation-document-translation/document-translation-operations-start-translation":{"post":{"operationId":"cloud_azure_translation_document_translation_document_translation_operations_start_translation","summary":"Submit a document translation request to the Document Translation service","description":"POST /document/batches","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","body"],"properties":{"endpoint":{"type":"string","description":"Supported document Translation endpoint, protocol and hostname, for example:…"},"api-version":{"type":"string","default":"2026-03-01","description":"The API version to use for this operation."},"body":{"type":"object","description":"JSON request body"}}}}}},"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:azure-translation-document-translation/document-translation-operations-get-translation-status":{"get":{"operationId":"cloud_azure_translation_document_translation_document_translation_operations_get_translation_status","summary":"Returns the status for a document translation request","description":"GET /document/batches/{id}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Supported document Translation endpoint, protocol and hostname, for example:…","schema":{"type":"string","description":"Supported document Translation endpoint, protocol and hostname, for example:…"}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-03-01","description":"The API version to use for this operation."}},{"name":"id","in":"query","required":true,"description":"Format - uuid. The operation id","schema":{"type":"string","description":"Format - uuid. The operation 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:azure-translation-document-translation/document-translation-operations-cancel-translation":{"post":{"operationId":"cloud_azure_translation_document_translation_document_translation_operations_cancel_translation","summary":"Cancel a currently processing or queued translation","description":"DELETE /document/batches/{id}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","id"],"properties":{"endpoint":{"type":"string","description":"Supported document Translation endpoint, protocol and hostname, for example:…"},"api-version":{"type":"string","default":"2026-03-01","description":"The API version to use for this operation."},"id":{"type":"string","description":"Format - uuid. The operation-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:azure-translation-document-translation/document-translation-operations-get-documents-status":{"get":{"operationId":"cloud_azure_translation_document_translation_document_translation_operations_get_documents_status","summary":"Returns the status for all documents in a batch document translation request","description":"GET /document/batches/{id}/documents","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Supported document Translation endpoint, protocol and hostname, for example:…","schema":{"type":"string","description":"Supported document Translation endpoint, protocol and hostname, for example:…"}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-03-01","description":"The API version to use for this operation."}},{"name":"id","in":"query","required":true,"description":"Format - uuid. The operation id","schema":{"type":"string","description":"Format - uuid. The operation id"}},{"name":"top","in":"query","required":false,"description":"top indicates the total number of records the user wants to be returned across all pages. Clients MAY use top and skip query parameters to…","schema":{"type":"integer","description":"top indicates the total number of records the user wants to be returned across all pages. Clients MAY use top and skip query parameters to…"}},{"name":"skip","in":"query","required":false,"description":"skip indicates the number of records to skip from the list of records held by the server based on the sorting method specified. By…","schema":{"type":"integer","description":"skip indicates the number of records to skip from the list of records held by the server based on the sorting method specified. By…"}},{"name":"maxpagesize","in":"query","required":false,"description":"maxpagesize is the maximum items returned in a page. If more items are requested via top (or top is not specified and there are more items…","schema":{"type":"integer","default":50,"description":"maxpagesize is the maximum items returned in a page. If more items are requested via top (or top is not specified and there are more items…"}},{"name":"ids","in":"query","required":false,"description":"Ids to use in filtering","schema":{"type":"array","description":"Ids to use in filtering"}},{"name":"statuses","in":"query","required":false,"description":"Statuses to use in filtering","schema":{"type":"array","description":"Statuses to use in filtering"}},{"name":"createdDateTimeUtcStart","in":"query","required":false,"description":"the start datetime to get items after","schema":{"type":"string","description":"the start datetime to get items after"}},{"name":"createdDateTimeUtcEnd","in":"query","required":false,"description":"the end datetime to get items before","schema":{"type":"string","description":"the end datetime to get items before"}},{"name":"orderby","in":"query","required":false,"description":"the sorting query for the collection (ex: 'CreatedDateTimeUtc asc','CreatedDateTimeUtc desc')","schema":{"type":"array","description":"the sorting query for the collection (ex: 'CreatedDateTimeUtc asc','CreatedDateTimeUtc desc')"}}],"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:azure-translation-document-translation/document-translation-operations-get-document-status":{"get":{"operationId":"cloud_azure_translation_document_translation_document_translation_operations_get_document_status","summary":"Returns the status for a specific document","description":"GET /document/batches/{id}/documents/{documentId}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Supported document Translation endpoint, protocol and hostname, for example:…","schema":{"type":"string","description":"Supported document Translation endpoint, protocol and hostname, for example:…"}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-03-01","description":"The API version to use for this operation."}},{"name":"id","in":"query","required":true,"description":"Format - uuid. The batch id","schema":{"type":"string","description":"Format - uuid. The batch id"}},{"name":"documentId","in":"query","required":true,"description":"Format - uuid. The document id","schema":{"type":"string","description":"Format - uuid. The document 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:azure-translation-document-translation/document-translation-operations-get-supported-formats":{"get":{"operationId":"cloud_azure_translation_document_translation_document_translation_operations_get_supported_formats","summary":"Returns a list of supported document formats","description":"GET /document/formats","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":true,"description":"Supported document Translation endpoint, protocol and hostname, for example:…","schema":{"type":"string","description":"Supported document Translation endpoint, protocol and hostname, for example:…"}},{"name":"api-version","in":"query","required":false,"description":"The API version to use for this operation.","schema":{"type":"string","default":"2026-03-01","description":"The API version to use for this operation."}},{"name":"type","in":"query","required":true,"description":"the type of format like document or glossary","schema":{"type":"string","enum":["Document","Glossary"],"description":"the type of format like document or glossary"}}],"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:azure-translation-document-translation/document-translation-operations-document-translate":{"post":{"operationId":"cloud_azure_translation_document_translation_document_translation_operations_document_translate","summary":"Submit a single document translation request to the Document Translation service","description":"POST /document:translate","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["endpoint","targetLanguage"],"properties":{"endpoint":{"type":"string","description":"Supported document Translation endpoint, protocol and hostname, for example:…"},"api-version":{"type":"string","default":"2026-03-01","description":"The API version to use for this operation."},"sourceLanguage":{"type":"string","description":"Specifies source language of the input document. If this parameter isn't specified, automatic language detection is applied to determine…"},"targetLanguage":{"type":"string","description":"Specifies the language of the output document. The target language must be one of the supported languages included in the translation…"},"category":{"type":"string","default":"general","description":"A string specifying the category (domain) of the translation. This parameter is used to get translations from a customized system built…"},"deploymentName":{"type":"string","description":"Deployment name of the custom translation model for the translation request."},"allowFallback":{"type":"boolean","description":"Specifies that the service is allowed to fall back to a general system when a custom system doesn't exist. Possible values are: true…"},"translateTextWithinImage":{"type":"boolean","description":"Optional boolean parameter to translate text within an image in the document"},"x-ms-client-request-id":{"type":"string","description":"An opaque, globally-unique, client-generated string identifier for the request."},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"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"}}}}}}}