# Generated by `npm run sync:openapi` in gotenberg.dev from its reference
# data. Don't edit it by hand: change the data, then run the script.
openapi: 3.1.0
info:
  title: Gotenberg
  version: "9"
  summary: A Docker-based API for PDF conversion
  description: "Every operation links to its page of the [documentation](https://gotenberg.dev/docs). The errors answer a status and a plain-text message: see [Errors](https://gotenberg.dev/docs/reference/errors)."
  license:
    name: MIT
    identifier: MIT
externalDocs:
  url: https://gotenberg.dev/docs
servers:
  - url: http://localhost:3000
    description: Local
  - url: https://demo.gotenberg.dev
    description: Demo
security:
  - {}
  - basicAuth: []
  - bearerAuth: []
tags:
  - name: Chromium
  - name: LibreOffice
  - name: PDF
  - name: "PDF: Pages"
  - name: "PDF: Stamps"
  - name: "PDF: Metadata"
  - name: "PDF: Attachments"
  - name: "PDF: Forms"
  - name: "PDF: Text"
  - name: "PDF: Print & size"
  - name: "PDF: Conformance"
  - name: "PDF: Security"
  - name: System
paths:
  /:
    get:
      operationId: root
      summary: Root
      description: "Answers a short note: Gotenberg has no UI."
      tags:
        - System
      externalDocs:
        url: https://gotenberg.dev/docs/system/root
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      responses:
        "200":
          description: "A short HTML note: Gotenberg has no UI."
          headers:
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            text/html:
              schema:
                type: string
        "401":
          $ref: "#/components/responses/Status401"
  /debug:
    get:
      operationId: debug
      summary: Debug
      description: Answers the modules, engine versions and flags, once `--api-enable-debug-route` is on.
      tags:
        - System
      externalDocs:
        url: https://gotenberg.dev/docs/system/debug
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      responses:
        "200":
          description: "JSON: the modules, the engine versions and every flag. It answers 404 until `--api-enable-debug-route` is on."
          headers:
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/json:
              schema:
                type: object
        "401":
          $ref: "#/components/responses/Status401"
  /forms/chromium/convert/html:
    post:
      operationId: chromiumConvertHtml
      summary: Convert HTML to PDF
      description: Prints an HTML file, with the assets beside it, to PDF.
      tags:
        - Chromium
      externalDocs:
        url: https://gotenberg.dev/docs/chromium/convert-html
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: |-
                    `index.html`, and the files it loads: style sheets, images, fonts, scripts. Link each by its name alone, such as `style.css`.

                    Upload under `files` too:

                    - `header.html`: Upload it under `files`: Chromium prints it at the top of each page. Elements with the class `date`, `title`, `url`, `pageNumber` or `totalPages` receive that value. It shares one document with the footer, so give each its own class names.
                    - `footer.html`: The same, at the bottom of each page.
                stages:
                  type: string
                  contentMediaType: application/json
                  description: Stages to run on the PDF, in order, such as `[{"op":"merge"}]`. Upload the files they name under `files`.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                waitDelay:
                  type: string
                  description: "Waits this long once the page loads, before printing: `2s`, `500ms`. It must be shorter than `--api-timeout`, or the request answers 400."
                waitForSelector:
                  type: string
                  description: Waits until an element matching this CSS selector is visible, such as `#chart.ready`.
                waitForExpression:
                  type: string
                  description: Waits until this JavaScript expression returns true, such as `window.ready === true`.
                waitForWindowStatus:
                  type: string
                  description: Waits until `window.status` equals this value.
                skipNetworkIdleEvent:
                  type: boolean
                  description: |-
                    Prints without waiting for the network to go idle. `false` waits, for pages that fetch content after they load.

                    Default: `true`.
                  default: true
                skipNetworkAlmostIdleEvent:
                  type: boolean
                  description: |-
                    Prints without waiting for the network to go almost idle. `false` waits.

                    Default: `true`.
                  default: true
                failOnHttpStatusCodes:
                  type: string
                  contentMediaType: application/json
                  description: |-
                    Answers 409 when the page itself answers one of these statuses. `499` stands for 400 to 499, `599` for 500 to 599, and so on for each hundred.

                    Default: `[499,599]`.
                failOnResourceHttpStatusCodes:
                  type: string
                  contentMediaType: application/json
                  description: Answers 409 when a resource the page loads, such as an image or a script, answers one of these statuses. Ranges work as for `failOnHttpStatusCodes`.
                ignoreResourceHttpStatusDomains:
                  type: string
                  contentMediaType: application/json
                  description: 'Domains, subdomains included, that `failOnResourceHttpStatusCodes` leaves out: `["sentry-cdn.com"]`.'
                failOnResourceLoadingFailed:
                  type: boolean
                  description: |-
                    Answers 409 when a resource's load fails on the network: a refused or dropped connection, a host that doesn't resolve, a blocked request. A timeout or a certificate error doesn't count.

                    Default: `false`.
                  default: false
                failOnConsoleExceptions:
                  type: boolean
                  description: |-
                    Answers 409 when the page throws a JavaScript exception.

                    Default: `false`.
                  default: false
                failOnConsoleMessageTypes:
                  type: string
                  contentMediaType: application/json
                  description: "Answers 409 when the page writes one of these console types: `log`, `debug`, `info`, `warning`, `error` or `assert`."
                cookies:
                  type: string
                  contentMediaType: application/json
                  description: "Cookies to set before loading: items with a `name`, a `value` and a `domain`, and optionally a `path`, `secure`, `httpOnly` and `sameSite` (`Strict`, `Lax` or `None`)."
                extraHttpHeaders:
                  type: string
                  contentMediaType: application/json
                  description: 'Headers Chromium sends with the requests the page makes: `{"X-Token": "abc"}`. End a value with `;scope=<regex>` to send it only to the URLs the regex matches. At most 64 headers.'
                userAgent:
                  type: string
                  description: Replaces Chromium's `User-Agent` header.
                emulatedMediaType:
                  type: string
                  description: "The CSS media type the page sees: `screen` or `print`."
                emulatedMediaFeatures:
                  type: string
                  contentMediaType: application/json
                  description: 'CSS media features the page sees: `{"prefers-color-scheme": "dark"}`.'
                omitBackground:
                  type: boolean
                  description: |-
                    Drops the default white background, for a transparent PDF or image. A PDF needs `printBackground` too.

                    Default: `false`.
                  default: false
                paperSize:
                  type: string
                  description: |-
                    `A0`, `A1`, `A2`, `A3`, `A4`, `A5`, `B4`, `B5`, `Letter`, `Legal` or `Tabloid`, in any case. Sets the width and the height.

                    Default: `Letter`.
                paperWidth:
                  type: string
                  description: |-
                    Overrides the width `paperSize` sets. A length is a number in inches, or a number with a unit: `210mm`, `21cm`, `595pt`, `794px`, `50pc`. A negative length answers 400.

                    Default: `8.5in`.
                paperHeight:
                  type: string
                  description: |-
                    Overrides the height `paperSize` sets. A negative length answers 400.

                    Default: `11in`.
                marginTop:
                  type: string
                  description: |-
                    The top margin. The header prints in it. A negative margin answers 400, as for the other margins.

                    Default: `0.39in`.
                marginBottom:
                  type: string
                  description: |-
                    The bottom margin. The footer prints in it.

                    Default: `0.39in`.
                marginLeft:
                  type: string
                  description: |-
                    The left margin.

                    Default: `0.39in`.
                marginRight:
                  type: string
                  description: |-
                    The right margin.

                    Default: `0.39in`.
                landscape:
                  type: boolean
                  description: |-
                    Turns the paper sideways.

                    Default: `false`.
                  default: false
                preferCssPageSize:
                  type: boolean
                  description: |-
                    Uses the size the page's CSS `@page` rule sets, over the paper size.

                    Default: `false`.
                  default: false
                scale:
                  type: number
                  description: |-
                    Scales the rendering, from `0.1` to `2`. A value outside that range answers 400.

                    Default: `1`.
                  default: 1
                printBackground:
                  type: boolean
                  description: |-
                    Prints the page's own background, set on `html` and `body`. Chromium prints the backgrounds of elements, such as table fills and colored boxes, whatever this field says.

                    Default: `false`.
                  default: false
                singlePage:
                  type: boolean
                  description: |-
                    Prints the whole page on one page, as tall as the content.

                    Default: `false`.
                  default: false
                nativePages:
                  type: string
                  description: "Pages to print, in Chromium's syntax: `1-5, 8, 11-13`. A page past the end answers 400. The `select` stage picks pages after printing, and takes `odd`, `even` and `last` too."
                nativeBookmarks:
                  type: boolean
                  description: |-
                    Builds bookmarks from the headings. Implies `nativeTaggedPdf`.

                    Default: `false`.
                  default: false
                nativeTaggedPdf:
                  type: boolean
                  description: |-
                    Writes a tagged PDF, whose structure screen readers follow.

                    Default: `false`.
                  default: false
              required:
                - files
      responses:
        "200":
          description: The PDF. A stage that makes several files, such as `split`, answers a ZIP.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
            Gotenberg-Remediation-Residual:
              $ref: "#/components/headers/Gotenberg-Remediation-Residual"
            Gotenberg-Remediation-Rolled-Back:
              $ref: "#/components/headers/Gotenberg-Remediation-Rolled-Back"
          content:
            application/pdf:
              schema:
                type: string
                contentMediaType: application/pdf
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "409":
          $ref: "#/components/responses/Status409"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "429":
          $ref: "#/components/responses/Status429"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/chromium/convert/markdown:
    post:
      operationId: chromiumConvertMarkdown
      summary: Convert Markdown to PDF
      description: Prints Markdown files, laid out by an HTML template, to PDF.
      tags:
        - Chromium
      externalDocs:
        url: https://gotenberg.dev/docs/chromium/convert-markdown
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: |-
                    `index.html`, the Markdown files it places with `{{ toHTML "notes.md" }}`, and the files the page loads.

                    Upload under `files` too:

                    - `header.html`: Upload it under `files`: Chromium prints it at the top of each page. Elements with the class `date`, `title`, `url`, `pageNumber` or `totalPages` receive that value. It shares one document with the footer, so give each its own class names.
                    - `footer.html`: The same, at the bottom of each page.
                stages:
                  type: string
                  contentMediaType: application/json
                  description: Stages to run on the PDF, in order, such as `[{"op":"merge"}]`. Upload the files they name under `files`.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                waitDelay:
                  type: string
                  description: "Waits this long once the page loads, before printing: `2s`, `500ms`. It must be shorter than `--api-timeout`, or the request answers 400."
                waitForSelector:
                  type: string
                  description: Waits until an element matching this CSS selector is visible, such as `#chart.ready`.
                waitForExpression:
                  type: string
                  description: Waits until this JavaScript expression returns true, such as `window.ready === true`.
                waitForWindowStatus:
                  type: string
                  description: Waits until `window.status` equals this value.
                skipNetworkIdleEvent:
                  type: boolean
                  description: |-
                    Prints without waiting for the network to go idle. `false` waits, for pages that fetch content after they load.

                    Default: `true`.
                  default: true
                skipNetworkAlmostIdleEvent:
                  type: boolean
                  description: |-
                    Prints without waiting for the network to go almost idle. `false` waits.

                    Default: `true`.
                  default: true
                failOnHttpStatusCodes:
                  type: string
                  contentMediaType: application/json
                  description: |-
                    Answers 409 when the page itself answers one of these statuses. `499` stands for 400 to 499, `599` for 500 to 599, and so on for each hundred.

                    Default: `[499,599]`.
                failOnResourceHttpStatusCodes:
                  type: string
                  contentMediaType: application/json
                  description: Answers 409 when a resource the page loads, such as an image or a script, answers one of these statuses. Ranges work as for `failOnHttpStatusCodes`.
                ignoreResourceHttpStatusDomains:
                  type: string
                  contentMediaType: application/json
                  description: 'Domains, subdomains included, that `failOnResourceHttpStatusCodes` leaves out: `["sentry-cdn.com"]`.'
                failOnResourceLoadingFailed:
                  type: boolean
                  description: |-
                    Answers 409 when a resource's load fails on the network: a refused or dropped connection, a host that doesn't resolve, a blocked request. A timeout or a certificate error doesn't count.

                    Default: `false`.
                  default: false
                failOnConsoleExceptions:
                  type: boolean
                  description: |-
                    Answers 409 when the page throws a JavaScript exception.

                    Default: `false`.
                  default: false
                failOnConsoleMessageTypes:
                  type: string
                  contentMediaType: application/json
                  description: "Answers 409 when the page writes one of these console types: `log`, `debug`, `info`, `warning`, `error` or `assert`."
                cookies:
                  type: string
                  contentMediaType: application/json
                  description: "Cookies to set before loading: items with a `name`, a `value` and a `domain`, and optionally a `path`, `secure`, `httpOnly` and `sameSite` (`Strict`, `Lax` or `None`)."
                extraHttpHeaders:
                  type: string
                  contentMediaType: application/json
                  description: 'Headers Chromium sends with the requests the page makes: `{"X-Token": "abc"}`. End a value with `;scope=<regex>` to send it only to the URLs the regex matches. At most 64 headers.'
                userAgent:
                  type: string
                  description: Replaces Chromium's `User-Agent` header.
                emulatedMediaType:
                  type: string
                  description: "The CSS media type the page sees: `screen` or `print`."
                emulatedMediaFeatures:
                  type: string
                  contentMediaType: application/json
                  description: 'CSS media features the page sees: `{"prefers-color-scheme": "dark"}`.'
                omitBackground:
                  type: boolean
                  description: |-
                    Drops the default white background, for a transparent PDF or image. A PDF needs `printBackground` too.

                    Default: `false`.
                  default: false
                paperSize:
                  type: string
                  description: |-
                    `A0`, `A1`, `A2`, `A3`, `A4`, `A5`, `B4`, `B5`, `Letter`, `Legal` or `Tabloid`, in any case. Sets the width and the height.

                    Default: `Letter`.
                paperWidth:
                  type: string
                  description: |-
                    Overrides the width `paperSize` sets. A length is a number in inches, or a number with a unit: `210mm`, `21cm`, `595pt`, `794px`, `50pc`. A negative length answers 400.

                    Default: `8.5in`.
                paperHeight:
                  type: string
                  description: |-
                    Overrides the height `paperSize` sets. A negative length answers 400.

                    Default: `11in`.
                marginTop:
                  type: string
                  description: |-
                    The top margin. The header prints in it. A negative margin answers 400, as for the other margins.

                    Default: `0.39in`.
                marginBottom:
                  type: string
                  description: |-
                    The bottom margin. The footer prints in it.

                    Default: `0.39in`.
                marginLeft:
                  type: string
                  description: |-
                    The left margin.

                    Default: `0.39in`.
                marginRight:
                  type: string
                  description: |-
                    The right margin.

                    Default: `0.39in`.
                landscape:
                  type: boolean
                  description: |-
                    Turns the paper sideways.

                    Default: `false`.
                  default: false
                preferCssPageSize:
                  type: boolean
                  description: |-
                    Uses the size the page's CSS `@page` rule sets, over the paper size.

                    Default: `false`.
                  default: false
                scale:
                  type: number
                  description: |-
                    Scales the rendering, from `0.1` to `2`. A value outside that range answers 400.

                    Default: `1`.
                  default: 1
                printBackground:
                  type: boolean
                  description: |-
                    Prints the page's own background, set on `html` and `body`. Chromium prints the backgrounds of elements, such as table fills and colored boxes, whatever this field says.

                    Default: `false`.
                  default: false
                singlePage:
                  type: boolean
                  description: |-
                    Prints the whole page on one page, as tall as the content.

                    Default: `false`.
                  default: false
                nativePages:
                  type: string
                  description: "Pages to print, in Chromium's syntax: `1-5, 8, 11-13`. A page past the end answers 400. The `select` stage picks pages after printing, and takes `odd`, `even` and `last` too."
                nativeBookmarks:
                  type: boolean
                  description: |-
                    Builds bookmarks from the headings. Implies `nativeTaggedPdf`.

                    Default: `false`.
                  default: false
                nativeTaggedPdf:
                  type: boolean
                  description: |-
                    Writes a tagged PDF, whose structure screen readers follow.

                    Default: `false`.
                  default: false
              required:
                - files
      responses:
        "200":
          description: The PDF. A stage that makes several files, such as `split`, answers a ZIP.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
            Gotenberg-Remediation-Residual:
              $ref: "#/components/headers/Gotenberg-Remediation-Residual"
            Gotenberg-Remediation-Rolled-Back:
              $ref: "#/components/headers/Gotenberg-Remediation-Rolled-Back"
          content:
            application/pdf:
              schema:
                type: string
                contentMediaType: application/pdf
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "409":
          $ref: "#/components/responses/Status409"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "429":
          $ref: "#/components/responses/Status429"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/chromium/convert/url:
    post:
      operationId: chromiumConvertUrl
      summary: Convert a URL to PDF
      description: Prints a web page to PDF.
      tags:
        - Chromium
      externalDocs:
        url: https://gotenberg.dev/docs/chromium/convert-url
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                url:
                  type: string
                  description: The page to load. It starts with `http://` or `https://`.
                stages:
                  type: string
                  contentMediaType: application/json
                  description: Stages to run on the PDF, in order, such as `[{"op":"merge"}]`. Upload the files they name under `files`.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                waitDelay:
                  type: string
                  description: "Waits this long once the page loads, before printing: `2s`, `500ms`. It must be shorter than `--api-timeout`, or the request answers 400."
                waitForSelector:
                  type: string
                  description: Waits until an element matching this CSS selector is visible, such as `#chart.ready`.
                waitForExpression:
                  type: string
                  description: Waits until this JavaScript expression returns true, such as `window.ready === true`.
                waitForWindowStatus:
                  type: string
                  description: Waits until `window.status` equals this value.
                skipNetworkIdleEvent:
                  type: boolean
                  description: |-
                    Prints without waiting for the network to go idle. `false` waits, for pages that fetch content after they load.

                    Default: `true`.
                  default: true
                skipNetworkAlmostIdleEvent:
                  type: boolean
                  description: |-
                    Prints without waiting for the network to go almost idle. `false` waits.

                    Default: `true`.
                  default: true
                failOnHttpStatusCodes:
                  type: string
                  contentMediaType: application/json
                  description: |-
                    Answers 409 when the page itself answers one of these statuses. `499` stands for 400 to 499, `599` for 500 to 599, and so on for each hundred.

                    Default: `[499,599]`.
                failOnResourceHttpStatusCodes:
                  type: string
                  contentMediaType: application/json
                  description: Answers 409 when a resource the page loads, such as an image or a script, answers one of these statuses. Ranges work as for `failOnHttpStatusCodes`.
                ignoreResourceHttpStatusDomains:
                  type: string
                  contentMediaType: application/json
                  description: 'Domains, subdomains included, that `failOnResourceHttpStatusCodes` leaves out: `["sentry-cdn.com"]`.'
                failOnResourceLoadingFailed:
                  type: boolean
                  description: |-
                    Answers 409 when a resource's load fails on the network: a refused or dropped connection, a host that doesn't resolve, a blocked request. A timeout or a certificate error doesn't count.

                    Default: `false`.
                  default: false
                failOnConsoleExceptions:
                  type: boolean
                  description: |-
                    Answers 409 when the page throws a JavaScript exception.

                    Default: `false`.
                  default: false
                failOnConsoleMessageTypes:
                  type: string
                  contentMediaType: application/json
                  description: "Answers 409 when the page writes one of these console types: `log`, `debug`, `info`, `warning`, `error` or `assert`."
                cookies:
                  type: string
                  contentMediaType: application/json
                  description: "Cookies to set before loading: items with a `name`, a `value` and a `domain`, and optionally a `path`, `secure`, `httpOnly` and `sameSite` (`Strict`, `Lax` or `None`)."
                extraHttpHeaders:
                  type: string
                  contentMediaType: application/json
                  description: 'Headers Chromium sends with the requests the page makes: `{"X-Token": "abc"}`. End a value with `;scope=<regex>` to send it only to the URLs the regex matches. At most 64 headers.'
                userAgent:
                  type: string
                  description: Replaces Chromium's `User-Agent` header.
                emulatedMediaType:
                  type: string
                  description: "The CSS media type the page sees: `screen` or `print`."
                emulatedMediaFeatures:
                  type: string
                  contentMediaType: application/json
                  description: 'CSS media features the page sees: `{"prefers-color-scheme": "dark"}`.'
                omitBackground:
                  type: boolean
                  description: |-
                    Drops the default white background, for a transparent PDF or image. A PDF needs `printBackground` too.

                    Default: `false`.
                  default: false
                paperSize:
                  type: string
                  description: |-
                    `A0`, `A1`, `A2`, `A3`, `A4`, `A5`, `B4`, `B5`, `Letter`, `Legal` or `Tabloid`, in any case. Sets the width and the height.

                    Default: `Letter`.
                paperWidth:
                  type: string
                  description: |-
                    Overrides the width `paperSize` sets. A length is a number in inches, or a number with a unit: `210mm`, `21cm`, `595pt`, `794px`, `50pc`. A negative length answers 400.

                    Default: `8.5in`.
                paperHeight:
                  type: string
                  description: |-
                    Overrides the height `paperSize` sets. A negative length answers 400.

                    Default: `11in`.
                marginTop:
                  type: string
                  description: |-
                    The top margin. The header prints in it. A negative margin answers 400, as for the other margins.

                    Default: `0.39in`.
                marginBottom:
                  type: string
                  description: |-
                    The bottom margin. The footer prints in it.

                    Default: `0.39in`.
                marginLeft:
                  type: string
                  description: |-
                    The left margin.

                    Default: `0.39in`.
                marginRight:
                  type: string
                  description: |-
                    The right margin.

                    Default: `0.39in`.
                landscape:
                  type: boolean
                  description: |-
                    Turns the paper sideways.

                    Default: `false`.
                  default: false
                preferCssPageSize:
                  type: boolean
                  description: |-
                    Uses the size the page's CSS `@page` rule sets, over the paper size.

                    Default: `false`.
                  default: false
                scale:
                  type: number
                  description: |-
                    Scales the rendering, from `0.1` to `2`. A value outside that range answers 400.

                    Default: `1`.
                  default: 1
                printBackground:
                  type: boolean
                  description: |-
                    Prints the page's own background, set on `html` and `body`. Chromium prints the backgrounds of elements, such as table fills and colored boxes, whatever this field says.

                    Default: `false`.
                  default: false
                singlePage:
                  type: boolean
                  description: |-
                    Prints the whole page on one page, as tall as the content.

                    Default: `false`.
                  default: false
                nativePages:
                  type: string
                  description: "Pages to print, in Chromium's syntax: `1-5, 8, 11-13`. A page past the end answers 400. The `select` stage picks pages after printing, and takes `odd`, `even` and `last` too."
                nativeBookmarks:
                  type: boolean
                  description: |-
                    Builds bookmarks from the headings. Implies `nativeTaggedPdf`.

                    Default: `false`.
                  default: false
                nativeTaggedPdf:
                  type: boolean
                  description: |-
                    Writes a tagged PDF, whose structure screen readers follow.

                    Default: `false`.
                  default: false
              required:
                - url
      responses:
        "200":
          description: The PDF. A stage that makes several files, such as `split`, answers a ZIP.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
            Gotenberg-Remediation-Residual:
              $ref: "#/components/headers/Gotenberg-Remediation-Residual"
            Gotenberg-Remediation-Rolled-Back:
              $ref: "#/components/headers/Gotenberg-Remediation-Rolled-Back"
          content:
            application/pdf:
              schema:
                type: string
                contentMediaType: application/pdf
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "409":
          $ref: "#/components/responses/Status409"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "429":
          $ref: "#/components/responses/Status429"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/chromium/screenshot/html:
    post:
      operationId: chromiumScreenshotHtml
      summary: Screenshot HTML
      description: Captures an HTML file as an image.
      tags:
        - Chromium
      externalDocs:
        url: https://gotenberg.dev/docs/chromium/screenshot-html
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "`index.html`, and the files it loads: style sheets, images, fonts, scripts. Link each by its name alone, such as `style.css`."
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                waitDelay:
                  type: string
                  description: "Waits this long once the page loads, before printing: `2s`, `500ms`. It must be shorter than `--api-timeout`, or the request answers 400."
                waitForSelector:
                  type: string
                  description: Waits until an element matching this CSS selector is visible, such as `#chart.ready`.
                waitForExpression:
                  type: string
                  description: Waits until this JavaScript expression returns true, such as `window.ready === true`.
                waitForWindowStatus:
                  type: string
                  description: Waits until `window.status` equals this value.
                skipNetworkIdleEvent:
                  type: boolean
                  description: |-
                    Prints without waiting for the network to go idle. `false` waits, for pages that fetch content after they load.

                    Default: `true`.
                  default: true
                skipNetworkAlmostIdleEvent:
                  type: boolean
                  description: |-
                    Prints without waiting for the network to go almost idle. `false` waits.

                    Default: `true`.
                  default: true
                failOnHttpStatusCodes:
                  type: string
                  contentMediaType: application/json
                  description: |-
                    Answers 409 when the page itself answers one of these statuses. `499` stands for 400 to 499, `599` for 500 to 599, and so on for each hundred.

                    Default: `[499,599]`.
                failOnResourceHttpStatusCodes:
                  type: string
                  contentMediaType: application/json
                  description: Answers 409 when a resource the page loads, such as an image or a script, answers one of these statuses. Ranges work as for `failOnHttpStatusCodes`.
                ignoreResourceHttpStatusDomains:
                  type: string
                  contentMediaType: application/json
                  description: 'Domains, subdomains included, that `failOnResourceHttpStatusCodes` leaves out: `["sentry-cdn.com"]`.'
                failOnResourceLoadingFailed:
                  type: boolean
                  description: |-
                    Answers 409 when a resource's load fails on the network: a refused or dropped connection, a host that doesn't resolve, a blocked request. A timeout or a certificate error doesn't count.

                    Default: `false`.
                  default: false
                failOnConsoleExceptions:
                  type: boolean
                  description: |-
                    Answers 409 when the page throws a JavaScript exception.

                    Default: `false`.
                  default: false
                failOnConsoleMessageTypes:
                  type: string
                  contentMediaType: application/json
                  description: "Answers 409 when the page writes one of these console types: `log`, `debug`, `info`, `warning`, `error` or `assert`."
                cookies:
                  type: string
                  contentMediaType: application/json
                  description: "Cookies to set before loading: items with a `name`, a `value` and a `domain`, and optionally a `path`, `secure`, `httpOnly` and `sameSite` (`Strict`, `Lax` or `None`)."
                extraHttpHeaders:
                  type: string
                  contentMediaType: application/json
                  description: 'Headers Chromium sends with the requests the page makes: `{"X-Token": "abc"}`. End a value with `;scope=<regex>` to send it only to the URLs the regex matches. At most 64 headers.'
                userAgent:
                  type: string
                  description: Replaces Chromium's `User-Agent` header.
                emulatedMediaType:
                  type: string
                  description: "The CSS media type the page sees: `screen` or `print`."
                emulatedMediaFeatures:
                  type: string
                  contentMediaType: application/json
                  description: 'CSS media features the page sees: `{"prefers-color-scheme": "dark"}`.'
                omitBackground:
                  type: boolean
                  description: |-
                    Drops the default white background, for a transparent PDF or image. A PDF needs `printBackground` too.

                    Default: `false`.
                  default: false
                format:
                  type: string
                  description: |-
                    `png`, `jpeg` or `webp`.

                    Default: `png`.
                quality:
                  type: integer
                  description: |-
                    The JPEG quality, from 1 to 100. Other formats ignore the value, which must still be in range.

                    Default: `100`.
                  default: 100
                width:
                  type: integer
                  description: |-
                    The viewport width, in CSS pixels.

                    Default: `800`.
                  default: 800
                height:
                  type: integer
                  description: |-
                    The viewport height, in CSS pixels.

                    Default: `600`.
                  default: 600
                clip:
                  type: boolean
                  description: |-
                    Captures the viewport only. Without it, the image is as tall as the page.

                    Default: `false`.
                  default: false
                selector:
                  type: string
                  description: Captures the first element matching this CSS selector, over `clip`. No visible match answers 400.
                deviceScaleFactor:
                  type: number
                  description: |-
                    Image pixels per CSS pixel: `2` doubles the resolution.

                    Default: `1`.
                  default: 1
                optimizeForSpeed:
                  type: boolean
                  description: |-
                    Encodes faster, for a larger file.

                    Default: `false`.
                  default: false
              required:
                - files
      responses:
        "200":
          description: The image, as PNG unless `format` picks another.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            image/png:
              schema:
                type: string
                contentMediaType: image/png
            image/jpeg:
              schema:
                type: string
                contentMediaType: image/jpeg
            image/webp:
              schema:
                type: string
                contentMediaType: image/webp
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "409":
          $ref: "#/components/responses/Status409"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "429":
          $ref: "#/components/responses/Status429"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/chromium/screenshot/markdown:
    post:
      operationId: chromiumScreenshotMarkdown
      summary: Screenshot Markdown
      description: Captures Markdown files, laid out by an HTML template, as an image.
      tags:
        - Chromium
      externalDocs:
        url: https://gotenberg.dev/docs/chromium/screenshot-markdown
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: '`index.html`, the Markdown files it places with `{{ toHTML "notes.md" }}`, and the files the page loads.'
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                waitDelay:
                  type: string
                  description: "Waits this long once the page loads, before printing: `2s`, `500ms`. It must be shorter than `--api-timeout`, or the request answers 400."
                waitForSelector:
                  type: string
                  description: Waits until an element matching this CSS selector is visible, such as `#chart.ready`.
                waitForExpression:
                  type: string
                  description: Waits until this JavaScript expression returns true, such as `window.ready === true`.
                waitForWindowStatus:
                  type: string
                  description: Waits until `window.status` equals this value.
                skipNetworkIdleEvent:
                  type: boolean
                  description: |-
                    Prints without waiting for the network to go idle. `false` waits, for pages that fetch content after they load.

                    Default: `true`.
                  default: true
                skipNetworkAlmostIdleEvent:
                  type: boolean
                  description: |-
                    Prints without waiting for the network to go almost idle. `false` waits.

                    Default: `true`.
                  default: true
                failOnHttpStatusCodes:
                  type: string
                  contentMediaType: application/json
                  description: |-
                    Answers 409 when the page itself answers one of these statuses. `499` stands for 400 to 499, `599` for 500 to 599, and so on for each hundred.

                    Default: `[499,599]`.
                failOnResourceHttpStatusCodes:
                  type: string
                  contentMediaType: application/json
                  description: Answers 409 when a resource the page loads, such as an image or a script, answers one of these statuses. Ranges work as for `failOnHttpStatusCodes`.
                ignoreResourceHttpStatusDomains:
                  type: string
                  contentMediaType: application/json
                  description: 'Domains, subdomains included, that `failOnResourceHttpStatusCodes` leaves out: `["sentry-cdn.com"]`.'
                failOnResourceLoadingFailed:
                  type: boolean
                  description: |-
                    Answers 409 when a resource's load fails on the network: a refused or dropped connection, a host that doesn't resolve, a blocked request. A timeout or a certificate error doesn't count.

                    Default: `false`.
                  default: false
                failOnConsoleExceptions:
                  type: boolean
                  description: |-
                    Answers 409 when the page throws a JavaScript exception.

                    Default: `false`.
                  default: false
                failOnConsoleMessageTypes:
                  type: string
                  contentMediaType: application/json
                  description: "Answers 409 when the page writes one of these console types: `log`, `debug`, `info`, `warning`, `error` or `assert`."
                cookies:
                  type: string
                  contentMediaType: application/json
                  description: "Cookies to set before loading: items with a `name`, a `value` and a `domain`, and optionally a `path`, `secure`, `httpOnly` and `sameSite` (`Strict`, `Lax` or `None`)."
                extraHttpHeaders:
                  type: string
                  contentMediaType: application/json
                  description: 'Headers Chromium sends with the requests the page makes: `{"X-Token": "abc"}`. End a value with `;scope=<regex>` to send it only to the URLs the regex matches. At most 64 headers.'
                userAgent:
                  type: string
                  description: Replaces Chromium's `User-Agent` header.
                emulatedMediaType:
                  type: string
                  description: "The CSS media type the page sees: `screen` or `print`."
                emulatedMediaFeatures:
                  type: string
                  contentMediaType: application/json
                  description: 'CSS media features the page sees: `{"prefers-color-scheme": "dark"}`.'
                omitBackground:
                  type: boolean
                  description: |-
                    Drops the default white background, for a transparent PDF or image. A PDF needs `printBackground` too.

                    Default: `false`.
                  default: false
                format:
                  type: string
                  description: |-
                    `png`, `jpeg` or `webp`.

                    Default: `png`.
                quality:
                  type: integer
                  description: |-
                    The JPEG quality, from 1 to 100. Other formats ignore the value, which must still be in range.

                    Default: `100`.
                  default: 100
                width:
                  type: integer
                  description: |-
                    The viewport width, in CSS pixels.

                    Default: `800`.
                  default: 800
                height:
                  type: integer
                  description: |-
                    The viewport height, in CSS pixels.

                    Default: `600`.
                  default: 600
                clip:
                  type: boolean
                  description: |-
                    Captures the viewport only. Without it, the image is as tall as the page.

                    Default: `false`.
                  default: false
                selector:
                  type: string
                  description: Captures the first element matching this CSS selector, over `clip`. No visible match answers 400.
                deviceScaleFactor:
                  type: number
                  description: |-
                    Image pixels per CSS pixel: `2` doubles the resolution.

                    Default: `1`.
                  default: 1
                optimizeForSpeed:
                  type: boolean
                  description: |-
                    Encodes faster, for a larger file.

                    Default: `false`.
                  default: false
              required:
                - files
      responses:
        "200":
          description: The image, as PNG unless `format` picks another.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            image/png:
              schema:
                type: string
                contentMediaType: image/png
            image/jpeg:
              schema:
                type: string
                contentMediaType: image/jpeg
            image/webp:
              schema:
                type: string
                contentMediaType: image/webp
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "409":
          $ref: "#/components/responses/Status409"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "429":
          $ref: "#/components/responses/Status429"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/chromium/screenshot/url:
    post:
      operationId: chromiumScreenshotUrl
      summary: Screenshot a URL
      description: Captures a web page as an image.
      tags:
        - Chromium
      externalDocs:
        url: https://gotenberg.dev/docs/chromium/screenshot-url
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                url:
                  type: string
                  description: The page to load. It starts with `http://` or `https://`.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                waitDelay:
                  type: string
                  description: "Waits this long once the page loads, before printing: `2s`, `500ms`. It must be shorter than `--api-timeout`, or the request answers 400."
                waitForSelector:
                  type: string
                  description: Waits until an element matching this CSS selector is visible, such as `#chart.ready`.
                waitForExpression:
                  type: string
                  description: Waits until this JavaScript expression returns true, such as `window.ready === true`.
                waitForWindowStatus:
                  type: string
                  description: Waits until `window.status` equals this value.
                skipNetworkIdleEvent:
                  type: boolean
                  description: |-
                    Prints without waiting for the network to go idle. `false` waits, for pages that fetch content after they load.

                    Default: `true`.
                  default: true
                skipNetworkAlmostIdleEvent:
                  type: boolean
                  description: |-
                    Prints without waiting for the network to go almost idle. `false` waits.

                    Default: `true`.
                  default: true
                failOnHttpStatusCodes:
                  type: string
                  contentMediaType: application/json
                  description: |-
                    Answers 409 when the page itself answers one of these statuses. `499` stands for 400 to 499, `599` for 500 to 599, and so on for each hundred.

                    Default: `[499,599]`.
                failOnResourceHttpStatusCodes:
                  type: string
                  contentMediaType: application/json
                  description: Answers 409 when a resource the page loads, such as an image or a script, answers one of these statuses. Ranges work as for `failOnHttpStatusCodes`.
                ignoreResourceHttpStatusDomains:
                  type: string
                  contentMediaType: application/json
                  description: 'Domains, subdomains included, that `failOnResourceHttpStatusCodes` leaves out: `["sentry-cdn.com"]`.'
                failOnResourceLoadingFailed:
                  type: boolean
                  description: |-
                    Answers 409 when a resource's load fails on the network: a refused or dropped connection, a host that doesn't resolve, a blocked request. A timeout or a certificate error doesn't count.

                    Default: `false`.
                  default: false
                failOnConsoleExceptions:
                  type: boolean
                  description: |-
                    Answers 409 when the page throws a JavaScript exception.

                    Default: `false`.
                  default: false
                failOnConsoleMessageTypes:
                  type: string
                  contentMediaType: application/json
                  description: "Answers 409 when the page writes one of these console types: `log`, `debug`, `info`, `warning`, `error` or `assert`."
                cookies:
                  type: string
                  contentMediaType: application/json
                  description: "Cookies to set before loading: items with a `name`, a `value` and a `domain`, and optionally a `path`, `secure`, `httpOnly` and `sameSite` (`Strict`, `Lax` or `None`)."
                extraHttpHeaders:
                  type: string
                  contentMediaType: application/json
                  description: 'Headers Chromium sends with the requests the page makes: `{"X-Token": "abc"}`. End a value with `;scope=<regex>` to send it only to the URLs the regex matches. At most 64 headers.'
                userAgent:
                  type: string
                  description: Replaces Chromium's `User-Agent` header.
                emulatedMediaType:
                  type: string
                  description: "The CSS media type the page sees: `screen` or `print`."
                emulatedMediaFeatures:
                  type: string
                  contentMediaType: application/json
                  description: 'CSS media features the page sees: `{"prefers-color-scheme": "dark"}`.'
                omitBackground:
                  type: boolean
                  description: |-
                    Drops the default white background, for a transparent PDF or image. A PDF needs `printBackground` too.

                    Default: `false`.
                  default: false
                format:
                  type: string
                  description: |-
                    `png`, `jpeg` or `webp`.

                    Default: `png`.
                quality:
                  type: integer
                  description: |-
                    The JPEG quality, from 1 to 100. Other formats ignore the value, which must still be in range.

                    Default: `100`.
                  default: 100
                width:
                  type: integer
                  description: |-
                    The viewport width, in CSS pixels.

                    Default: `800`.
                  default: 800
                height:
                  type: integer
                  description: |-
                    The viewport height, in CSS pixels.

                    Default: `600`.
                  default: 600
                clip:
                  type: boolean
                  description: |-
                    Captures the viewport only. Without it, the image is as tall as the page.

                    Default: `false`.
                  default: false
                selector:
                  type: string
                  description: Captures the first element matching this CSS selector, over `clip`. No visible match answers 400.
                deviceScaleFactor:
                  type: number
                  description: |-
                    Image pixels per CSS pixel: `2` doubles the resolution.

                    Default: `1`.
                  default: 1
                optimizeForSpeed:
                  type: boolean
                  description: |-
                    Encodes faster, for a larger file.

                    Default: `false`.
                  default: false
              required:
                - url
      responses:
        "200":
          description: The image, as PNG unless `format` picks another.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            image/png:
              schema:
                type: string
                contentMediaType: image/png
            image/jpeg:
              schema:
                type: string
                contentMediaType: image/jpeg
            image/webp:
              schema:
                type: string
                contentMediaType: image/webp
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "409":
          $ref: "#/components/responses/Status409"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "429":
          $ref: "#/components/responses/Status429"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/libreoffice/convert:
    post:
      operationId: libreofficeConvert
      summary: Convert office documents to PDF
      description: Converts office documents, such as Word, Excel and PowerPoint files, to PDF.
      tags:
        - LibreOffice
      externalDocs:
        url: https://gotenberg.dev/docs/libreoffice/convert
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The documents. LibreOffice converts the formats listed below, and skips the others.
                stages:
                  type: string
                  contentMediaType: application/json
                  description: Stages to run on the PDF, in order, such as `[{"op":"merge"}]`. Upload the files they name under `files`.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                password:
                  type: string
                  description: Opens a password-protected document.
                paperSize:
                  type: string
                  description: "`A0`, `A1`, `A2`, `A3`, `A4`, `A5`, `B4`, `B5`, `Letter`, `Legal` or `Tabloid`, in any case, for every page. Without it, each document keeps its own page size."
                paperWidth:
                  type: string
                  description: "Overrides the width `paperSize` sets. Without `paperSize`, set `paperHeight` too. A length is a number in inches, or a number with a unit: `210mm`, `21cm`, `595pt`, `794px`, `50pc`."
                paperHeight:
                  type: string
                  description: Overrides the height `paperSize` sets. Without `paperSize`, set `paperWidth` too.
                landscape:
                  type: boolean
                  description: |-
                    Turns the pages sideways.

                    Default: `false`.
                  default: false
                nativePages:
                  type: string
                  description: "Pages to export, in LibreOffice's syntax: `1-4`, `2`, `1,3,5-7`. The `select` stage picks pages after the conversion, and takes `odd`, `even` and `last` too."
                singlePage:
                  type: boolean
                  description: |-
                    Puts each sheet of a spreadsheet on one page, hidden sheets included, regardless of its paper size and print ranges.

                    Default: `false`.
                  default: false
                skipEmptyPages:
                  type: boolean
                  description: |-
                    Drops the blank pages a text document inserts on its own.

                    Default: `false`.
                  default: false
                updateIndexes:
                  type: boolean
                  description: |-
                    Updates the tables of contents and the other indexes before the export.

                    Default: `true`.
                  default: true
                exportFormFields:
                  type: boolean
                  description: |-
                    Exports form fields as fields a reader can fill. `false` prints their values only.

                    Default: `true`.
                  default: true
                allowDuplicateFieldNames:
                  type: boolean
                  description: |-
                    Lets several form fields share a name.

                    Default: `false`.
                  default: false
                nativeBookmarks:
                  type: boolean
                  description: |-
                    Exports the document's bookmarks, built from its headings.

                    Default: `true`.
                  default: true
                exportBookmarksToPdfDestination:
                  type: boolean
                  description: |-
                    Also exports the document's own bookmarks, such as Writer bookmarks, as named destinations, which links can target. Headings that build the outline are not bookmarks.

                    Default: `false`.
                  default: false
                exportPlaceholders:
                  type: boolean
                  description: |-
                    Shows the placeholder fields' markings. The exported placeholders do nothing.

                    Default: `false`.
                  default: false
                exportNotes:
                  type: boolean
                  description: |-
                    Exports comments as PDF annotations.

                    Default: `false`.
                  default: false
                exportNotesInMargin:
                  type: boolean
                  description: |-
                    Prints comments in the page margin.

                    Default: `false`.
                  default: false
                exportNotesPages:
                  type: boolean
                  description: |-
                    Adds a presentation's notes pages.

                    Default: `false`.
                  default: false
                exportOnlyNotesPages:
                  type: boolean
                  description: |-
                    Exports the notes pages only, with `exportNotesPages`.

                    Default: `false`.
                  default: false
                exportHiddenSlides:
                  type: boolean
                  description: |-
                    Includes the slides hidden from the slide show.

                    Default: `false`.
                  default: false
                useTransitionEffects:
                  type: boolean
                  description: |-
                    Exports a presentation's slide transitions.

                    Default: `true`.
                  default: true
                convertOooTargetToPdfTarget:
                  type: boolean
                  description: |-
                    Points links to `.odt`, `.ods`, `.odp` and `.odg` files at `.pdf` files of the same name.

                    Default: `false`.
                  default: false
                exportLinksRelativeFsys:
                  type: boolean
                  description: |-
                    Exports `file://` links relative to the document.

                    Default: `false`.
                  default: false
                addOriginalDocumentAsStream:
                  type: boolean
                  description: |-
                    Embeds the document in the PDF, for archiving. LibreOffice re-saves it as ODF and names it `Original.odt`, whatever you uploaded.

                    Default: `false`.
                  default: false
                nativeQuality:
                  type: integer
                  description: |-
                    The JPEG quality of the images, from 1 to 100.

                    Default: `90`.
                  default: 90
                nativeLosslessImageCompression:
                  type: boolean
                  description: |-
                    Compresses images losslessly, instead of as JPEG. Images the document stores as JPEG keep their data. Only images LibreOffice re-encodes, such as with `nativeReduceImageResolution`, become lossless.

                    Default: `false`.
                  default: false
                nativeReduceImageResolution:
                  type: boolean
                  description: |-
                    Downsamples images to `nativeMaxImageResolution`.

                    Default: `false`.
                  default: false
                nativeMaxImageResolution:
                  type: integer
                  description: |-
                    The resolution `nativeReduceImageResolution` downsamples to, in DPI: `75`, `150`, `300`, `600` or `1200`.

                    Default: `300`.
                  default: 300
                nativeWatermarkText:
                  type: string
                  description: Draws this text on every page. Set it or `nativeTiledWatermarkText`, not both.
                nativeWatermarkColor:
                  type: string
                  description: |-
                    The text color, as `#rrggbb`.

                    Default: `#7ffe7f`.
                nativeWatermarkFontSize:
                  type: integer
                  description: The font size, in points. Without it, the text spans the page.
                nativeWatermarkRotation:
                  type: number
                  description: "The angle, in degrees, counter-clockwise: `0` draws the text across the page. Without it, the text runs down a portrait page and across a landscape one."
                nativeWatermarkFont:
                  type: string
                  description: |-
                    The font name.

                    Default: `Helvetica`.
                nativeTiledWatermarkText:
                  type: string
                  description: "Repeats this text across every page, in a grid. Set it or `nativeWatermarkText`, not both: the size, color, font and rotation fields apply to `nativeWatermarkText` only."
                nativePdfa:
                  type: string
                  description: "Exports PDF/A: `PDF/A-1b`, `PDF/A-2b`, `PDF/A-3b` or `PDF/A-4`. The `remediate` stage reaches the other PDF/A levels."
                nativePdfua:
                  type: string
                  description: "Exports PDF/UA: `PDF/UA-1`. With `nativePdfa`, the document needs a title, and `PDF/A-4` answers 400: pair them in `remediate` instead."
                nativeTaggedPdf:
                  type: boolean
                  description: |-
                    Writes a tagged PDF, whose structure screen readers follow, without declaring PDF/UA.

                    Default: `false`.
                  default: false
                initialView:
                  type: string
                  description: |-
                    The side panel a viewer opens: `default`, `outline` or `thumbnails`.

                    Default: `default`.
                initialPage:
                  type: integer
                  description: |-
                    The page a viewer opens at.

                    Default: `1`.
                  default: 1
                magnification:
                  type: string
                  description: |-
                    How a viewer fits the page: `default`, `fitWindow`, `fitWidth`, `fitVisible` or `zoom`.

                    Default: `default`.
                zoom:
                  type: integer
                  description: |-
                    The zoom, in percent, with `magnification` set to `zoom`.

                    Default: `100`.
                  default: 100
                pageLayout:
                  type: string
                  description: |-
                    How a viewer lays the pages out: `default`, `singlePage`, `oneColumn` or `twoColumnRight`, two columns with the first page on the right. LibreOffice can't put it on the left.

                    Default: `default`.
                openBookmarkLevels:
                  type: integer
                  description: |-
                    How many bookmark levels a viewer expands, from 1 to 10. `-1` expands them all.

                    Default: `-1`.
                  default: -1
                resizeWindowToInitialPage:
                  type: boolean
                  description: |-
                    Sizes the viewer's window to the first page shown.

                    Default: `false`.
                  default: false
                centerWindow:
                  type: boolean
                  description: |-
                    Centers the viewer's window on the screen.

                    Default: `false`.
                  default: false
                openInFullScreenMode:
                  type: boolean
                  description: |-
                    Opens the viewer full screen.

                    Default: `false`.
                  default: false
                displayPDFDocumentTitle:
                  type: boolean
                  description: |-
                    Shows the document title, not the file name, in the viewer's title bar. Gotenberg writes it only when the document has a title. A PDF/UA output always shows the title.

                    Default: `true`.
                  default: true
                hideViewerMenubar:
                  type: boolean
                  description: |-
                    Hides the viewer's menu bar.

                    Default: `false`.
                  default: false
                hideViewerToolbar:
                  type: boolean
                  description: |-
                    Hides the viewer's toolbar.

                    Default: `false`.
                  default: false
                hideViewerWindowControls:
                  type: boolean
                  description: |-
                    Hides the viewer's window controls.

                    Default: `false`.
                  default: false
              required:
                - files
      responses:
        "200":
          description: "One PDF per document, named after it: `report.docx` gives `report.docx.pdf`. Several documents answer a ZIP, unless a `merge` stage joins them."
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
            Gotenberg-Remediation-Residual:
              $ref: "#/components/headers/Gotenberg-Remediation-Residual"
            Gotenberg-Remediation-Rolled-Back:
              $ref: "#/components/headers/Gotenberg-Remediation-Rolled-Back"
          content:
            application/pdf:
              schema:
                type: string
                contentMediaType: application/pdf
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "422":
          $ref: "#/components/responses/Status422"
        "429":
          $ref: "#/components/responses/Status429"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/attach:
    post:
      operationId: pdfAttach
      summary: Attach files
      description: Embeds an uploaded file in the PDF.
      tags:
        - "PDF: Attachments"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/attach
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs, and the files the options name.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                file:
                  type: string
                  description: The uploaded file to embed.
                name:
                  type: string
                  description: |-
                    The name the PDF lists it under.

                    Default: `The file's name`.
                mimeType:
                  type: string
                  description: |-
                    The file's MIME type.

                    Default: `From the name`.
                relationship:
                  type: string
                  description: "`Source`, `Data`, `Alternative`, `Supplement` or `Unspecified`. Makes the file a PDF/A-3 associated file."
              required:
                - files
                - file
      responses:
        "200":
          description: The PDF, or a ZIP of the PDFs when you send several.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/pdf:
              schema:
                type: string
                contentMediaType: application/pdf
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/attachments:
    post:
      operationId: pdfAttachments
      summary: List the attachments
      description: Lists the embedded files.
      tags:
        - "PDF: Attachments"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/attachments
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs.
                password:
                  type: string
                  description: Opens encrypted PDFs. A wrong one answers 400, and so does a missing one when the PDF has a user password.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
              required:
                - files
      responses:
        "200":
          description: JSON, one entry per PDF under its file name.
          headers:
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/json:
              schema:
                type: object
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/autotag:
    post:
      operationId: pdfAutotag
      summary: Tag a PDF
      description: Infers a structure tree for an untagged PDF, so screen readers can follow it. PDF/UA requires one.
      tags:
        - "PDF: Conformance"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/autotag
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
              required:
                - files
      responses:
        "200":
          description: The PDF, or a ZIP of the PDFs when you send several.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/pdf:
              schema:
                type: string
                contentMediaType: application/pdf
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/bookmarks:
    post:
      operationId: pdfBookmarks
      summary: Read the bookmarks
      description: Reads the bookmarks.
      tags:
        - "PDF: Metadata"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/bookmarks
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs.
                password:
                  type: string
                  description: Opens encrypted PDFs. A wrong one answers 400, and so does a missing one when the PDF has a user password.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
              required:
                - files
      responses:
        "200":
          description: JSON, one entry per PDF under its file name.
          headers:
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/json:
              schema:
                type: object
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/compose:
    post:
      operationId: pdfCompose
      summary: Compose pages
      description: "Draws pages of the PDFs on new pages of the size you choose: a label, a packing slip, a sheet of several pages. The result is one new PDF, named after the first."
      tags:
        - "PDF: Pages"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/compose
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                paperSize:
                  type: string
                  description: "`A0`, `A1`, `A2`, `A3`, `A4`, `A5`, `B4`, `B5`, `Letter`, `Legal` or `Tabloid`, in any case. Sets the width and the height. Set `paperSize`, or `paperWidth` and `paperHeight`."
                paperWidth:
                  type: string
                  description: "Overrides the width `paperSize` sets. A length is a number in inches, or a number with a unit: `6in`, `15cm`, `152mm`, `432pt`, `576px`, `36pc`."
                paperHeight:
                  type: string
                  description: Overrides the height `paperSize` sets.
                placements:
                  type: string
                  contentMediaType: application/json
                  description: Items with a `source`, the uploaded PDF to draw from, which may be left out with one PDF; a `sourcePage`, `1` by default; a `page`, the new page to draw on, `1` by default; `x` and `y`, in points from the bottom-left corner, `0` by default; a `scale`, `1` by default; and a `rotation`, in degrees counter-clockwise around `x` and `y`, `0` by default. Every uploaded PDF must be placed.
                dropSignatures:
                  type: boolean
                  description: |-
                    Removes the signatures of a signed PDF, which this stage rewrites, and keeps their visible appearance on the page. Without it, a signed PDF answers 400.

                    Default: `false`.
                  default: false
              required:
                - files
                - placements
      responses:
        "200":
          description: One PDF.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/pdf:
              schema:
                type: string
                contentMediaType: application/pdf
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/convert-colors:
    post:
      operationId: pdfConvertColors
      summary: Convert the colors
      description: Converts every color to one color space.
      tags:
        - "PDF: Print & size"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/convert-colors
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                target:
                  type: string
                  description: "`cmyk`, `rgb`, `gray`, or `output-intent` for the document's own output intent."
                dropSignatures:
                  type: boolean
                  description: |-
                    Removes the signatures of a signed PDF, which this stage rewrites, and keeps their visible appearance on the page. Without it, a signed PDF answers 400.

                    Default: `false`.
                  default: false
              required:
                - files
                - target
      responses:
        "200":
          description: The PDF, or a ZIP of the PDFs when you send several.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/pdf:
              schema:
                type: string
                contentMediaType: application/pdf
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/decrypt:
    post:
      operationId: pdfDecrypt
      summary: Decrypt a PDF
      description: Opens encrypted PDFs and removes their encryption.
      tags:
        - "PDF: Security"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/decrypt
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                password:
                  type: string
                  description: The password that opens the PDFs.
                dropSignatures:
                  type: boolean
                  description: |-
                    Removes the signatures of a signed PDF, which this stage rewrites, and keeps their visible appearance on the page. Without it, a signed PDF answers 400.

                    Default: `false`.
                  default: false
              required:
                - files
      responses:
        "200":
          description: The PDF, or a ZIP of the PDFs when you send several.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/pdf:
              schema:
                type: string
                contentMediaType: application/pdf
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/delete:
    post:
      operationId: pdfDelete
      summary: Delete pages
      description: Removes the pages you list.
      tags:
        - "PDF: Pages"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/delete
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                pages:
                  type: string
                  description: The pages to remove.
                dropSignatures:
                  type: boolean
                  description: |-
                    Removes the signatures of a signed PDF, which this stage rewrites, and keeps their visible appearance on the page. Without it, a signed PDF answers 400.

                    Default: `false`.
                  default: false
              required:
                - files
                - pages
      responses:
        "200":
          description: The PDF, or a ZIP of the PDFs when you send several.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/pdf:
              schema:
                type: string
                contentMediaType: application/pdf
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/detach:
    post:
      operationId: pdfDetach
      summary: Remove an attachment
      description: Removes an embedded file.
      tags:
        - "PDF: Attachments"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/detach
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                name:
                  type: string
                  description: The name the PDF lists the file under. `/forms/pdf/attachments` lists them; a name it doesn't list answers 400.
              required:
                - files
                - name
      responses:
        "200":
          description: The PDF, or a ZIP of the PDFs when you send several.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/pdf:
              schema:
                type: string
                contentMediaType: application/pdf
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/encrypt:
    post:
      operationId: pdfEncrypt
      summary: Encrypt a PDF
      description: Protects the PDF with passwords.
      tags:
        - "PDF: Security"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/encrypt
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                userPassword:
                  type: string
                  description: The password to open the PDF. Set `userPassword`, `ownerPassword`, or both.
                ownerPassword:
                  type: string
                  description: The password to lift the permissions.
                algorithm:
                  type: string
                  description: |-
                    `aes256`, `aes128`, `rc4-128` or `rc4-40`.

                    Default: `aes256`.
                permissions:
                  type: string
                  contentMediaType: application/json
                  description: "What a reader without the owner password may do: `print`, `printHighQuality`, `modifyContent`, `extractText`, `modifyAnnotations`, `fillForms`, `assemble`. Each is `true` unless you set it to `false`."
                dropSignatures:
                  type: boolean
                  description: |-
                    Removes the signatures of a signed PDF, which this stage rewrites, and keeps their visible appearance on the page. Without it, a signed PDF answers 400.

                    Default: `false`.
                  default: false
              required:
                - files
      responses:
        "200":
          description: The PDF, or a ZIP of the PDFs when you send several.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/pdf:
              schema:
                type: string
                contentMediaType: application/pdf
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/extract-attachments:
    post:
      operationId: pdfExtractAttachments
      summary: Extract the attachments
      description: "Returns the embedded files, which come back in a ZIP next to the PDF: `invoice_factur-x.xml`. `/forms/pdf/extract-attachments` returns the files alone. Comes last."
      tags:
        - "PDF: Attachments"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/extract-attachments
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                name:
                  type: string
                  description: |-
                    The name the PDF lists the file under. `/forms/pdf/attachments` lists them; a name it doesn't list answers 400.

                    Default: `all`.
              required:
                - files
      responses:
        "200":
          description: The file, or a ZIP of the files when there are several.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/octet-stream:
              schema:
                type: string
                contentMediaType: application/octet-stream
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/extract-text:
    post:
      operationId: pdfExtractText
      summary: Extract the text
      description: "Returns the text the pages show as a `.txt` file, its pages separated by a form feed, or as a Markdown `.md` file, which comes back in a ZIP next to the PDF: `report.txt`. `/forms/pdf/extract-text` returns the text alone. Comes last."
      tags:
        - "PDF: Text"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/extract-text
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                pages:
                  type: string
                  description: |-
                    The pages to read, in the order given. Markdown reads them in document order.

                    Default: `all`.
                format:
                  type: string
                  description: |-
                    `text`, or `markdown` for a `.md` file with the headings, lists, tables and links the PDF's structure gives. The Chromium and LibreOffice routes print a tagged PDF for Markdown.

                    Default: `text`.
                invisible:
                  type: boolean
                  description: |-
                    Adds the text layer a searchable scan carries under its image. Gotenberg recognizes no text in an image.

                    Default: `false`.
                  default: false
                artifacts:
                  type: boolean
                  description: |-
                    Adds the headers, footers, page numbers and stamps the PDF marks as artifacts.

                    Default: `false`.
                  default: false
                annotations:
                  type: boolean
                  description: |-
                    Adds the text of annotations, such as comments and free-text boxes.

                    Default: `false`.
                  default: false
              required:
                - files
      responses:
        "200":
          description: The text file, or a ZIP of the text files when there are several.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            text/plain:
              schema:
                type: string
            text/markdown:
              schema:
                type: string
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/flatten-form:
    post:
      operationId: pdfFlattenForm
      summary: Flatten a form
      description: Burns the form fields into the pages, which can then no longer be edited. A value without a stored appearance is drawn, with an installed font for text outside Western European.
      tags:
        - "PDF: Forms"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/flatten-form
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                dropSignatures:
                  type: boolean
                  description: |-
                    Removes the signatures of a signed PDF, which this stage rewrites, and keeps their visible appearance on the page. Without it, a signed PDF answers 400.

                    Default: `false`.
                  default: false
              required:
                - files
      responses:
        "200":
          description: The PDF, or a ZIP of the PDFs when you send several.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/pdf:
              schema:
                type: string
                contentMediaType: application/pdf
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/flatten-transparency:
    post:
      operationId: pdfFlattenTransparency
      summary: Flatten transparency
      description: Replaces transparent content with opaque content, for printers and archival formats that don't support transparency.
      tags:
        - "PDF: Print & size"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/flatten-transparency
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                dropSignatures:
                  type: boolean
                  description: |-
                    Removes the signatures of a signed PDF, which this stage rewrites, and keeps their visible appearance on the page. Without it, a signed PDF answers 400.

                    Default: `false`.
                  default: false
              required:
                - files
      responses:
        "200":
          description: The PDF, or a ZIP of the PDFs when you send several.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/pdf:
              schema:
                type: string
                contentMediaType: application/pdf
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/form:
    post:
      operationId: pdfForm
      summary: List the form fields
      description: "Lists the form's fields: name, type, value, pages, and the values each takes."
      tags:
        - "PDF: Forms"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/form
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs.
                password:
                  type: string
                  description: Opens encrypted PDFs. A wrong one answers 400, and so does a missing one when the PDF has a user password.
                pages:
                  type: string
                  description: Lists the fields on these pages only.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
              required:
                - files
      responses:
        "200":
          description: JSON, one entry per PDF under its file name.
          headers:
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/json:
              schema:
                type: object
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/info:
    post:
      operationId: pdfInfo
      summary: Read the info
      description: Reads the page count, the PDF version, and whether a PDF is encrypted, tagged, linearized, signed or holds form fields.
      tags:
        - PDF
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/info
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs.
                password:
                  type: string
                  description: Opens encrypted PDFs. A wrong one answers 400, and so does a missing one when the PDF has a user password.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
              required:
                - files
      responses:
        "200":
          description: JSON, one entry per PDF under its file name.
          headers:
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/json:
              schema:
                type: object
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/insert:
    post:
      operationId: pdfInsert
      summary: Insert pages
      description: Inserts the pages of another uploaded PDF.
      tags:
        - "PDF: Pages"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/insert
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs, and the files the options name.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                source:
                  type: string
                  description: The uploaded PDF whose pages to insert.
                at:
                  type: integer
                  description: |-
                    Inserts after this page. `0` inserts before the first page.

                    Default: `0`.
                  default: 0
                sourcePages:
                  type: string
                  description: |-
                    The pages of `source` to insert.

                    Default: `all`.
                dropSignatures:
                  type: boolean
                  description: |-
                    Removes the signatures of a signed PDF, which this stage rewrites, and keeps their visible appearance on the page. Without it, a signed PDF answers 400.

                    Default: `false`.
                  default: false
              required:
                - files
                - source
      responses:
        "200":
          description: The PDF, or a ZIP of the PDFs when you send several.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/pdf:
              schema:
                type: string
                contentMediaType: application/pdf
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/merge:
    post:
      operationId: pdfMerge
      summary: Merge PDFs
      description: Appends the PDFs into one, in the alphanumeric order of their names. The result takes the name of the first.
      tags:
        - "PDF: Pages"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/merge
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                fileBookmarks:
                  type: string
                  contentMediaType: application/json
                  description: 'Adds one bookmark per PDF, at its first page, with the PDF''s own bookmarks nested under it. `{}` labels each by its title, or by its filename without the extension when it has none. `label` lists the sources to try, in order, among `title` and `filename`, which always comes last. `labels` gives the label of the PDFs it names by filename, such as `{"annex.pdf": "Annex"}`.'
                dropSignatures:
                  type: boolean
                  description: |-
                    Removes the signatures of a signed PDF, which this stage rewrites, and keeps their visible appearance on the page. Without it, a signed PDF answers 400.

                    Default: `false`.
                  default: false
              required:
                - files
      responses:
        "200":
          description: One PDF.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/pdf:
              schema:
                type: string
                contentMediaType: application/pdf
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/metadata:
    post:
      operationId: pdfMetadata
      summary: Read the metadata
      description: "Reads the metadata: title, author, dates."
      tags:
        - "PDF: Metadata"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/metadata
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs.
                password:
                  type: string
                  description: Opens encrypted PDFs. A wrong one answers 400, and so does a missing one when the PDF has a user password.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
              required:
                - files
      responses:
        "200":
          description: JSON, one entry per PDF under its file name.
          headers:
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/json:
              schema:
                type: object
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/optimize:
    post:
      operationId: pdfOptimize
      summary: Optimize a PDF
      description: Rewrites the PDF to shrink it. Every option is on unless you turn it off. A signed PDF answers 400 unless `dropSignatures` is on, and an encrypted one unless the stages decrypt or encrypt it.
      tags:
        - "PDF: Print & size"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/optimize
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                objectStreams:
                  type: boolean
                  description: |-
                    Packs objects into compressed object streams.

                    Default: `true`.
                  default: true
                dedup:
                  type: boolean
                  description: |-
                    Stores identical streams once.

                    Default: `true`.
                  default: true
                recompressImages:
                  type: boolean
                  description: |-
                    Recompresses images without losing quality.

                    Default: `true`.
                  default: true
                subsetFonts:
                  type: boolean
                  description: |-
                    Keeps only the glyphs the document shows.

                    Default: `true`.
                  default: true
                dropSignatures:
                  type: boolean
                  description: |-
                    Removes the signatures of a signed PDF, which this stage rewrites, and keeps their visible appearance on the page. Without it, a signed PDF answers 400.

                    Default: `false`.
                  default: false
              required:
                - files
      responses:
        "200":
          description: The PDF, or a ZIP of the PDFs when you send several.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/pdf:
              schema:
                type: string
                contentMediaType: application/pdf
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/pipe:
    post:
      operationId: pdfPipe
      summary: Run stages
      description: Runs a list of stages on PDFs.
      tags:
        - PDF
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/pipe
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs, and the files the stages name, such as a stamp's image.
                stages:
                  type: string
                  contentMediaType: application/json
                  description: The stages to run, in order, such as `[{"op":"merge"},{"op":"optimize"}]`.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
              required:
                - files
                - stages
      responses:
        "200":
          description: "The PDF, or a ZIP when several PDFs come out: several uploads without a `merge`, or a `split`."
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
            Gotenberg-Remediation-Residual:
              $ref: "#/components/headers/Gotenberg-Remediation-Residual"
            Gotenberg-Remediation-Rolled-Back:
              $ref: "#/components/headers/Gotenberg-Remediation-Rolled-Back"
          content:
            application/pdf:
              schema:
                type: string
                contentMediaType: application/pdf
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
            image/png:
              schema:
                type: string
                contentMediaType: image/png
            image/jpeg:
              schema:
                type: string
                contentMediaType: image/jpeg
            text/plain:
              schema:
                type: string
            text/markdown:
              schema:
                type: string
            application/octet-stream:
              schema:
                type: string
                contentMediaType: application/octet-stream
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/redact:
    post:
      operationId: pdfRedact
      summary: Redact content
      description: Removes the content under each region from the file itself, not just from view. Nothing is drawn in its place.
      tags:
        - "PDF: Text"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/redact
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                regions:
                  type: string
                  contentMediaType: application/json
                  description: Rectangles with a `page`, and `x`, `y`, `width` and `height` in points from the bottom-left corner.
                dropSignatures:
                  type: boolean
                  description: |-
                    Removes the signatures of a signed PDF, which this stage rewrites, and keeps their visible appearance on the page. Without it, a signed PDF answers 400.

                    Default: `false`.
                  default: false
              required:
                - files
                - regions
      responses:
        "200":
          description: The PDF, or a ZIP of the PDFs when you send several.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/pdf:
              schema:
                type: string
                contentMediaType: application/pdf
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/remediate:
    post:
      operationId: pdfRemediate
      summary: Make a PDF conform
      description: "Repairs the PDF until it conforms to a profile, or to a PDF/A profile and a PDF/UA one together. `Gotenberg-Remediation-Residual` counts the violations left: `0` means it conforms."
      tags:
        - "PDF: Conformance"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/remediate
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs, and the files the options name.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                profile:
                  type: string
                  description: "`PDF/A-1a`, `PDF/A-1b`, `PDF/A-2a`, `PDF/A-2b`, `PDF/A-2u`, `PDF/A-3a`, `PDF/A-3b`, `PDF/A-3u`, `PDF/A-4`, `PDF/A-4e`, `PDF/A-4f`, `PDF/UA-1`, `PDF/UA-2` or `Factur-X`. A list pairs a PDF/A profile, or `Factur-X`, with the PDF/UA profile of its PDF version: PDF/A-1 to PDF/A-3 with `PDF/UA-1`, PDF/A-4 with `PDF/UA-2`."
                language:
                  type: string
                  description: |-
                    The document's language, as a BCP 47 tag such as `de-DE`.

                    Default: `en`.
                aggressive:
                  type: boolean
                  description: |-
                    Allows fixes that may change how pages look, for better compliance.

                    Default: `false`.
                  default: false
                figureAltText:
                  type: string
                  description: The alternate text for figures that lack one.
                xml:
                  type: string
                  description: "Factur-X only: the uploaded invoice XML to embed. Without it, Factur-X repairs the invoice the PDF already carries."
                level:
                  type: string
                  description: "Factur-X with `xml`, required: `MINIMUM`, `BASIC WL`, `BASIC`, `EN 16931`, `EXTENDED` or `XRECHNUNG`."
                documentType:
                  type: string
                  description: |-
                    Factur-X with `xml`: the document type written in the metadata.

                    Default: `INVOICE`.
                dropSignatures:
                  type: boolean
                  description: |-
                    Removes the signatures of a signed PDF, which this stage rewrites, and keeps their visible appearance on the page. Without it, a signed PDF answers 400.

                    Default: `false`.
                  default: false
              required:
                - files
                - profile
      responses:
        "200":
          description: The PDF, or a ZIP of the PDFs when you send several.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
            Gotenberg-Remediation-Residual:
              $ref: "#/components/headers/Gotenberg-Remediation-Residual"
            Gotenberg-Remediation-Rolled-Back:
              $ref: "#/components/headers/Gotenberg-Remediation-Rolled-Back"
          content:
            application/pdf:
              schema:
                type: string
                contentMediaType: application/pdf
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/render:
    post:
      operationId: pdfRender
      summary: Render pages as images
      description: "Draws pages as images, which come back in a ZIP next to the PDF: `report_1.png`. `/forms/pdf/render` returns the images alone."
      tags:
        - "PDF: Pages"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/render
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                pages:
                  type: string
                  description: |-
                    The pages to draw.

                    Default: `all`.
                dpi:
                  type: integer
                  description: |-
                    The resolution, at least 1.

                    Default: `150`.
                  default: 150
                format:
                  type: string
                  description: |-
                    `png` or `jpeg`.

                    Default: `png`.
                quality:
                  type: integer
                  description: |-
                    `jpeg` only, from 1 to 100. With `png`, it answers 400.

                    Default: `100`.
                  default: 100
              required:
                - files
      responses:
        "200":
          description: The image, or a ZIP of the images when there are several.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            image/png:
              schema:
                type: string
                contentMediaType: image/png
            image/jpeg:
              schema:
                type: string
                contentMediaType: image/jpeg
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/rotate:
    post:
      operationId: pdfRotate
      summary: Rotate pages
      description: Sets the rotation of pages. Viewers turn them clockwise.
      tags:
        - "PDF: Pages"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/rotate
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                angle:
                  type: integer
                  description: A multiple of 90, such as `90` or `-90`.
                pages:
                  type: string
                  description: |-
                    The pages to rotate.

                    Default: `all`.
              required:
                - files
                - angle
      responses:
        "200":
          description: The PDF, or a ZIP of the PDFs when you send several.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/pdf:
              schema:
                type: string
                contentMediaType: application/pdf
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/select:
    post:
      operationId: pdfSelect
      summary: Select pages
      description: Keeps the pages you list, in the order you list them.
      tags:
        - "PDF: Pages"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/select
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                pages:
                  type: string
                  description: The pages to keep, such as `3,1` or `1-2`.
                dropSignatures:
                  type: boolean
                  description: |-
                    Removes the signatures of a signed PDF, which this stage rewrites, and keeps their visible appearance on the page. Without it, a signed PDF answers 400.

                    Default: `false`.
                  default: false
              required:
                - files
                - pages
      responses:
        "200":
          description: The PDF, or a ZIP of the PDFs when you send several.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/pdf:
              schema:
                type: string
                contentMediaType: application/pdf
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/set-bookmarks:
    post:
      operationId: pdfSetBookmarks
      summary: Set the bookmarks
      description: Replaces the bookmarks, the outline viewers show beside the pages.
      tags:
        - "PDF: Metadata"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/set-bookmarks
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                bookmarks:
                  type: string
                  contentMediaType: application/json
                  description: Items with a `title`, a `pageNumber`, and optional `children` items.
              required:
                - files
                - bookmarks
      responses:
        "200":
          description: The PDF, or a ZIP of the PDFs when you send several.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/pdf:
              schema:
                type: string
                contentMediaType: application/pdf
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/set-form:
    post:
      operationId: pdfSetForm
      summary: Fill a form
      description: Fills form fields.
      tags:
        - "PDF: Forms"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/set-form
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                fields:
                  type: string
                  contentMediaType: application/json
                  description: "Values keyed by the fields' fully qualified names: a string, or an array of strings for a list that selects several. `/forms/pdf/form` lists the fields and the values each takes."
              required:
                - files
                - fields
      responses:
        "200":
          description: The PDF, or a ZIP of the PDFs when you send several.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/pdf:
              schema:
                type: string
                contentMediaType: application/pdf
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/set-metadata:
    post:
      operationId: pdfSetMetadata
      summary: Set the metadata
      description: Writes the document information. A field you leave out keeps its value.
      tags:
        - "PDF: Metadata"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/set-metadata
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                title:
                  type: string
                  description: The title.
                author:
                  type: string
                  description: The author.
                subject:
                  type: string
                  description: The subject.
                keywords:
                  type: string
                  description: The keywords.
                creator:
                  type: string
                  description: The application that made the original document.
                producer:
                  type: string
                  description: The application that made the PDF.
                creationDate:
                  type: string
                  description: A PDF date, such as `D:20260101120000Z`.
                modDate:
                  type: string
                  description: A PDF date.
              required:
                - files
      responses:
        "200":
          description: The PDF, or a ZIP of the PDFs when you send several.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/pdf:
              schema:
                type: string
                contentMediaType: application/pdf
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/sign:
    post:
      operationId: pdfSign
      summary: Sign a PDF
      description: Signs the PDF with a certificate you upload.
      tags:
        - "PDF: Security"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/sign
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs, and the files the options name.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                certificate:
                  type: string
                  description: An uploaded PKCS#12 file, or a PEM certificate with `key`.
                key:
                  type: string
                  description: The PEM private key that goes with a PEM `certificate`.
                certificatePassword:
                  type: string
                  description: The password that opens a PKCS#12 `certificate`.
                reason:
                  type: string
                  description: Why the PDF is signed.
                location:
                  type: string
                  description: Where it is signed.
                contactInfo:
                  type: string
                  description: How to reach the signer.
                name:
                  type: string
                  description: The signer's name.
                pades:
                  type: boolean
                  description: |-
                    Makes a PAdES signature, the format eIDAS recognizes.

                    Default: `false`.
                  default: false
                timestampUrl:
                  type: string
                  description: An RFC 3161 timestamp authority to timestamp the signature with.
              required:
                - files
                - certificate
      responses:
        "200":
          description: The PDF, or a ZIP of the PDFs when you send several.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/pdf:
              schema:
                type: string
                contentMediaType: application/pdf
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/split:
    post:
      operationId: pdfSplit
      summary: Split PDFs
      description: "Cuts each PDF into several, which come back in a ZIP: `report_0.pdf`, `report_1.pdf`… The stages after it run on each part."
      tags:
        - "PDF: Pages"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/split
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                every:
                  type: integer
                  description: Cuts every this many pages, at least 1. Set `every` or `ranges`, not both.
                ranges:
                  type: string
                  contentMediaType: application/json
                  description: One PDF per entry, each a page selection such as `1-3` or `4,6`.
                dropSignatures:
                  type: boolean
                  description: |-
                    Removes the signatures of a signed PDF, which this stage rewrites, and keeps their visible appearance on the page. Without it, a signed PDF answers 400.

                    Default: `false`.
                  default: false
              required:
                - files
      responses:
        "200":
          description: A ZIP of the parts, or the one part as a PDF.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/pdf:
              schema:
                type: string
                contentMediaType: application/pdf
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/stamp-image:
    post:
      operationId: pdfStampImage
      summary: Stamp an image
      description: Draws an uploaded PNG or JPEG image over pages.
      tags:
        - "PDF: Stamps"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/stamp-image
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs, and the files the options name.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                image:
                  type: string
                  description: The uploaded `.png`, `.jpg` or `.jpeg` image.
                pages:
                  type: string
                  description: |-
                    The pages to stamp.

                    Default: `all`.
                x:
                  type: number
                  description: |-
                    The left edge of the image, in points from the left of the page. With `position`, moves the image right from it.

                    Default: `0`.
                  default: 0
                "y":
                  type: number
                  description: |-
                    The bottom edge of the image, in points from the bottom of the page. With `position`, moves the image up from it.

                    Default: `0`.
                  default: 0
                position:
                  type: string
                  description: "Places the image against the page as a viewer shows it: `center`, `top-left`, `top`, `top-right`, `left`, `right`, `bottom-left`, `bottom` or `bottom-right`. Unset, `x` and `y` place it."
                width:
                  type: number
                  description: In points. Set `width` or `height` to keep the proportions; set neither to draw each pixel as a point.
                height:
                  type: number
                  description: In points.
                opacity:
                  type: number
                  description: From 0 to 1. Unset, or `0`, draws the image opaque.
                rotation:
                  type: number
                  description: |-
                    Degrees, counter-clockwise, around `x` and `y`. With `position`, the turned image stays against it.

                    Default: `0`.
                  default: 0
              required:
                - files
                - image
      responses:
        "200":
          description: The PDF, or a ZIP of the PDFs when you send several.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/pdf:
              schema:
                type: string
                contentMediaType: application/pdf
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/stamp-pdf:
    post:
      operationId: pdfStampPdf
      summary: Stamp a PDF page
      description: "Draws a page of another uploaded PDF over pages: a letterhead, a seal."
      tags:
        - "PDF: Stamps"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/stamp-pdf
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs, and the files the options name.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                source:
                  type: string
                  description: The uploaded PDF to draw.
                sourcePage:
                  type: integer
                  description: |-
                    The page of `source` to draw.

                    Default: `1`.
                  default: 1
                pages:
                  type: string
                  description: |-
                    The pages to stamp.

                    Default: `all`.
                x:
                  type: number
                  description: |-
                    The left edge, in points from the left of the page. With `position`, moves the page right from it.

                    Default: `0`.
                  default: 0
                "y":
                  type: number
                  description: |-
                    The bottom edge, in points from the bottom of the page. With `position`, moves the page up from it.

                    Default: `0`.
                  default: 0
                position:
                  type: string
                  description: "Places the page against the page as a viewer shows it: `center`, `top-left`, `top`, `top-right`, `left`, `right`, `bottom-left`, `bottom` or `bottom-right`. Unset, `x` and `y` place it."
                scale:
                  type: number
                  description: |-
                    The scale factor. Greater than 0.

                    Default: `1`.
                  default: 1
                opacity:
                  type: number
                  description: From 0 to 1. Unset, or `0`, draws the page opaque.
                rotation:
                  type: number
                  description: |-
                    Degrees, counter-clockwise, around `x` and `y`. With `position`, the turned page stays against it.

                    Default: `0`.
                  default: 0
              required:
                - files
                - source
      responses:
        "200":
          description: The PDF, or a ZIP of the PDFs when you send several.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/pdf:
              schema:
                type: string
                contentMediaType: application/pdf
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/stamp-text:
    post:
      operationId: pdfStampText
      summary: Stamp text
      description: Draws a line of text over pages.
      tags:
        - "PDF: Stamps"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/stamp-text
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                text:
                  type: string
                  description: The text to draw.
                pages:
                  type: string
                  description: |-
                    The pages to stamp.

                    Default: `all`.
                x:
                  type: number
                  description: |-
                    The position, in points from the left edge. With `position`, moves the text right from it.

                    Default: `0`.
                  default: 0
                "y":
                  type: number
                  description: |-
                    The position, in points from the bottom edge. With `position`, moves the text up from it.

                    Default: `0`.
                  default: 0
                position:
                  type: string
                  description: "Places the text against the page as a viewer shows it: `center`, `top-left`, `top`, `top-right`, `left`, `right`, `bottom-left`, `bottom` or `bottom-right`. Unset, `x` and `y` place it."
                fontSize:
                  type: number
                  description: |-
                    The size of the text, in points. Greater than 0.

                    Default: `12`.
                  default: 12
                font:
                  type: string
                  description: |-
                    One of the 14 standard PDF fonts: `Helvetica`, `Times-Roman`, `Courier`, their `-Bold`, `-Oblique` or `-Italic` variants, or `Symbol` and `ZapfDingbats`, which draw Western European text as symbols. Text outside Western European takes an installed font, of the same family when one has its characters.

                    Default: `Helvetica`.
                color:
                  type: string
                  description: |-
                    The color, as `#rrggbb`.

                    Default: `#000000`.
                opacity:
                  type: number
                  description: From 0 to 1. Unset, or `0`, draws the text opaque.
                rotation:
                  type: number
                  description: |-
                    Degrees, counter-clockwise, around `x` and `y`. With `position`, the turned text stays against it.

                    Default: `0`.
                  default: 0
              required:
                - files
                - text
      responses:
        "200":
          description: The PDF, or a ZIP of the PDFs when you send several.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/pdf:
              schema:
                type: string
                contentMediaType: application/pdf
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/timestamp:
    post:
      operationId: pdfTimestamp
      summary: Timestamp a PDF
      description: "Adds a document timestamp from an RFC 3161 timestamp authority: proof the PDF existed, unchanged, at that time."
      tags:
        - "PDF: Security"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/timestamp
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Output-Filename"
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Method"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Events-Url"
        - $ref: "#/components/parameters/Gotenberg-Webhook-Extra-Http-Headers"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs.
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
                timestampUrl:
                  type: string
                  description: The authority's `http://` or `https://` URL.
              required:
                - files
                - timestampUrl
      responses:
        "200":
          description: The PDF, or a ZIP of the PDFs when you send several.
          headers:
            Content-Disposition:
              $ref: "#/components/headers/Content-Disposition"
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/pdf:
              schema:
                type: string
                contentMediaType: application/pdf
            application/zip:
              schema:
                type: string
                contentMediaType: application/zip
        "204":
          $ref: "#/components/responses/Webhook"
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /forms/pdf/validate:
    post:
      operationId: pdfValidate
      summary: Validate a PDF
      description: Checks PDFs against PDF/A, PDF/UA or Factur-X, and lists the violations.
      tags:
        - "PDF: Conformance"
      externalDocs:
        url: https://gotenberg.dev/docs/pdf/validate
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: The PDFs.
                password:
                  type: string
                  description: Opens encrypted PDFs. A wrong one answers 400, and so does a missing one when the PDF has a user password.
                profile:
                  type: string
                  description: "The standard to check against: `PDF/A-1a`, `PDF/A-1b`, `PDF/A-2a`, `PDF/A-2b`, `PDF/A-2u`, `PDF/A-3a`, `PDF/A-3b`, `PDF/A-3u`, `PDF/A-4`, `PDF/A-4e`, `PDF/A-4f`, `PDF/UA-1`, `PDF/UA-2` or `Factur-X`. A JSON array, or the field repeated, checks a PDF/A profile and a PDF/UA one together, as `remediate` pairs them."
                archives:
                  type: array
                  items:
                    type: string
                    contentMediaType: application/octet-stream
                  description: "ZIP files Gotenberg unpacks: each entry counts as a file uploaded under `files`."
                downloadFrom:
                  type: string
                  contentMediaType: application/json
                  description: URLs Gotenberg downloads first, as if you had uploaded the files. Each entry takes a `url`, and optionally `extraHttpHeaders` and `filename`.
              required:
                - files
                - profile
      responses:
        "200":
          description: JSON, one entry per PDF under its file name.
          headers:
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/json:
              schema:
                type: object
        "400":
          $ref: "#/components/responses/Status400"
        "401":
          $ref: "#/components/responses/Status401"
        "403":
          $ref: "#/components/responses/Status403"
        "413":
          $ref: "#/components/responses/Status413"
        "415":
          $ref: "#/components/responses/Status415"
        "500":
          $ref: "#/components/responses/Status500"
        "503":
          $ref: "#/components/responses/Status503"
  /health:
    get:
      operationId: health
      summary: Health
      description: Reports whether Gotenberg and its engines are up.
      tags:
        - System
      externalDocs:
        url: https://gotenberg.dev/docs/system/health
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      responses:
        "200":
          description: JSON, whose `status` is `up`, or `down` with a 503 when an engine is down. `HEAD` answers the status alone.
          headers:
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/json:
              schema:
                type: object
    head:
      operationId: healthHead
      summary: Health
      description: Reports whether Gotenberg and its engines are up.
      tags:
        - System
      externalDocs:
        url: https://gotenberg.dev/docs/system/health
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      responses:
        "200":
          description: JSON, whose `status` is `up`, or `down` with a 503 when an engine is down. `HEAD` answers the status alone.
          headers:
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            application/json:
              schema:
                type: object
  /version:
    get:
      operationId: version
      summary: Version
      description: Answers the version of Gotenberg.
      tags:
        - System
      externalDocs:
        url: https://gotenberg.dev/docs/system/version
      parameters:
        - $ref: "#/components/parameters/Gotenberg-Trace"
        - $ref: "#/components/parameters/traceparent"
        - $ref: "#/components/parameters/baggage"
      responses:
        "200":
          description: The version of Gotenberg, as plain text.
          headers:
            Gotenberg-Trace:
              $ref: "#/components/headers/Gotenberg-Trace"
            Gotenberg-Version:
              $ref: "#/components/headers/Gotenberg-Version"
          content:
            text/plain:
              schema:
                type: string
        "401":
          $ref: "#/components/responses/Status401"
components:
  parameters:
    Gotenberg-Output-Filename:
      name: Gotenberg-Output-Filename
      in: header
      required: false
      schema:
        type: string
      description: "Names the result, without extension: Gotenberg adds the right one, even to a name that has one, so `report.pdf` gives `report.pdf.pdf`."
    Gotenberg-Trace:
      name: Gotenberg-Trace
      in: header
      required: false
      schema:
        type: string
      description: Your identifier for the request. Gotenberg logs it and sends it back; it makes one up when you don't. `--api-correlation-id-header` renames the header.
    Gotenberg-Webhook-Url:
      name: Gotenberg-Webhook-Url
      in: header
      required: false
      schema:
        type: string
      description: Uploads the result to this URL, an absolute `http` or `https` one, instead of answering with it. Gotenberg answers `204 No Content` right away.
    Gotenberg-Webhook-Method:
      name: Gotenberg-Webhook-Method
      in: header
      required: false
      schema:
        type: string
      description: "The method of the upload: `POST`, the default, `PUT` or `PATCH`."
    Gotenberg-Webhook-Events-Url:
      name: Gotenberg-Webhook-Events-Url
      in: header
      required: false
      schema:
        type: string
      description: "An absolute `http` or `https` URL. Required with `Gotenberg-Webhook-Url`, and the other way round: one without the other answers 400. Receives a `webhook.success` or `webhook.error` event once the work is done."
    Gotenberg-Webhook-Extra-Http-Headers:
      name: Gotenberg-Webhook-Extra-Http-Headers
      in: header
      required: false
      schema:
        type: string
      description: 'A JSON object of headers to send with the upload and the event, such as `{"Authorization": "Bearer …"}`.'
    traceparent:
      name: traceparent
      in: header
      required: false
      schema:
        type: string
      description: "W3C Trace Context and Baggage: Gotenberg continues your trace. `OTEL_PROPAGATORS` picks other formats."
    baggage:
      name: baggage
      in: header
      required: false
      schema:
        type: string
      description: "W3C Trace Context and Baggage: Gotenberg continues your trace. `OTEL_PROPAGATORS` picks other formats."
  headers:
    Content-Disposition:
      description: "`attachment` and the file name. A name with characters outside ASCII also carries `filename*=UTF-8''…`, and an ASCII `filename` as a fallback."
      schema:
        type: string
    Gotenberg-Trace:
      description: Your identifier, or the one Gotenberg made up.
      schema:
        type: string
    Gotenberg-Version:
      description: The version of Gotenberg that answered. With [authentication](https://gotenberg.dev/docs/configuration#api-enable-basic-auth) on, the 401, 404 and 405 answers leave it out, so a caller without credentials learns no version.
      schema:
        type: string
    Gotenberg-Remediation-Residual:
      description: "After a `remediate` stage: the violations left, summed over the documents and the profiles. `0` means every document conforms to every profile."
      schema:
        type: string
    Gotenberg-Remediation-Rolled-Back:
      description: "After a `remediate` stage: the fixes Gotenberg undid because they lost pages, text or images. They stay undone with `aggressive` too."
      schema:
        type: string
  responses:
    Webhook:
      description: Uploads the result to this URL, an absolute `http` or `https` one, instead of answering with it. Gotenberg answers `204 No Content` right away.
    Status400:
      description: A form field, a stage or a header is missing or invalid, or a stage failed on a file. The message names it.
      content:
        text/plain:
          schema:
            type: string
    Status401:
      description: The credentials are missing or wrong, with [authentication](https://gotenberg.dev/docs/configuration#api-enable-basic-auth) on.
      content:
        text/plain:
          schema:
            type: string
    Status403:
      description: "The outbound URL filtering blocks a URL: the page Chromium loads, a `downloadFrom` file, a webhook or a timestamp authority. The message stays generic; Gotenberg's logs say why. A host that doesn't resolve answers 400 instead, naming it, except a timestamp authority's."
      content:
        text/plain:
          schema:
            type: string
    Status409:
      description: The page Chromium loaded answered an error status, 4xx or 5xx by default, or failed another [`failOn` check](https://gotenberg.dev/docs/chromium/convert-url#fail-on-errors).
      content:
        text/plain:
          schema:
            type: string
    Status413:
      description: The request is larger than [`--api-body-limit`](https://gotenberg.dev/docs/configuration#api-body-limit) allows.
      content:
        text/plain:
          schema:
            type: string
    Status415:
      description: The request isn't `multipart/form-data`.
      content:
        text/plain:
          schema:
            type: string
    Status422:
      description: "LibreOffice went past [`--libreoffice-max-memory`](https://gotenberg.dev/docs/configuration#libreoffice-max-memory) converting the document. The same document goes past it again: reduce it, or raise the limit."
      content:
        text/plain:
          schema:
            type: string
    Status429:
      description: "The Chromium or LibreOffice queue is full: see [`--chromium-max-queue-size`](https://gotenberg.dev/docs/configuration#chromium-max-queue-size). Retry shortly."
      content:
        text/plain:
          schema:
            type: string
    Status503:
      description: The request took longer than [`--api-timeout`](https://gotenberg.dev/docs/configuration#api-timeout), 30 seconds by default, a Chromium wait included, or Chromium crashed or went past [`--chromium-max-memory`](https://gotenberg.dev/docs/configuration#chromium-max-memory). Retry.
      content:
        text/plain:
          schema:
            type: string
    Status500:
      description: Something else failed, such as an engine crash. Look the request's `Gotenberg-Trace` up in Gotenberg's logs.
      content:
        text/plain:
          schema:
            type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: Basic credentials or an OIDC bearer token, when `--api-enable-basic-auth` or `--api-enable-oidc-auth` is on.
    bearerAuth:
      type: http
      scheme: bearer
      description: Basic credentials or an OIDC bearer token, when `--api-enable-basic-auth` or `--api-enable-oidc-auth` is on.
