> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nitrotranslate.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Proofread

> Submit content for proofreading and create an order.
 Same as Translate, but with a single language instead of a source/target pair.



## OpenAPI

````yaml POST /v1/proofread
openapi: 3.1.0
info:
  title: NitroTranslate API
  description: Human Translation API
  contact:
    name: NitroTranslate
    url: https://nitrotranslate.com
  version: 0.3.2
  x-guidance: >-
    Human translation. Estimate cost with POST /v1/calculate, then POST
    /v1/translate. Pay via MPP or an API key.
servers:
  - url: https://api.nitrotranslate.com
    description: NitroTranslate
security:
  - BasicAuth: []
  - BearerAuth: []
  - PaymentAuth: []
  - ApiKeyAuth: []
paths:
  /v1/proofread:
    post:
      summary: Proofread
      description: |-
        Submit content for proofreading and create an order.
         Same as Translate, but with a single language instead of a source/target pair.
      operationId: TranslationService_Proofread
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/nitrotranslate.v1.ProofreadRequest'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/nitrotranslate.v1.ProofreadResponse'
        '402':
          description: Payment Required
components:
  schemas:
    nitrotranslate.v1.ProofreadRequest:
      type: object
      properties:
        language:
          type: string
          examples:
            - en
          title: language
          enum:
            - af
            - ar
            - az
            - be
            - bg
            - bn
            - ca
            - cs
            - da
            - de
            - el
            - en
            - es-ES
            - es-MX
            - et
            - fa
            - fi
            - fr
            - fr-CA
            - he
            - hi
            - hr
            - hu
            - hy-AM
            - id
            - is
            - it
            - ja
            - ka
            - kk
            - ko
            - ky
            - lt
            - lv
            - ml-IN
            - ms
            - my
            - nl
            - 'no'
            - pl
            - pt-BR
            - pt-PT
            - ro
            - ru
            - sk
            - sl
            - sr
            - sr-CS
            - sv-SE
            - ta
            - tg
            - th
            - tl
            - tr
            - te
            - uk
            - ur-PK
            - uz
            - vi
            - zh-CN
            - zh-TW
        resource:
          $ref: '#/components/schemas/nitrotranslate.v1.Resource'
          title: resource
        context:
          $ref: '#/components/schemas/nitrotranslate.v1.Context'
          title: context
        comment:
          $ref: '#/components/schemas/nitrotranslate.v1.CommentInput'
          title: comment
      title: ProofreadRequest
      required:
        - language
        - resource
      additionalProperties: false
      description: >-
        Proofreading request: same as TranslateRequest, but with a single
        language
         instead of a source/target pair.
    nitrotranslate.v1.ProofreadResponse:
      type: object
      properties:
        text:
          type: string
          title: text
          description: The submitted source text.
        resource:
          $ref: '#/components/schemas/nitrotranslate.v1.Resource'
          title: resource
          description: The submitted resource.
        volume:
          type: integer
          title: volume
          format: int32
          description: Billable character volume.
        orders:
          type: array
          items:
            $ref: '#/components/schemas/nitrotranslate.v1.OrderSummary'
          title: orders
          description: Created proofreading orders.
      title: ProofreadResponse
      additionalProperties: false
    nitrotranslate.v1.Resource:
      type: object
      properties:
        type:
          type: string
          examples:
            - text/plain
          title: type
          enum:
            - text/plain
            - text/html
            - text/x-objcstrings
            - application/json
            - application/xml
          description: Resource MIME type; one of the supported content types.
        data:
          type: string
          examples:
            - Hello, world!
          title: data
          description: The resource payload.
        metadata:
          type:
            - string
            - 'null'
          title: metadata
          description: Optional caller-defined metadata echoed back on the order.
      title: Resource
      required:
        - type
        - data
      additionalProperties: false
      description: >-
        The content to be translated. `data` is interpreted according to its
        MIME
         `type` (e.g. text/plain, text/html, application/json).
    nitrotranslate.v1.Context:
      type: object
      properties:
        tone:
          type:
            - string
            - 'null'
          examples:
            - FORMAL
          title: tone
          enum:
            - FORMAL
            - INFORMAL
            - GUESS
          description: >-
            Tone of voice: FORMAL, INFORMAL, or GUESS (let the translator
            decide).
        limit:
          type:
            - integer
            - 'null'
          title: limit
          minimum: 0
          format: int32
          description: Maximum number of characters allowed in the translation.
        category:
          type:
            - string
            - 'null'
          examples:
            - IT
          title: category
          enum:
            - APPS
            - CRYPTO
            - CASINO
            - LEGAL
            - E_COMMERCE
            - FINANCE
            - GAMES
            - GENERAL
            - MEDIA
            - MEDICAL
            - SCIENCE
            - IT
            - TRAVEL
          description: Subject-matter category guiding terminology.
      title: Context
      additionalProperties: false
      description: Translation hints applied to an order. All fields are optional.
    nitrotranslate.v1.CommentInput:
      type: object
      properties:
        text:
          type: string
          title: text
        attachments:
          type: array
          items:
            $ref: '#/components/schemas/nitrotranslate.v1.AttachmentInput'
          title: attachments
      title: CommentInput
      additionalProperties: false
      description: |-
        Comment supplied with a translation request (inbound counterpart of the
         `Comment` returned on an order).
    nitrotranslate.v1.OrderSummary:
      type: object
      properties:
        id:
          type: string
          title: id
          format: int64
        status:
          type:
            - string
            - 'null'
          examples:
            - QUEUE
          title: status
          enum:
            - QUEUE
            - PROGRESS
            - DONE
            - REVISION
          description: >-
            Lifecycle status: QUEUE -> PROGRESS -> DONE. REVISION marks a
            completed
             order pending revision; active rework reports as PROGRESS again.
        source_language:
          type: string
          title: source_language
        target_language:
          type: string
          title: target_language
        snippet:
          type: string
          title: snippet
          description: Short preview of the source text. ListOrders only.
        volume:
          type: integer
          title: volume
          format: int32
          description: Billable character volume.
        price:
          type: number
          title: price
          format: double
          description: Order price in US dollars. Always returned.
        created_at:
          $ref: '#/components/schemas/google.protobuf.Timestamp'
          title: created_at
      title: OrderSummary
      additionalProperties: false
      description: |-
        A lightweight order projection shared by the ListOrders and Translate
         responses. `price` is always returned; `status`/`snippet` are set by
         ListOrders only, and proto3 omits them from the Translate JSON when unset.
         Because status is absent on the Translate projection, it is constrained but
         not required here (it is required on the full Order, which always carries it).
    nitrotranslate.v1.AttachmentInput:
      type: object
      properties:
        type:
          type: string
          title: type
          description: MIME type, e.g. "image/png".
        data:
          type: string
          title: data
          description: Base64-encoded image bytes.
      title: AttachmentInput
      required:
        - type
        - data
      additionalProperties: false
      description: |-
        Attachment supplied with a translation comment on submission (inbound
         counterpart of the `Attachment` returned on an order).
    google.protobuf.Timestamp:
      type: string
      format: date-time
  securitySchemes:
    BasicAuth:
      type: http
      description: API key as the username, blank password.
      scheme: basic
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: opaque
    PaymentAuth:
      type: http
      description: >-
        MPP payment authorization, sent as `Authorization: Payment
        <credential>`.
      scheme: payment
    ApiKeyAuth:
      type: apiKey
      description: >-
        Account credentials in the Authorization header (`Bearer <token>` or
        `Basic <base64>`). Same credentials as BearerAuth/BasicAuth.
      name: Authorization
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.