Gotenberg API

openapi: 3.1.0
info:
  title: Gotenberg API
  version: '2026-10-27'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-27: 3 operation(s) read from 5 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Gotenberg has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 2
    documentation: 1
    pages-with-code: 5
    pages-read: 5
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-27'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://gotenberg.dev/docs/webhook-download
  - https://gotenberg.dev/docs/getting-started/installation
  - https://gotenberg.dev/docs/getting-started/introduction
  - https://gotenberg.dev/docs/convert-with-chromium/convert-url-to-pdf
  - https://gotenberg.dev/docs/convert-with-chromium/convert-html-to-pdf
servers:
- url: https://demo.gotenberg.dev
paths:
  /forms:
    post:
      operationId: post_forms
      tags:
      - Forms
      summary: Webhook & Download
      x-source: https://gotenberg.dev/docs/webhook-download
      parameters:
      - name: Gotenberg-Webhook-Url
        in: header
        required: true
        schema:
          type: string
        description: The callback URL where the successful result will be sent via POST (default).
      - name: Gotenberg-Webhook-Error-Url
        in: header
        required: false
        schema:
          type: string
        description: Deprecated. Use Gotenberg-Webhook-Events-Url instead.
      - name: Gotenberg-Webhook-Method
        in: header
        required: false
        schema:
          type: string
        description: The HTTP method to use for the success callback (POST, PUT, PATCH).
      - name: Gotenberg-Webhook-Error-Method
        in: header
        required: false
        schema:
          type: string
        description: The HTTP method to use for the error callback.
      - name: Gotenberg-Webhook-Extra-Http-Headers
        in: header
        required: false
        schema:
          type: string
        description: JSON object containing extra headers to send to the callback URLs.
      - name: Gotenberg-Webhook-Events-Url
        in: header
        required: false
        schema:
          type: string
        description: A URL to receive structured JSON events after each webhook operation.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostFormsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostFormsResponse'
      x-evidence:
        kind: documentation
  /forms/chromium/convert/html:
    post:
      operationId: post_forms_chromium_convert_html
      tags:
      - Forms
      summary: POST /forms/chromium/convert/html
      x-source: https://gotenberg.dev/docs/convert-with-chromium/convert-html-to-pdf
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl curl \ --request POST http://localhost:3000/forms/chromium/convert/html \ --form files = @/path/to/index.html \ -o my.pdf
          Responses 200 400 503 The PDF file has been successfully created. Content-Disposition : attachment; filename= { output-filename.pdf
          } Content-Type : {content-type} Content-Length : {content-length} Gotenberg-Trace : {trace} Body : {output-file} The request had one
          or more '
  /forms/chromium/convert/url:
    post:
      operationId: post_forms_chromium_convert_url
      tags:
      - Forms
      summary: POST /forms/chromium/convert/url
      x-source: https://gotenberg.dev/docs/webhook-download
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl curl \ --request POST http://localhost:3000/forms/chromium/convert/url \ --header ''Gotenberg-Webhook-Url: https://my.webhook/success''
          \ --header ''Gotenberg-Webhook-Events-Url: https://my.webhook/events'' \ --header ''Gotenberg-Webhook-Extra-Http-Headers: {"Authorization":
          "Bearer 123"}'' \ --form url = https://my.url Responses 204 400 403 Success Error The request is being processed asynchronous'
components:
  schemas:
    PostFormsRequest:
      type: object
      properties:
        downloadFrom:
          type: string
          description: A JSON array of files to fetch remotely.
    PostFormsResponse:
      type: object
      properties:
        '204':
          type: string
          description: The request is being processed asynchronously.
        '400':
          type: string
          description: At least one header is invalid or missing, or a URL is forbidden.
        '403':
          type: string
          description: At least one of the specified URLs is forbidden.
tags:
- name: Forms