Microsoft Azure Document Translation API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Document Translation API
schemes:
- https
tags:
- name: Document Translation
paths:
  /batches:
    post:
      tags:
      - Document Translation
      summary: Microsoft Azure Submit A Document Translation Request To The Document Translation Service
      description: Use this API to submit a bulk (batch) translation request to the Document Translation service.<br>Each request can contain multiple documents and must contain a source and destination container for each document.<br>            <br>The prefix and suffix filter (if supplied) are used to filter folders. The prefix is applied to the subpath after the container name.<br>            <br>Glossaries / Translation memory can be included in the request and are applied by the service when the document is translated.<br>            <br>If the glossary is invalid or unreachable during translation, an error is indicated in the document status.<br>If a file with the same name already exists at the destination, it will be overwritten. The targetUrl for each target language must be unique.
      operationId: microsoftAzureDocumenttranslationStarttranslation
      consumes:
      - application/json
      - text/json
      - application/*+json
      produces:
      - application/json
      parameters:
      - required: true
        in: body
        name: body
        description: request details
        schema:
          $ref: '#/definitions/StartTranslationDetails'
      responses:
        '202':
          description: Successful request and the batch request is created by the service.  The header Operation-Location will indicate a status url with the operation id.
          headers:
            Operation-Location:
              description: Location of batch the operation
              type: string
              format: ''
        default:
          description: Internal Server Error
          schema:
            $ref: '#/definitions/TranslationErrorResponse'
          examples:
            application/json: "{\r\n  \"error\": {\r\n    \"code\": \"InternalServerError\",\r\n    \"message\": \"Internal Server Error\",\r\n    \"target\": \"batch\",\r\n    \"innerError\": {\r\n      \"code\": \"InternalServerError\",\r\n      \"message\": \"Unexpected internal server error has occurred\"\r\n    }\r\n  }\r\n}"
          x-ms-error-response: true
      x-ms-examples:
        Batch Submit:
          $ref: ./examples/batch.json
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: location
    get:
      tags:
      - Document Translation
      summary: Microsoft Azure Returns A List Of Batch Requests Submitted And The Status For Each Request
      description: 'Returns a list of batch requests submitted and the status for each request.<br>This list only contains batch requests submitted by the user (based on the resource).<br>            <br>If the number of requests exceeds our paging limit, server-side paging is used. Paginated responses indicate a partial result and include a continuation token in the response.<br>The absence of a continuation token means that no additional pages are available.<br>            <br>$top, $skip and $maxpagesize query parameters can be used to specify a number of results to return and an offset for the collection.<br>            <br>$top indicates the total number of records the user wants to be returned across all pages.<br>$skip indicates the number of records to skip from the list of batches based on the sorting method specified.  By default, we sort by descending start time.<br>$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 to be returned), @nextLink will contain the link to the next page.<br>            <br>$orderBy query parameter can be used to sort the returned list (ex "$orderBy=createdDateTimeUtc asc" or "$orderBy=createdDateTimeUtc desc").<br>The default sorting is descending by createdDateTimeUtc.<br>Some query parameters can be used to filter the returned list (ex: "status=Succeeded,Cancelled") will only return succeeded and cancelled operations.<br>createdDateTimeUtcStart and createdDateTimeUtcEnd can be used combined or separately to specify a range of datetime to filter the returned list by.<br>The supported filtering query parameters are (status, ids, createdDateTimeUtcStart, createdDateTimeUtcEnd).<br>            <br>The server honors the values specified by the client. However, clients must be prepared to handle responses that contain a different page size or contain a continuation token.<br>            <br>When both $top and $skip are included, the server should first apply $skip and then $top on the collection.<br>Note: If the server can''t honor $top and/or $skip, the server must return an error to the client informing about it instead of just ignoring the query options.<br>This reduces the risk of the client making assumptions about the data returned.'
      operationId: microsoftAzureDocumenttranslationGettranslationsstatus
      produces:
      - application/json
      parameters:
      - in: query
        name: $top
        description: "$top indicates the total number of records the user wants to be returned across all pages.\r\n            \r\nClients MAY use $top and $skip query parameters to specify a number of results to return and an offset into the collection.\r\nWhen both $top and $skip are given by a client, the server SHOULD first apply $skip and then $top on the collection.\r\n            \r\nNote: If the server can't honor $top and/or $skip, the server MUST return an error to the client informing about it instead of just ignoring the query options."
        type: integer
        format: int32
        maximum: 2147483647
        minimum: 0
      - in: query
        name: $skip
        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 default, we sort by descending start time.\r\n            \r\nClients MAY use $top and $skip query parameters to specify a number of results to return and an offset into the collection.\r\nWhen both $top and $skip are given by a client, the server SHOULD first apply $skip and then $top on the collection.\r\n            \r\nNote: If the server can't honor $top and/or $skip, the server MUST return an error to the client informing about it instead of just ignoring the query options."
        type: integer
        format: int32
        default: 0
        maximum: 2147483647
        minimum: 0
      - in: query
        name: $maxpagesize
        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 to be returned), @nextLink will contain the link to the next page.\r\n            \r\nClients MAY request server-driven paging with a specific page size by specifying a $maxpagesize preference. The server SHOULD honor this preference if the specified page size is smaller than the server's default page size."
        type: integer
        format: int32
        default: 50
        maximum: 100
        minimum: 1
      - in: query
        name: ids
        description: Ids to use in filtering
        type: array
        items:
          format: uuid
          type: string
        maxLength: 25
        collectionFormat: csv
      - in: query
        name: statuses
        description: Statuses to use in filtering
        type: array
        items:
          type: string
        maxLength: 5
        collectionFormat: csv
      - in: query
        name: createdDateTimeUtcStart
        description: the start datetime to get items after
        type: string
        format: date-time
      - in: query
        name: createdDateTimeUtcEnd
        description: the end datetime to get items before
        type: string
        format: date-time
      - in: query
        name: $orderBy
        description: 'the sorting query for the collection (ex: ''CreatedDateTimeUtc asc'', ''CreatedDateTimeUtc desc'')'
        type: array
        items:
          type: string
        maxLength: 1
        collectionFormat: csv
      responses:
        '200':
          description: Successful request and returns the status of the all the operations
          schema:
            $ref: '#/definitions/TranslationsStatus'
          headers:
            Retry-After:
              description: Indicates how long to wait before making a new request.
              type: integer
              format: int32
            ETag:
              description: The ETag response-header field provides the current value of the entity tag for the requested variant. Used with If-Match, If-None-Match and If-Range to implement optimistic concurrency control.
              type: string
              format: ''
        '400':
          description: Invalid request.  Check input parameters
          schema:
            $ref: '#/definitions/TranslationErrorResponse'
          examples:
            application/json: "{\r\n  \"error\": {\r\n    \"code\": \"InvalidRequest\",\r\n    \"message\": \"Some argument is incorrect\",\r\n    \"target\": \"batch\",\r\n    \"innerError\": {\r\n      \"code\": \"SASTokenInvalid\",\r\n      \"message\": \"SAS token for storage is invalid\"\r\n    }\r\n  }\r\n}"
          x-ms-error-response: true
        '401':
          description: Unauthorized.  Please check your credentials
          schema:
            $ref: '#/definitions/TranslationErrorResponse'
          examples:
            application/json: "{\r\n  \"error\": {\r\n    \"code\": \"Unauthorized\",\r\n    \"message\": \"User is not authorized\",\r\n    \"target\": \"batch\",\r\n    \"innerError\": {\r\n      \"code\": \"Unauthorized\",\r\n      \"message\": \"Operation is not authorized\"\r\n    }\r\n  }\r\n}"
          x-ms-error-response: true
        '429':
          description: Too many requests
          schema:
            $ref: '#/definitions/TranslationErrorResponse'
          examples:
            application/json: "{\r\n  \"error\": {\r\n    \"code\": \"RequestRateTooHigh\",\r\n    \"message\": \"User's request rate is too high\",\r\n    \"target\": \"batch\",\r\n    \"innerError\": {\r\n      \"code\": \"RateTooHigh\",\r\n      \"message\": \"Request rate is too high\"\r\n    }\r\n  }\r\n}"
          x-ms-error-response: true
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/TranslationErrorResponse'
          examples:
            application/json: "{\r\n  \"error\": {\r\n    \"code\": \"InternalServerError\",\r\n    \"message\": \"Internal Server Error\",\r\n    \"target\": \"batch\",\r\n    \"innerError\": {\r\n      \"code\": \"InternalServerError\",\r\n      \"message\": \"Unexpected internal server error has occurred\"\r\n    }\r\n  }\r\n}"
          x-ms-error-response: true
        '503':
          description: Server temporary unavailable
          schema:
            $ref: '#/definitions/TranslationErrorResponse'
          examples:
            application/json: "{\r\n  \"error\": {\r\n    \"code\": \"ServiceUnavailable\",\r\n    \"message\": \"Service is temporary unavailable\",\r\n    \"target\": \"batch\",\r\n    \"innerError\": {\r\n      \"code\": \"ServiceTemporaryUnavailable\",\r\n      \"message\": \"Service is currently unavailable.  Please try again later\"\r\n    }\r\n  }\r\n}"
          x-ms-error-response: true
      x-ms-examples:
        Get status for batch operations:
          $ref: ./examples/operations.json
      x-ms-pageable:
        nextLinkName: '@nextLink'
  /batches/{id}/documents/{documentId}:
    get:
      tags:
      - Document Translation
      summary: Microsoft Azure Returns The Status For A Specific Document
      description: Returns the translation status for a specific document based on the request Id and document Id.
      operationId: microsoftAzureDocumenttranslationGetdocumentstatus
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: Format - uuid.  The batch id
        required: true
        type: string
        format: uuid
      - in: path
        name: documentId
        description: Format - uuid.  The document id
        required: true
        type: string
        format: uuid
      responses:
        '200':
          description: Successful request and it is accepted by the service.  The operation details are returned
          schema:
            $ref: '#/definitions/DocumentStatus'
          headers:
            Retry-After:
              description: Indicates how long to wait before making a new request.
              type: integer
              format: int32
            ETag:
              description: The ETag response-header field provides the current value of the entity tag for the requested variant. Used with If-Match, If-None-Match and If-Range to implement optimistic concurrency control.
              type: string
              format: ''
        '401':
          description: Unauthorized.  Please check your credentials
          schema:
            $ref: '#/definitions/TranslationErrorResponse'
          examples:
            application/json: "{\r\n  \"error\": {\r\n    \"code\": \"Unauthorized\",\r\n    \"message\": \"User is not authorized\",\r\n    \"target\": \"document\",\r\n    \"innerError\": {\r\n      \"code\": \"Unauthorized\",\r\n      \"message\": \"Operation is not authorized\"\r\n    }\r\n  }\r\n}"
          x-ms-error-response: true
        '404':
          description: Resource is not found
          schema:
            $ref: '#/definitions/TranslationErrorResponse'
          examples:
            application/json: "{\r\n  \"error\": {\r\n    \"code\": \"ResourceNotFound\",\r\n    \"message\": \"id not found\",\r\n    \"target\": \"document\",\r\n    \"innerError\": {\r\n      \"code\": \"ResourceNotFound\",\r\n      \"message\": \"Resource requested is not found\"\r\n    }\r\n  }\r\n}"
          x-ms-error-response: true
        '429':
          description: Too many requests
          schema:
            $ref: '#/definitions/TranslationErrorResponse'
          examples:
            application/json: "{\r\n  \"error\": {\r\n    \"code\": \"RequestRateTooHigh\",\r\n    \"message\": \"User's request rate is too high\",\r\n    \"target\": \"document\",\r\n    \"innerError\": {\r\n      \"code\": \"RateTooHigh\",\r\n      \"message\": \"Request rate is too high\"\r\n    }\r\n  }\r\n}"
          x-ms-error-response: true
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/TranslationErrorResponse'
          examples:
            application/json: "{\r\n  \"error\": {\r\n    \"code\": \"InternalServerError\",\r\n    \"message\": \"Internal Server Error\",\r\n    \"target\": \"document\",\r\n    \"innerError\": {\r\n      \"code\": \"InternalServerError\",\r\n      \"message\": \"Unexpected internal server error has occurred\"\r\n    }\r\n  }\r\n}"
          x-ms-error-response: true
        '503':
          description: Server temporary unavailable
          schema:
            $ref: '#/definitions/TranslationErrorResponse'
          examples:
            application/json: "{\r\n  \"error\": {\r\n    \"code\": \"ServiceUnavailable\",\r\n    \"message\": \"Service is temporary unavailable\",\r\n    \"target\": \"document\",\r\n    \"innerError\": {\r\n      \"code\": \"ServiceTemporaryUnavailable\",\r\n      \"message\": \"Service is currently unavailable.  Please try again later\"\r\n    }\r\n  }\r\n}"
          x-ms-error-response: true
      x-ms-examples:
        Get Document Status:
          $ref: ./examples/document.json
  /batches/{id}:
    get:
      tags:
      - Document Translation
      summary: Microsoft Azure Returns The Status For A Document Translation Request
      description: Returns the status for a document translation request.<br>The status includes the overall request status, as well as the status for documents that are being translated as part of that request.
      operationId: microsoftAzureDocumenttranslationGettranslationstatus
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: Format - uuid.  The operation id
        required: true
        type: string
        format: uuid
      responses:
        '200':
          description: Successful request and returns the status of the batch translation operation
          schema:
            $ref: '#/definitions/TranslationStatus'
          headers:
            Retry-After:
              description: Indicates how long to wait before making a new request.
              type: integer
              format: int32
            ETag:
              description: The ETag response-header field provides the current value of the entity tag for the requested variant. Used with If-Match, If-None-Match and If-Range to implement optimistic concurrency control.
              type: string
              format: ''
        '401':
          description: Unauthorized.  Please check your credentials
          schema:
            $ref: '#/definitions/TranslationErrorResponse'
          examples:
            application/json: "{\r\n  \"error\": {\r\n    \"code\": \"Unauthorized\",\r\n    \"message\": \"User is not authorized\",\r\n    \"target\": \"batch\",\r\n    \"innerError\": {\r\n      \"code\": \"Unauthorized\",\r\n      \"message\": \"Operation is not authorized\"\r\n    }\r\n  }\r\n}"
          x-ms-error-response: true
        '404':
          description: Resource is not found
          schema:
            $ref: '#/definitions/TranslationErrorResponse'
          examples:
            application/json: "{\r\n  \"error\": {\r\n    \"code\": \"ResourceNotFound\",\r\n    \"message\": \"id not found\",\r\n    \"target\": \"batch\",\r\n    \"innerError\": {\r\n      \"code\": \"ResourceNotFound\",\r\n      \"message\": \"Resource requested is not found\"\r\n    }\r\n  }\r\n}"
          x-ms-error-response: true
        '429':
          description: Too many requests
          schema:
            $ref: '#/definitions/TranslationErrorResponse'
          examples:
            application/json: "{\r\n  \"error\": {\r\n    \"code\": \"RequestRateTooHigh\",\r\n    \"message\": \"User's request rate is too high\",\r\n    \"target\": \"batch\",\r\n    \"innerError\": {\r\n      \"code\": \"RateTooHigh\",\r\n      \"message\": \"Request rate is too high\"\r\n    }\r\n  }\r\n}"
          x-ms-error-response: true
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/TranslationErrorResponse'
          examples:
            application/json: "{\r\n  \"error\": {\r\n    \"code\": \"InternalServerError\",\r\n    \"message\": \"Internal Server Error\",\r\n    \"target\": \"batch\",\r\n    \"innerError\": {\r\n      \"code\": \"InternalServerError\",\r\n      \"message\": \"Unexpected internal server error has occurred\"\r\n    }\r\n  }\r\n}"
          x-ms-error-response: true
        '503':
          description: Server temporary unavailable
          schema:
            $ref: '#/definitions/TranslationErrorResponse'
          examples:
            application/json: "{\r\n  \"error\": {\r\n    \"code\": \"ServiceUnavailable\",\r\n    \"message\": \"Service is temporary unavailable\",\r\n    \"target\": \"batch\",\r\n    \"innerError\": {\r\n      \"code\": \"ServiceTemporaryUnavailable\",\r\n      \"message\": \"Service is currently unavailable.  Please try again later\"\r\n    }\r\n  }\r\n}"
          x-ms-error-response: true
      x-ms-examples:
        Get Batch Operation Status:
          $ref: ./examples/operation.json
    delete:
      tags:
      - Document Translation
      summary: Microsoft Azure Cancel A Currently Processing Or Queued Translation
      description: Cancel a currently processing or queued translation.<br>A translation will not be cancelled if it is already completed or failed or cancelling. A bad request will be returned.<br>All documents that have completed translation will not be cancelled and will be charged.<br>All pending documents will be cancelled if possible.
      operationId: microsoftAzureDocumenttranslationCanceltranslation
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: Format - uuid.  The operation-id
        required: true
        type: string
        format: uuid
      responses:
        '200':
          description: Cancel request has been submitted
          schema:
            $ref: '#/definitions/TranslationStatus'
        '401':
          description: Unauthorized.  Please check your credentials
          schema:
            $ref: '#/definitions/TranslationErrorResponse'
          examples:
            application/json: "{\r\n  \"error\": {\r\n    \"code\": \"Unauthorized\",\r\n    \"message\": \"User is not authorized\",\r\n    \"target\": \"batch\",\r\n    \"innerError\": {\r\n      \"code\": \"Unauthorized\",\r\n      \"message\": \"Operation is not authorized\"\r\n    }\r\n  }\r\n}"
          x-ms-error-response: true
        '404':
          description: Resource is not found
          schema:
            $ref: '#/definitions/TranslationErrorResponse'
          examples:
            application/json: "{\r\n  \"error\": {\r\n    \"code\": \"ResourceNotFound\",\r\n    \"message\": \"id not found\",\r\n    \"target\": \"batch\",\r\n    \"innerError\": {\r\n      \"code\": \"ResourceNotFound\",\r\n      \"message\": \"Resource requested is not found\"\r\n    }\r\n  }\r\n}"
          x-ms-error-response: true
        '429':
          description: Too many requests
          schema:
            $ref: '#/definitions/TranslationErrorResponse'
          examples:
            application/json: "{\r\n  \"error\": {\r\n    \"code\": \"RequestRateTooHigh\",\r\n    \"message\": \"User's request rate is too high\",\r\n    \"target\": \"batch\",\r\n    \"innerError\": {\r\n      \"code\": \"RateTooHigh\",\r\n      \"message\": \"Request rate is too high\"\r\n    }\r\n  }\r\n}"
          x-ms-error-response: true
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/TranslationErrorResponse'
          examples:
            application/json: "{\r\n  \"error\": {\r\n    \"code\": \"InternalServerError\",\r\n    \"message\": \"Internal Server Error\",\r\n    \"target\": \"batch\",\r\n    \"innerError\": {\r\n      \"code\": \"InternalServerError\",\r\n      \"message\": \"Unexpected internal server error has occurred\"\r\n    }\r\n  }\r\n}"
          x-ms-error-response: true
        '503':
          description: Server temporary unavailable
          schema:
            $ref: '#/definitions/TranslationErrorResponse'
          examples:
            application/json: "{\r\n  \"error\": {\r\n    \"code\": \"ServiceUnavailable\",\r\n    \"message\": \"Service is temporary unavailable\",\r\n    \"target\": \"batch\",\r\n    \"innerError\": {\r\n      \"code\": \"ServiceTemporaryUnavailable\",\r\n      \"message\": \"Service is currently unavailable.  Please try again later\"\r\n    }\r\n  }\r\n}"
          x-ms-error-response: true
      x-ms-examples:
        Cancel a batch operation example:
          $ref: ./examples/cancel.json
  /batches/{id}/documents:
    get:
      tags:
      - Document Translation
      summary: Microsoft Azure Returns The Status For All Documents In A Batch Document Translation Request
      description: 'Returns the status for all documents in a batch document translation request.<br>            <br>If the number of documents in the response exceeds our paging limit, server-side paging is used.<br>Paginated responses indicate a partial result and include a continuation token in the response. The absence of a continuation token means that no additional pages are available.<br>            <br>$top, $skip and $maxpagesize query parameters can be used to specify a number of results to return and an offset for the collection.<br>            <br>$top indicates the total number of records the user wants to be returned across all pages.<br>$skip indicates the number of records to skip from the list of document status held by the server based on the sorting method specified.  By default, we sort by descending start time.<br>$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 to be returned), @nextLink will contain the link to the next page.<br>            <br>$orderBy query parameter can be used to sort the returned list (ex "$orderBy=createdDateTimeUtc asc" or "$orderBy=createdDateTimeUtc desc").<br>The default sorting is descending by createdDateTimeUtc.<br>Some query parameters can be used to filter the returned list (ex: "status=Succeeded,Cancelled") will only return succeeded and cancelled documents.<br>createdDateTimeUtcStart and createdDateTimeUtcEnd can be used combined or separately to specify a range of datetime to filter the returned list by.<br>The supported filtering query parameters are (status, ids, createdDateTimeUtcStart, createdDateTimeUtcEnd).<br>            <br>When both $top and $skip are included, the server should first apply $skip and then $top on the collection.<br>Note: If the server can''t honor $top and/or $skip, the server must return an error to the client informing about it instead of just ignoring the query options.<br>This reduces the risk of the client making assumptions about the data returned.'
      operationId: microsoftAzureDocumenttranslationGetdocumentsstatus
      produces:
      - application/json
      parameters:
      - in: path
        name: id
        description: Format - uuid.  The operation id
        required: true
        type: string
        format: uuid
      - in: query
        name: $top
        description: "$top indicates the total number of records the user wants to be returned across all pages.\r\n            \r\nClients MAY use $top and $skip query parameters to specify a number of results to return and an offset into the collection.\r\nWhen both $top and $skip are given by a client, the server SHOULD first apply $skip and then $top on the collection.\r\n            \r\nNote: If the server can't honor $top and/or $skip, the server MUST return an error to the client informing about it instead of just ignoring the query options."
        type: integer
        format: int32
        maximum: 2147483647
        minimum: 0
      - in: query
        name: $skip
        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 default, we sort by descending start time.\r\n            \r\nClients MAY use $top and $skip query parameters to specify a number of results to return and an offset into the collection.\r\nWhen both $top and $skip are given by a client, the server SHOULD first apply $skip and then $top on the collection.\r\n            \r\nNote: If the server can't honor $top and/or $skip, the server MUST return an error to the client informing about it instead of just ignoring the query options."
        type: integer
        format: int32
        default: 0
        maximum: 2147483647
        minimum: 0
      - in: query
        name: $maxpagesize
        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 to be returned), @nextLink will contain the link to the next page.\r\n            \r\nClients MAY request server-driven paging with a specific page size by specifying a $maxpagesize preference. The server SHOULD honor this preference if the specified page size is smaller than the server's default page size."
        type: integer
        format: int32
        default: 50
        maximum: 100
        minimum: 1
      - in: query
        name: ids
        description: Ids to use in filtering
        type: array
        items:
          format: uuid
          type: string
        maxLength: 25
        collectionFormat: csv
      - in: query
        name: statuses
        description: Statuses to use in filtering
        type: array
        items:
          type: string
        maxLength: 5
        collectionFormat: csv
      - in: query
        name: createdDateTimeUtcStart
        description: the start datetime to get items after
        type: string
        format: date-time
      - in: query
        name: createdDateTimeUtcEnd
        description: the end datetime to get items before
        type: string
        format: date-time
      - in: query
        name: $orderBy
        description: 'the sorting query for the collection (ex: ''CreatedDateTimeUtc asc'', ''CreatedDateTimeUtc desc'')'
        type: array
        items:
          type: string
        maxLength: 1
        collectionFormat: csv
      responses:
        '200':
          description: Successful request and returns the status of the documents
          schema:
            $ref: '#/definitions/DocumentsStatus'
          headers:
            Retry-After:
              description: Indicates how long to wait before making a new request.
              type: integer
              format: int32
            ETag:
              description: The ETag response-header field provides the current value of the entity tag for the requested variant. Used with If-Match, If-None-Match and If-Range to implement optimistic concurrency control.
              type: string
              format: ''
        '400':
          description: Invalid request.  Check input parameters
          schema:
            $ref: '#/definitions/TranslationErrorResponse'
          examples:
            application/json: "{\r\n  \"error\": {\r\n    \"code\": \"InvalidRequest\",\r\n    \"message\": \"Some argument is incorrect\",\r\n    \"target\": \"document\",\r\n    \"innerError\": {\r\n      \"code\": \"SASTokenInvalid\",\r\n      \"message\": \"SAS token for storage is invalid\"\r\n    }\r\n  }\r\n}"
          x-ms-error-response: true
        '401':
          description: Unauthorized.  Please check your credentials
          schema:
            $ref: '#/definitions/TranslationErrorResponse'
          examples:
            application/json: "{\r\n  \"error\": {\r\n    \"code\": \"Unauthorized\",\r\n    \"message\": \"User is not authorized\",\r\n    \"target\": \"document\",\r\n    \"innerError\": {\r\n      \"code\": \"Unauthorized\",\r\n      \"message\": \"Operation is not authorized\"\r\n    }\r\n  }\r\n}"
          x-ms-error-response: true
        '404':
          description: Resource is not found
          schema:
            $ref: '#/definitions/TranslationErrorResponse'
          examples:
            application/json: "{\r\n  \"error\": {\r\n    \"code\": \"ResourceNotFound\",\r\n    \"message\": \"id not found\",\r\n    \"target\": \"document\",\r\n    \"innerError\": {\r\n      \"code\": \"ResourceNotFound\",\r\n      \"message\": \"Resource requested is not found\"\r\n    }\r\n  }\r\n}"
          x-ms-error-response: true
        '429':
          description: Too many requests
          schema:
            $ref: '#/definitions/TranslationErrorResponse'
          examples:
            application/json: "{\r\n  \"error\": {\r\n    \"code\": \"RequestRateTooHigh\",\r\n    \"message\": \"User's request rate is too high\",\r\n    \"target\": \"document\",\r\n    \"innerError\": {\r\n      \"code\": \"RateTooHigh\",\r\n      \"message\": \"Request rate is too high\"\r\n    }\r\n  }\r\n}"
          x-ms-error-response: true
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/TranslationErrorResponse'
          examples:
            application/json: "{\r\n  \"error\": {\r\n    \"code\": \"InternalServerError\",\r\n    \"message\": \"Internal Server Error\",\r\n    \"target\": \"document\",\r\n    \"innerError\": {\r\n      \"code\": \"InternalServerError\",\r\n      \"message\": \"Unexpected internal server error has occurred\"\r\n    }\r\n  }\r\n}"
          x-ms-error-response: true
        '503':
          description: Server temporary unavailable
          schema:
            $ref: '#/definitions/TranslationErrorResponse'
          examples:
            application/json: "{\r\n  \"error\": {\r\n    \"code\": \"ServiceUnavailable\",\r\n    \"message\": \"Service is temporary unavail

# --- truncated at 32 KB (52 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-azure-document-translation-api-openapi.yml