# Azure.AI.DocumentTranslation API

> Azure.AI.DocumentTranslation API on Apizie: 8 endpoints (Returns a list of batch requests submitted and the status for each request, Submit a document translation request to the Document Translation service, Returns the status for a document translation request, Cancel a currently processing or queued translation, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:azure-translation-document-translation/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:azure-translation-document-translation`
- Category: Cloud
- Status: byok
- Source: https://learn.microsoft.com/rest/api/azure/
- Page: https://zieapi.vercel.app/api/cloud/azure-translation-document-translation
- OpenAPI: https://zieapi.vercel.app/api/cloud/azure-translation-document-translation/openapi.json

Document translation service

## Endpoints

### Returns a list of batch requests submitted and the status for each request
`GET https://zieapi.vercel.app/v1/cloud:azure-translation-document-translation/document-translation-operations-get-translations-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported document Translation endpoint, protocol and hostname, for example:… |
| api-version | string | no | The API version to use for this operation. |
| top | integer | no | 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… |
| skip | integer | no | skip indicates the number of records to skip from the list of records held by the server based on the sorting method specified. By… |
| maxpagesize | integer | no | 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… |
| ids | array | no | Ids to use in filtering |
| statuses | array | no | Statuses to use in filtering |
| createdDateTimeUtcStart | string | no | the start datetime to get items after |
| createdDateTimeUtcEnd | string | no | the end datetime to get items before |
| orderby | array | no | the sorting query for the collection (ex: 'CreatedDateTimeUtc asc','CreatedDateTimeUtc desc') |

### Submit a document translation request to the Document Translation service
`POST https://zieapi.vercel.app/v1/cloud:azure-translation-document-translation/document-translation-operations-start-translation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported document Translation endpoint, protocol and hostname, for example:… |
| api-version | string | no | The API version to use for this operation. |
| body | object | yes | JSON request body |

### Returns the status for a document translation request
`GET https://zieapi.vercel.app/v1/cloud:azure-translation-document-translation/document-translation-operations-get-translation-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported document Translation endpoint, protocol and hostname, for example:… |
| api-version | string | no | The API version to use for this operation. |
| id | string | yes | Format - uuid. The operation id |

### Cancel a currently processing or queued translation
`POST https://zieapi.vercel.app/v1/cloud:azure-translation-document-translation/document-translation-operations-cancel-translation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported document Translation endpoint, protocol and hostname, for example:… |
| api-version | string | no | The API version to use for this operation. |
| id | string | yes | Format - uuid. The operation-id |

### Returns the status for all documents in a batch document translation request
`GET https://zieapi.vercel.app/v1/cloud:azure-translation-document-translation/document-translation-operations-get-documents-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported document Translation endpoint, protocol and hostname, for example:… |
| api-version | string | no | The API version to use for this operation. |
| id | string | yes | Format - uuid. The operation id |
| top | integer | no | 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… |
| skip | integer | no | skip indicates the number of records to skip from the list of records held by the server based on the sorting method specified. By… |
| maxpagesize | integer | no | 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… |
| ids | array | no | Ids to use in filtering |
| statuses | array | no | Statuses to use in filtering |
| createdDateTimeUtcStart | string | no | the start datetime to get items after |
| createdDateTimeUtcEnd | string | no | the end datetime to get items before |
| orderby | array | no | the sorting query for the collection (ex: 'CreatedDateTimeUtc asc','CreatedDateTimeUtc desc') |

### Returns the status for a specific document
`GET https://zieapi.vercel.app/v1/cloud:azure-translation-document-translation/document-translation-operations-get-document-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported document Translation endpoint, protocol and hostname, for example:… |
| api-version | string | no | The API version to use for this operation. |
| id | string | yes | Format - uuid. The batch id |
| documentId | string | yes | Format - uuid. The document id |

### Returns a list of supported document formats
`GET https://zieapi.vercel.app/v1/cloud:azure-translation-document-translation/document-translation-operations-get-supported-formats` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported document Translation endpoint, protocol and hostname, for example:… |
| api-version | string | no | The API version to use for this operation. |
| type | string | yes | the type of format like document or glossary |

### Submit a single document translation request to the Document Translation service
`POST https://zieapi.vercel.app/v1/cloud:azure-translation-document-translation/document-translation-operations-document-translate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Supported document Translation endpoint, protocol and hostname, for example:… |
| api-version | string | no | The API version to use for this operation. |
| sourceLanguage | string | no | Specifies source language of the input document. If this parameter isn't specified, automatic language detection is applied to determine… |
| targetLanguage | string | yes | Specifies the language of the output document. The target language must be one of the supported languages included in the translation… |
| category | string | no | A string specifying the category (domain) of the translation. This parameter is used to get translations from a customized system built… |
| deploymentName | string | no | Deployment name of the custom translation model for the translation request. |
| allowFallback | boolean | no | 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 | boolean | no | Optional boolean parameter to translate text within an image in the document |
| x-ms-client-request-id | string | no | An opaque, globally-unique, client-generated string identifier for the request. |
| body | object | no | Form fields as a JSON object |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:azure-translation-document-translation/document-translation-operations-get-translations-status" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Azure.AI.DocumentTranslation API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/cloud:azure-translation-document-translation/document-translation-operations-get-translations-status with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Azure.AI.DocumentTranslation API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Azure.AI.DocumentTranslation itself also needs your own key from azure.com.

### Can AI agents use the Azure.AI.DocumentTranslation API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:azure-translation-document-translation.

### What is the status of the Azure.AI.DocumentTranslation API?
Needs your own provider key (bring your own key)