{
  "components": {
    "responses": {
      "Error": {
        "content": {
          "application/json": {
            "schema": {
              "properties": {
                "error": {
                  "properties": {
                    "code": {
                      "type": "string"
                    },
                    "message": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "code",
                    "message"
                  ],
                  "type": "object"
                }
              },
              "required": [
                "error"
              ],
              "type": "object"
            }
          }
        },
        "description": "The call failed; the body names the cause"
      }
    }
  },
  "info": {
    "description": "Coming soon. The hosted API is not live yet, and this contract describes the planned service as of 16 November 2026. No document is stored. A result you opt into with `output=url` is held for 15 minutes, then deleted.",
    "title": "PDFluent API",
    "version": "4",
    "x-pdfluent-status": {
      "state": "coming-soon",
      "as_of": "2026-11-16",
      "claims": [
        "B118",
        "B119",
        "B122"
      ]
    }
  },
  "openapi": "3.1.0",
  "paths": {
    "/health": {
      "get": {
        "operationId": "health",
        "responses": {
          "200": {
            "description": "Alive"
          }
        },
        "summary": "Liveness"
      }
    },
    "/v1/compat/unstructured/general": {
      "post": {
        "operationId": "compat_unstructured_general",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "description": "Options. They are the form fields of the Unstructured request, so this struct tolerates fields\nit does not know: a client written for that API keeps working.",
                      "properties": {
                        "chunking_strategy": {
                          "default": null,
                          "description": "`basic`, `by_title` or `by_page`. Without it the elements are returned unchunked.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "combine_text_under_n_chars": {
                          "default": null,
                          "description": "Merge sections shorter than this with the next one. Default 0.",
                          "format": "uint",
                          "minimum": 0,
                          "type": [
                            "integer",
                            "null"
                          ]
                        },
                        "coordinates": {
                          "default": null,
                          "description": "Add `metadata.coordinates`. Default false.",
                          "type": [
                            "boolean",
                            "null"
                          ]
                        },
                        "filename": {
                          "default": null,
                          "description": "Name of the uploaded file, put in `metadata.filename`. The service fills it from the\nupload; a client may also send it.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "include_orig_elements": {
                          "default": null,
                          "description": "Accepted and ignored: original elements are not attached to chunks.",
                          "type": [
                            "boolean",
                            "null"
                          ]
                        },
                        "include_page_breaks": {
                          "default": null,
                          "description": "Add a `PageBreak` element between pages. Default false.",
                          "type": [
                            "boolean",
                            "null"
                          ]
                        },
                        "languages": {
                          "default": null,
                          "description": "Accepted; elements carry the language the engine detected.",
                          "items": {
                            "type": "string"
                          },
                          "type": [
                            "array",
                            "null"
                          ]
                        },
                        "max_characters": {
                          "default": null,
                          "description": "Hard chunk budget in characters. Default 500.",
                          "format": "uint",
                          "minimum": 0,
                          "type": [
                            "integer",
                            "null"
                          ]
                        },
                        "multipage_sections": {
                          "default": null,
                          "description": "Let `by_title` sections run across pages. Default true.",
                          "type": [
                            "boolean",
                            "null"
                          ]
                        },
                        "new_after_n_chars": {
                          "default": null,
                          "description": "Soft chunk budget in characters. Default: `max_characters`.",
                          "format": "uint",
                          "minimum": 0,
                          "type": [
                            "integer",
                            "null"
                          ]
                        },
                        "output_format": {
                          "default": null,
                          "description": "`application/json` (default). `text/csv` is refused.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "overlap": {
                          "default": null,
                          "description": "Characters shared between pieces of one long element. Default 0.",
                          "format": "uint",
                          "minimum": 0,
                          "type": [
                            "integer",
                            "null"
                          ]
                        },
                        "password": {
                          "default": null,
                          "description": "Password of an encrypted document.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "pdf_infer_table_structure": {
                          "default": null,
                          "description": "Keep `metadata.text_as_html` on tables. Default true.",
                          "type": [
                            "boolean",
                            "null"
                          ]
                        },
                        "starting_page_number": {
                          "default": null,
                          "description": "Number of the first page in `metadata.page_number`. Default 1.",
                          "format": "uint",
                          "minimum": 0,
                          "type": [
                            "integer",
                            "null"
                          ]
                        },
                        "strategy": {
                          "default": null,
                          "description": "`auto` (default), `fast`, `hi_res`. `ocr_only` and `vlm` are refused.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Partition a PDF into elements in the response shape of the Unstructured general endpoint"
      }
    },
    "/v1/convert/email": {
      "post": {
        "operationId": "convert_email",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/convert/email`. The message itself is the single `file`.",
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/pdf": {
                "schema": {
                  "format": "binary",
                  "type": "string"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Render an .eml email to a PDF: headers, body, inline images and an attachment list (hosted integration)",
        "x-pdfluent-credits": {
          "credits": 1,
          "kind": "per_page",
          "min": 1,
          "per_pages": 1
        },
        "x-pdfluent-credits-claim": "B119"
      }
    },
    "/v1/convert/html": {
      "post": {
        "operationId": "convert_html",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/convert/html`.",
                      "properties": {
                        "html": {
                          "description": "The HTML document. Up to a size limit. Scripts run; the page can load public http and https\nresources, and nothing else.",
                          "type": "string"
                        }
                      },
                      "required": [
                        "html"
                      ],
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/pdf": {
                "schema": {
                  "format": "binary",
                  "type": "string"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Render an HTML document to a PDF with a headless browser (hosted integration)",
        "x-pdfluent-credits": {
          "credits": 1,
          "kind": "per_page",
          "min": 1,
          "per_pages": 1
        },
        "x-pdfluent-credits-claim": "B119"
      }
    },
    "/v1/convert/template": {
      "post": {
        "operationId": "convert_template",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/convert/template`.",
                      "properties": {
                        "data": {
                          "default": null,
                          "description": "The data the template reads, a JSON object or array. Up to a size limit."
                        },
                        "template": {
                          "description": "The template: HTML with `{{name}}` values (always HTML-escaped), `{{#list}}..{{/list}}`\nloops and sections, `{{^x}}..{{/x}}` inverted sections and `{{! comments }}`. There is no\ncode, no raw output and no includes.",
                          "type": "string"
                        }
                      },
                      "required": [
                        "template"
                      ],
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/pdf": {
                "schema": {
                  "format": "binary",
                  "type": "string"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Fill an HTML template with JSON data and render it to a PDF (logic-less templates, hosted integration)",
        "x-pdfluent-credits": {
          "credits": 1,
          "kind": "per_page",
          "min": 1,
          "per_pages": 1
        },
        "x-pdfluent-credits-claim": "B119"
      }
    },
    "/v1/convert/to-images": {
      "post": {
        "operationId": "convert_to_images",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/convert/to-images`.",
                      "properties": {
                        "dpi": {
                          "default": 150,
                          "description": "Resolution, 36 to 300. Default 150.",
                          "format": "uint32",
                          "minimum": 0,
                          "type": "integer"
                        },
                        "format": {
                          "description": "Image format. Default `png`.",
                          "oneOf": [
                            {
                              "const": "png",
                              "description": "PNG. The default.",
                              "type": "string"
                            },
                            {
                              "const": "jpeg",
                              "description": "JPEG.",
                              "type": "string"
                            }
                          ]
                        },
                        "pages": {
                          "default": null,
                          "description": "One-based pages. Default: all pages.",
                          "items": {
                            "format": "uint",
                            "minimum": 0,
                            "type": "integer"
                          },
                          "type": [
                            "array",
                            "null"
                          ]
                        },
                        "password": {
                          "default": null,
                          "description": "Password of an encrypted document.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/zip": {
                "schema": {
                  "format": "binary",
                  "type": "string"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Render pages to PNG or JPEG images, returned as a zip",
        "x-pdfluent-credits": {
          "credits": 1,
          "kind": "per_page",
          "min": 1,
          "per_pages": 1
        },
        "x-pdfluent-credits-claim": "B119"
      }
    },
    "/v1/convert/to-pptx": {
      "post": {
        "operationId": "convert_to_pptx",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/convert/to-xlsx` and `/v1/convert/to-pptx`.",
                      "properties": {
                        "password": {
                          "default": null,
                          "description": "Password of an encrypted document.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/vnd.openxmlformats-officedocument.presentationml.presentation": {
                "schema": {
                  "format": "binary",
                  "type": "string"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Convert a PDF to a PowerPoint presentation",
        "x-pdfluent-credits": {
          "credits": 1,
          "kind": "per_page",
          "min": 1,
          "per_pages": 1
        },
        "x-pdfluent-credits-claim": "B119"
      }
    },
    "/v1/convert/to-xlsx": {
      "post": {
        "operationId": "convert_to_xlsx",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/convert/to-xlsx` and `/v1/convert/to-pptx`.",
                      "properties": {
                        "password": {
                          "default": null,
                          "description": "Password of an encrypted document.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {
                "schema": {
                  "format": "binary",
                  "type": "string"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Convert a PDF to an Excel workbook",
        "x-pdfluent-credits": {
          "credits": 1,
          "kind": "per_page",
          "min": 1,
          "per_pages": 1
        },
        "x-pdfluent-credits-claim": "B119"
      }
    },
    "/v1/convert/url": {
      "post": {
        "operationId": "convert_url",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/convert/url`.",
                      "properties": {
                        "url": {
                          "description": "A public http or https URL (ports 80 and 443), with no credentials in it. Private,\nloopback, link-local and metadata addresses are refused before the page is requested, and\nagain through redirects and sub-resources.",
                          "type": "string"
                        }
                      },
                      "required": [
                        "url"
                      ],
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/pdf": {
                "schema": {
                  "format": "binary",
                  "type": "string"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Render a public web page to a PDF (hosted integration; private addresses are refused)",
        "x-pdfluent-credits": {
          "credits": 1,
          "kind": "per_page",
          "min": 1,
          "per_pages": 1
        },
        "x-pdfluent-credits-claim": "B119"
      }
    },
    "/v1/extract/chunks": {
      "post": {
        "operationId": "extract_chunks",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/extract/chunks`.",
                      "properties": {
                        "chunking_strategy": {
                          "description": "How chunks are formed. Default `structure`.",
                          "oneOf": [
                            {
                              "const": "structure",
                              "description": "The engine's structure-aware chunker: headings, lists and tables drive the splits. The\ndefault, and what this operation did before the strategies below existed.",
                              "type": "string"
                            },
                            {
                              "const": "basic",
                              "description": "Pack elements in reading order up to the budget. Tables stand alone.",
                              "type": "string"
                            },
                            {
                              "const": "by_title",
                              "description": "A new chunk starts at every title; small sections can be combined.",
                              "type": "string"
                            },
                            {
                              "const": "by_page",
                              "description": "A new chunk starts at every page.",
                              "type": "string"
                            }
                          ]
                        },
                        "combine_text_under_n_chars": {
                          "default": 0,
                          "description": "`by_title` and `by_page`: merge sections shorter than this with the next one, within\n`max_characters`. Default 0 (off).",
                          "format": "uint",
                          "minimum": 0,
                          "type": "integer"
                        },
                        "max_characters": {
                          "default": 1500,
                          "description": "Most Unicode characters in a chunk. Default 1500.",
                          "format": "uint",
                          "minimum": 0,
                          "type": "integer"
                        },
                        "multipage_sections": {
                          "default": true,
                          "description": "`by_title`: let a section run across a page boundary. Default true.",
                          "type": "boolean"
                        },
                        "new_after_n_chars": {
                          "default": null,
                          "description": "Close a chunk once it has this many characters (`basic`, `by_title`, `by_page`).\nDefault: `max_characters`.",
                          "format": "uint",
                          "minimum": 0,
                          "type": [
                            "integer",
                            "null"
                          ]
                        },
                        "overlap": {
                          "default": 100,
                          "description": "Characters shared between neighbouring chunks of one split element. Default 100.",
                          "format": "uint",
                          "minimum": 0,
                          "type": "integer"
                        },
                        "pages": {
                          "default": null,
                          "description": "One-based pages. Default: all pages.",
                          "items": {
                            "format": "uint",
                            "minimum": 0,
                            "type": "integer"
                          },
                          "type": [
                            "array",
                            "null"
                          ]
                        },
                        "password": {
                          "default": null,
                          "description": "Password of an encrypted document.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "quality": {
                          "description": "Extraction quality tier. Default `fast`.",
                          "oneOf": [
                            {
                              "const": "fast",
                              "description": "Geometric extraction, no model, no OCR. The default.",
                              "type": "string"
                            },
                            {
                              "const": "auto",
                              "description": "`fast` plus OCR of scanned pages. Answers `quality_unavailable` (501) on a deployment\nwithout an OCR engine; it never reads `fast` in its place.",
                              "type": "string"
                            }
                          ]
                        }
                      },
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Split a PDF into structure-aware chunks for retrieval, with stable ids",
        "x-pdfluent-credits": {
          "credits": 3,
          "kind": "per_page",
          "min": 1,
          "per_pages": 1
        },
        "x-pdfluent-credits-claim": "B118"
      }
    },
    "/v1/extract/embeddings": {
      "post": {
        "operationId": "extract_embeddings",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/extract/embeddings`.",
                      "properties": {
                        "chunking_strategy": {
                          "description": "How chunks are formed. Default `structure`.",
                          "oneOf": [
                            {
                              "const": "structure",
                              "description": "The engine's structure-aware chunker: headings, lists and tables drive the splits. The\ndefault, and what this operation did before the strategies below existed.",
                              "type": "string"
                            },
                            {
                              "const": "basic",
                              "description": "Pack elements in reading order up to the budget. Tables stand alone.",
                              "type": "string"
                            },
                            {
                              "const": "by_title",
                              "description": "A new chunk starts at every title; small sections can be combined.",
                              "type": "string"
                            },
                            {
                              "const": "by_page",
                              "description": "A new chunk starts at every page.",
                              "type": "string"
                            }
                          ]
                        },
                        "combine_text_under_n_chars": {
                          "default": 0,
                          "description": "Merge sections shorter than this with the next one.",
                          "format": "uint",
                          "minimum": 0,
                          "type": "integer"
                        },
                        "max_characters": {
                          "default": 1000,
                          "description": "Most Unicode characters in a chunk. Default 1000.",
                          "format": "uint",
                          "minimum": 0,
                          "type": "integer"
                        },
                        "model": {
                          "default": null,
                          "description": "The model. In `eu`: `mistral-embed` (default), `gemini-embedding-2` or `codestral-embed`. In\n`global`: an id of OpenRouter's embeddings catalogue, for example `baai/bge-m3`; an unknown\nid is refused. With your own provider key (BYOK) the model is required and is passed on as\ngiven. The answer always names the model id used.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "multipage_sections": {
                          "default": true,
                          "description": "`by_title`: let a section run across a page boundary. Default true.",
                          "type": "boolean"
                        },
                        "new_after_n_chars": {
                          "default": null,
                          "description": "Close a chunk once it has this many characters.",
                          "format": "uint",
                          "minimum": 0,
                          "type": [
                            "integer",
                            "null"
                          ]
                        },
                        "overlap": {
                          "default": 100,
                          "description": "Characters shared between neighbouring pieces of one split element. Default 100.",
                          "format": "uint",
                          "minimum": 0,
                          "type": "integer"
                        },
                        "pages": {
                          "default": null,
                          "description": "One-based pages. Default: all pages.",
                          "items": {
                            "format": "uint",
                            "minimum": 0,
                            "type": "integer"
                          },
                          "type": [
                            "array",
                            "null"
                          ]
                        },
                        "password": {
                          "default": null,
                          "description": "Password of an encrypted document.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "quality": {
                          "description": "Extraction quality tier. Default `fast`.",
                          "oneOf": [
                            {
                              "const": "fast",
                              "description": "Geometric extraction, no model, no OCR. The default.",
                              "type": "string"
                            },
                            {
                              "const": "auto",
                              "description": "`fast` plus OCR of scanned pages. Answers `quality_unavailable` (501) on a deployment\nwithout an OCR engine; it never reads `fast` in its place.",
                              "type": "string"
                            }
                          ]
                        },
                        "region": {
                          "description": "Where the embedding runs. Default `eu`.",
                          "oneOf": [
                            {
                              "const": "eu",
                              "description": "OpenRouter's EU endpoint. Allows `mistral-embed` (default), `gemini-embedding-2` and\n`codestral-embed` only. The default.",
                              "type": "string"
                            },
                            {
                              "const": "global",
                              "description": "An explicit opt-in to OpenRouter's whole embeddings catalogue, by OpenRouter model id. The\ndata leaves the EU; the answer says so in `data_left_eu` and in a header.",
                              "type": "string"
                            }
                          ]
                        }
                      },
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Split a PDF into chunks and embed each one through OpenRouter (EU region and mistral-embed by default), for retrieval",
        "x-pdfluent-credits": {
          "credits": 3,
          "kind": "per_page_reserving",
          "min": 1,
          "per_pages": 1
        },
        "x-pdfluent-credits-claim": "B118"
      }
    },
    "/v1/extract/images": {
      "post": {
        "operationId": "extract_images",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/extract/images`.",
                      "properties": {
                        "pages": {
                          "default": null,
                          "description": "One-based pages. Default: all pages.",
                          "items": {
                            "format": "uint",
                            "minimum": 0,
                            "type": "integer"
                          },
                          "type": [
                            "array",
                            "null"
                          ]
                        },
                        "password": {
                          "default": null,
                          "description": "Password of an encrypted document.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/zip": {
                "schema": {
                  "format": "binary",
                  "type": "string"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Extract the images of a PDF as a zip with a manifest"
      }
    },
    "/v1/extract/markdown": {
      "post": {
        "operationId": "extract_markdown",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/extract/markdown`.",
                      "properties": {
                        "keep_furniture": {
                          "default": false,
                          "description": "Write running headers and footers into the markdown. Default false.",
                          "type": "boolean"
                        },
                        "pages": {
                          "default": null,
                          "description": "One-based pages. Default: all pages.",
                          "items": {
                            "format": "uint",
                            "minimum": 0,
                            "type": "integer"
                          },
                          "type": [
                            "array",
                            "null"
                          ]
                        },
                        "password": {
                          "default": null,
                          "description": "Password of an encrypted document.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "quality": {
                          "description": "Extraction quality tier. Default `fast`.",
                          "oneOf": [
                            {
                              "const": "fast",
                              "description": "Geometric extraction, no model. The default.",
                              "type": "string"
                            },
                            {
                              "const": "balanced",
                              "description": "The layout-model tier. Answers `quality_unavailable` (501) on a deployment without the\nlayout model.",
                              "type": "string"
                            },
                            {
                              "const": "auto",
                              "description": "Reads with the layout and table models and OCR of scanned\npages. Answers `quality_unavailable` (501) when any of them is missing; it never reads\n`fast` in its place.",
                              "type": "string"
                            }
                          ]
                        }
                      },
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "text/markdown": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Convert a PDF to markdown in reading order",
        "x-pdfluent-credits": {
          "credits": 3,
          "kind": "per_page",
          "min": 1,
          "per_pages": 1
        },
        "x-pdfluent-credits-claim": "B118"
      }
    },
    "/v1/extract/schema": {
      "post": {
        "operationId": "extract_schema",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/extract/schema`.",
                      "properties": {
                        "instructions": {
                          "default": null,
                          "description": "Extra guidance for the model, such as a date format or a currency. a limit.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "model": {
                          "default": null,
                          "description": "The model id. Only with your own model key (`x-byok-model-key`); our route runs\n`gemini-2.5-flash-lite` and refuses any other id.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "pages": {
                          "default": null,
                          "description": "One-based pages. Default: all pages.",
                          "items": {
                            "format": "uint",
                            "minimum": 0,
                            "type": "integer"
                          },
                          "type": [
                            "array",
                            "null"
                          ]
                        },
                        "password": {
                          "default": null,
                          "description": "Password of an encrypted document.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "quality": {
                          "description": "How the text is read before the model sees it. Default `fast`.",
                          "oneOf": [
                            {
                              "const": "fast",
                              "description": "Geometric extraction, no model, no OCR. The default.",
                              "type": "string"
                            },
                            {
                              "const": "auto",
                              "description": "`fast` plus OCR of scanned pages. Answers `quality_unavailable` (501) on a deployment\nwithout an OCR engine; it never reads `fast` in its place.",
                              "type": "string"
                            }
                          ]
                        },
                        "schema": {
                          "description": "The JSON Schema to fill: an object schema, a limit KB. The answer is validated against\nit; a field the document does not state is left out rather than invented."
                        }
                      },
                      "required": [
                        "schema"
                      ],
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Fill a JSON Schema you supply from a PDF with a language model, validated against the schema",
        "x-pdfluent-credits": {
          "credits": 3,
          "kind": "per_page_reserving",
          "min": 1,
          "per_pages": 1
        },
        "x-pdfluent-credits-claim": "B118"
      }
    },
    "/v1/extract/tables": {
      "post": {
        "operationId": "extract_tables",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/extract/tables`.",
                      "properties": {
                        "max_figures_per_page": {
                          "default": null,
                          "description": "`max` only: most tables described per page, 1 to 6. Default 2; each one above two costs 1\nmore credit.",
                          "format": "uint",
                          "minimum": 0,
                          "type": [
                            "integer",
                            "null"
                          ]
                        },
                        "pages": {
                          "default": null,
                          "description": "One-based pages. Default: all pages.",
                          "items": {
                            "format": "uint",
                            "minimum": 0,
                            "type": "integer"
                          },
                          "type": [
                            "array",
                            "null"
                          ]
                        },
                        "password": {
                          "default": null,
                          "description": "Password of an encrypted document.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "quality": {
                          "description": "Extraction quality tier. Default `fast`. `max` also describes every table with a model\n(up to two per page included in the price), in `description` on each table.",
                          "oneOf": [
                            {
                              "const": "fast",
                              "description": "Geometric extraction, no model, no OCR. The default.",
                              "type": "string"
                            },
                            {
                              "const": "auto",
                              "description": "`fast` plus OCR of scanned pages. Answers `quality_unavailable` (501) on a deployment\nwithout an OCR engine.",
                              "type": "string"
                            },
                            {
                              "const": "max",
                              "description": "The full reading the engine gives, plus a short model description of every figure and\ntable (up to two per page are included in the price). Not part of the trial. With your own\nmodel key (`x-byok-model-key`) only the processing credits are charged: 3 a page, no Max\nuplift and no extra-figure charge.",
                              "type": "string"
                            }
                          ]
                        }
                      },
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Extract the tables of a PDF with their rows",
        "x-pdfluent-credits": {
          "credits": 3,
          "kind": "per_page_reserving",
          "min": 1,
          "per_pages": 1
        },
        "x-pdfluent-credits-claim": "B118"
      }
    },
    "/v1/extract/text": {
      "post": {
        "operationId": "extract_text",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/extract/text`.",
                      "properties": {
                        "pages": {
                          "default": null,
                          "description": "One-based pages. Default: all pages.",
                          "items": {
                            "format": "uint",
                            "minimum": 0,
                            "type": "integer"
                          },
                          "type": [
                            "array",
                            "null"
                          ]
                        },
                        "password": {
                          "default": null,
                          "description": "Password of an encrypted document.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Extract the plain text of a PDF, pages separated by a form feed"
      }
    },
    "/v1/forms/export": {
      "post": {
        "operationId": "forms_export",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/forms/export`.",
                      "properties": {
                        "format": {
                          "description": "Output format. Default `xfdf`.",
                          "oneOf": [
                            {
                              "const": "fdf",
                              "description": "Forms Data Format.",
                              "type": "string"
                            },
                            {
                              "const": "xfdf",
                              "description": "XML Forms Data Format. The default.",
                              "type": "string"
                            },
                            {
                              "const": "xml",
                              "description": "Plain XML.",
                              "type": "string"
                            }
                          ]
                        },
                        "password": {
                          "default": null,
                          "description": "Password of an encrypted document.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/octet-stream": {
                "schema": {
                  "format": "binary",
                  "type": "string"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Export the form data as FDF, XFDF or XML"
      }
    },
    "/v1/forms/fields": {
      "post": {
        "operationId": "forms_fields",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/forms/fields`.",
                      "properties": {
                        "password": {
                          "default": null,
                          "description": "Password of an encrypted document.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "List the form fields of a PDF with type and value"
      }
    },
    "/v1/forms/fill": {
      "post": {
        "operationId": "forms_fill",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/forms/fill`.",
                      "properties": {
                        "flatten": {
                          "default": false,
                          "description": "Flatten the form after filling. Default false.",
                          "type": "boolean"
                        },
                        "password": {
                          "default": null,
                          "description": "Password of an encrypted document.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "values": {
                          "additionalProperties": true,
                          "description": "Field name to value. A string for text, radio and dropdown fields, true or false for check\nboxes, a list of strings for multi-select lists.",
                          "type": "object"
                        }
                      },
                      "required": [
                        "values"
                      ],
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/pdf": {
                "schema": {
                  "format": "binary",
                  "type": "string"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Fill form fields, optionally flattening the form"
      }
    },
    "/v1/forms/import": {
      "post": {
        "operationId": "forms_import",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "items": {
                      "format": "binary",
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/forms/import`.",
                      "properties": {
                        "format": {
                          "description": "Format of the data file. Default `xfdf`.",
                          "oneOf": [
                            {
                              "const": "fdf",
                              "description": "Forms Data Format.",
                              "type": "string"
                            },
                            {
                              "const": "xfdf",
                              "description": "XML Forms Data Format. The default.",
                              "type": "string"
                            },
                            {
                              "const": "xml",
                              "description": "Plain XML.",
                              "type": "string"
                            }
                          ]
                        },
                        "password": {
                          "default": null,
                          "description": "Password of an encrypted document.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/pdf": {
                "schema": {
                  "format": "binary",
                  "type": "string"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Import FDF, XFDF or XML form data into a PDF; the first file is the PDF, the second the data"
      }
    },
    "/v1/forms/xfa/flatten": {
      "post": {
        "operationId": "forms_xfa_flatten",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/forms/xfa/flatten`.",
                      "properties": {
                        "password": {
                          "default": null,
                          "description": "Password of an encrypted document.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/pdf": {
                "schema": {
                  "format": "binary",
                  "type": "string"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Turn an XFA form into a static PDF"
      }
    },
    "/v1/info": {
      "post": {
        "operationId": "info",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/info`.",
                      "properties": {
                        "password": {
                          "default": null,
                          "description": "Password of an encrypted document.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Read page count, PDF version, XFA presence and metadata"
      }
    },
    "/v1/jobs": {
      "post": {
        "operationId": "jobs_create",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "additionalProperties": false,
                "properties": {
                  "inputs": {
                    "items": {
                      "properties": {
                        "url": {
                          "description": "HTTPS URL, port 443, public host",
                          "format": "uri",
                          "type": "string"
                        }
                      },
                      "required": [
                        "url"
                      ],
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "operation": {
                    "description": "Operation id or tool name",
                    "type": "string"
                  },
                  "options": {
                    "description": "The operation's options",
                    "type": "object"
                  },
                  "output_url": {
                    "description": "HTTPS URL that receives the result with PUT",
                    "format": "uri",
                    "type": "string"
                  },
                  "webhook_url": {
                    "description": "Receives the job id and status, never the document",
                    "format": "uri",
                    "type": "string"
                  }
                },
                "required": [
                  "operation",
                  "inputs"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "202": {
            "description": "The job is queued"
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "401": {
            "$ref": "#/components/responses/Error"
          },
          "503": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Run any operation as a job on files named by URL; the result is delivered to `output_url` or held 15 minutes for download"
      }
    },
    "/v1/jobs/{id}": {
      "delete": {
        "operationId": "jobs_delete",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "Deleted"
          },
          "404": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Delete a job and its result now"
      },
      "get": {
        "operationId": "jobs_status",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The job"
          },
          "404": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Status of a job"
      }
    },
    "/v1/jobs/{id}/result": {
      "get": {
        "operationId": "jobs_result",
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The result, in the operation's output type"
          },
          "404": {
            "$ref": "#/components/responses/Error"
          },
          "503": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Download the result, available for 15 minutes after the job finished"
      }
    },
    "/v1/partition": {
      "post": {
        "operationId": "partition",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/partition`.",
                      "properties": {
                        "keep_furniture": {
                          "default": false,
                          "description": "Keep running headers and footers as elements. Default false.",
                          "type": "boolean"
                        },
                        "max_figures_per_page": {
                          "default": null,
                          "description": "`max` only: most figures and tables described per page, 1 to 6. Default 2; each one above\ntwo costs 1 more credit.",
                          "format": "uint",
                          "minimum": 0,
                          "type": [
                            "integer",
                            "null"
                          ]
                        },
                        "pages": {
                          "default": null,
                          "description": "One-based pages to partition. Default: all pages.",
                          "items": {
                            "format": "uint",
                            "minimum": 0,
                            "type": "integer"
                          },
                          "type": [
                            "array",
                            "null"
                          ]
                        },
                        "password": {
                          "default": null,
                          "description": "Password of an encrypted document.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "quality": {
                          "description": "Extraction quality tier. Default `fast`. `max` also describes every figure and table with\na model (up to two per page included in the price), in `description` on each element.",
                          "oneOf": [
                            {
                              "const": "fast",
                              "description": "Geometric extraction, no model, no OCR. The default.",
                              "type": "string"
                            },
                            {
                              "const": "auto",
                              "description": "`fast` plus OCR of scanned pages. Answers `quality_unavailable` (501) on a deployment\nwithout an OCR engine.",
                              "type": "string"
                            },
                            {
                              "const": "max",
                              "description": "The full reading the engine gives, plus a short model description of every figure and\ntable (up to two per page are included in the price). Not part of the trial. With your own\nmodel key (`x-byok-model-key`) only the processing credits are charged: 3 a page, no Max\nuplift and no extra-figure charge.",
                              "type": "string"
                            }
                          ]
                        }
                      },
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Split a PDF into canonical elements (titles, paragraphs, lists, tables, figures) with stable ids",
        "x-pdfluent-credits": {
          "credits": 3,
          "kind": "per_page_reserving",
          "min": 1,
          "per_pages": 1
        },
        "x-pdfluent-credits-claim": "B118"
      }
    },
    "/v1/pdf/compress": {
      "post": {
        "operationId": "pdf_compress",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/pdf/compress`.",
                      "properties": {
                        "password": {
                          "default": null,
                          "description": "Password of an encrypted document.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "preset": {
                          "description": "Compression preset. Default `strict`.",
                          "oneOf": [
                            {
                              "const": "strict",
                              "description": "Every lossless pass. The default.",
                              "type": "string"
                            },
                            {
                              "const": "lossy",
                              "description": "Every pass the strict preset has, plus lossy ones as the SDK adds them.",
                              "type": "string"
                            },
                            {
                              "const": "archival",
                              "description": "Only passes that keep every object a later incremental update could use.",
                              "type": "string"
                            }
                          ]
                        }
                      },
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/pdf": {
                "schema": {
                  "format": "binary",
                  "type": "string"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Make a PDF smaller: subset fonts, compress and deduplicate streams, drop unused objects",
        "x-pdfluent-credits": {
          "credits": 1,
          "kind": "per_page",
          "min": 1,
          "per_pages": 10
        },
        "x-pdfluent-credits-claim": "B119"
      }
    },
    "/v1/pdf/decrypt": {
      "post": {
        "operationId": "pdf_decrypt",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/pdf/decrypt`.",
                      "properties": {
                        "password": {
                          "description": "The document's password.",
                          "type": "string"
                        }
                      },
                      "required": [
                        "password"
                      ],
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/pdf": {
                "schema": {
                  "format": "binary",
                  "type": "string"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Remove the encryption of a PDF",
        "x-pdfluent-credits": {
          "credits": 1,
          "kind": "per_page",
          "min": 1,
          "per_pages": 10
        },
        "x-pdfluent-credits-claim": "B119"
      }
    },
    "/v1/pdf/encrypt": {
      "post": {
        "operationId": "pdf_encrypt",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/pdf/encrypt`.",
                      "properties": {
                        "cipher": {
                          "description": "Cipher. Default `aes256`.",
                          "oneOf": [
                            {
                              "const": "aes256",
                              "description": "AES-256. The default.",
                              "type": "string"
                            },
                            {
                              "const": "aes128",
                              "description": "AES-128.",
                              "type": "string"
                            }
                          ]
                        },
                        "owner_password": {
                          "default": null,
                          "description": "Password that lifts the permissions. Defaults to the user password.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "password": {
                          "default": null,
                          "description": "Password of an encrypted input.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "permissions": {
                          "additionalProperties": false,
                          "description": "Permissions for the user password.",
                          "properties": {
                            "annotate": {
                              "description": "Add or change annotations.",
                              "type": [
                                "boolean",
                                "null"
                              ]
                            },
                            "assemble": {
                              "description": "Insert, delete and rotate pages.",
                              "type": [
                                "boolean",
                                "null"
                              ]
                            },
                            "copy": {
                              "description": "Copy text and images.",
                              "type": [
                                "boolean",
                                "null"
                              ]
                            },
                            "extract_accessibility": {
                              "description": "Extract text for accessibility.",
                              "type": [
                                "boolean",
                                "null"
                              ]
                            },
                            "fill_forms": {
                              "description": "Fill form fields.",
                              "type": [
                                "boolean",
                                "null"
                              ]
                            },
                            "modify": {
                              "description": "Change the document.",
                              "type": [
                                "boolean",
                                "null"
                              ]
                            },
                            "print": {
                              "description": "Print.",
                              "type": [
                                "boolean",
                                "null"
                              ]
                            },
                            "print_high_quality": {
                              "description": "Print at full quality.",
                              "type": [
                                "boolean",
                                "null"
                              ]
                            }
                          },
                          "type": "object"
                        },
                        "user_password": {
                          "default": null,
                          "description": "Password to open the document. Optional when an owner password is given.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/pdf": {
                "schema": {
                  "format": "binary",
                  "type": "string"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Encrypt a PDF with passwords and permissions",
        "x-pdfluent-credits": {
          "credits": 1,
          "kind": "per_page",
          "min": 1,
          "per_pages": 10
        },
        "x-pdfluent-credits-claim": "B119"
      }
    },
    "/v1/pdf/flatten": {
      "post": {
        "operationId": "pdf_flatten",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/pdf/flatten`.",
                      "properties": {
                        "annotations": {
                          "default": true,
                          "description": "Turn annotations into page content. Default true.",
                          "type": "boolean"
                        },
                        "forms": {
                          "default": true,
                          "description": "Turn form fields into page content. Default true.",
                          "type": "boolean"
                        },
                        "password": {
                          "default": null,
                          "description": "Password of an encrypted document.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/pdf": {
                "schema": {
                  "format": "binary",
                  "type": "string"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Turn form fields and annotations into page content",
        "x-pdfluent-credits": {
          "credits": 1,
          "kind": "per_page",
          "min": 1,
          "per_pages": 10
        },
        "x-pdfluent-credits-claim": "B119"
      }
    },
    "/v1/pdf/merge": {
      "post": {
        "operationId": "pdf_merge",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "items": {
                      "format": "binary",
                      "type": "string"
                    },
                    "type": "array"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/pdf/merge`.",
                      "properties": {
                        "bookmarks": {
                          "description": "What to do with bookmarks. Default `concat`.",
                          "oneOf": [
                            {
                              "const": "concat",
                              "description": "One top-level entry per input. The default.",
                              "type": "string"
                            },
                            {
                              "const": "flatten",
                              "description": "All bookmarks in one flat list.",
                              "type": "string"
                            },
                            {
                              "const": "discard",
                              "description": "No bookmarks.",
                              "type": "string"
                            }
                          ]
                        },
                        "password": {
                          "default": null,
                          "description": "Password shared by every encrypted input.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/pdf": {
                "schema": {
                  "format": "binary",
                  "type": "string"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Merge PDFs in the given order",
        "x-pdfluent-credits": {
          "credits": 1,
          "kind": "per_page",
          "min": 1,
          "per_pages": 10
        },
        "x-pdfluent-credits-claim": "B119"
      }
    },
    "/v1/pdf/metadata": {
      "post": {
        "operationId": "pdf_metadata",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/pdf/metadata`.",
                      "properties": {
                        "author": {
                          "default": null,
                          "description": "New author.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "keywords": {
                          "default": null,
                          "description": "New keywords.",
                          "items": {
                            "type": "string"
                          },
                          "type": [
                            "array",
                            "null"
                          ]
                        },
                        "password": {
                          "default": null,
                          "description": "Password of an encrypted document.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "subject": {
                          "default": null,
                          "description": "New subject.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "title": {
                          "default": null,
                          "description": "New title.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/pdf": {
                "schema": {
                  "format": "binary",
                  "type": "string"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Set title, author, subject and keywords",
        "x-pdfluent-credits": {
          "credits": 1,
          "kind": "per_page",
          "min": 1,
          "per_pages": 10
        },
        "x-pdfluent-credits-claim": "B119"
      }
    },
    "/v1/pdf/pages": {
      "post": {
        "operationId": "pdf_pages",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/pdf/pages`.",
                      "properties": {
                        "action": {
                          "description": "What to do.",
                          "oneOf": [
                            {
                              "const": "rotate",
                              "description": "Rotate the listed pages clockwise by `degrees`.",
                              "type": "string"
                            },
                            {
                              "const": "delete",
                              "description": "Remove the listed pages.",
                              "type": "string"
                            },
                            {
                              "const": "extract",
                              "description": "Return only the listed pages, in the order given.",
                              "type": "string"
                            },
                            {
                              "const": "reorder",
                              "description": "Put every page in the order given. The list must name each page exactly once.",
                              "type": "string"
                            }
                          ]
                        },
                        "degrees": {
                          "default": null,
                          "description": "For `rotate`: 90, 180 or 270 degrees clockwise. Default 90.",
                          "format": "uint16",
                          "minimum": 0,
                          "type": [
                            "integer",
                            "null"
                          ]
                        },
                        "pages": {
                          "description": "One-based page numbers.",
                          "items": {
                            "format": "uint",
                            "minimum": 0,
                            "type": "integer"
                          },
                          "type": "array"
                        },
                        "password": {
                          "default": null,
                          "description": "Password of an encrypted document.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "required": [
                        "action",
                        "pages"
                      ],
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/pdf": {
                "schema": {
                  "format": "binary",
                  "type": "string"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Rotate, delete, reorder or extract pages",
        "x-pdfluent-credits": {
          "credits": 1,
          "kind": "per_page",
          "min": 1,
          "per_pages": 10
        },
        "x-pdfluent-credits-claim": "B119"
      }
    },
    "/v1/pdf/redact": {
      "post": {
        "operationId": "pdf_redact",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/pdf/redact`.",
                      "properties": {
                        "case_sensitive": {
                          "default": false,
                          "description": "Match case. Default false.",
                          "type": "boolean"
                        },
                        "pages": {
                          "default": null,
                          "description": "Limit the terms to these one-based pages. Default: all pages.",
                          "items": {
                            "format": "uint",
                            "minimum": 0,
                            "type": "integer"
                          },
                          "type": [
                            "array",
                            "null"
                          ]
                        },
                        "password": {
                          "default": null,
                          "description": "Password of an encrypted document.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "regex": {
                          "default": false,
                          "description": "Treat the terms as regular expressions. Default false.",
                          "type": "boolean"
                        },
                        "regions": {
                          "description": "Areas to remove.",
                          "items": {
                            "additionalProperties": false,
                            "description": "A rectangle to black out.",
                            "properties": {
                              "page": {
                                "description": "One-based page.",
                                "format": "uint",
                                "minimum": 0,
                                "type": "integer"
                              },
                              "rect": {
                                "description": "`[x0, y0, x1, y1]` in PDF points, origin bottom left.",
                                "items": {
                                  "format": "double",
                                  "type": "number"
                                },
                                "minItems": 4,
                                "type": "array"
                              }
                            },
                            "required": [
                              "page",
                              "rect"
                            ],
                            "type": "object"
                          },
                          "type": "array"
                        },
                        "terms": {
                          "default": [],
                          "description": "Texts to remove for good.",
                          "items": {
                            "type": "string"
                          },
                          "type": "array"
                        }
                      },
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/pdf": {
                "schema": {
                  "format": "binary",
                  "type": "string"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Remove texts and areas from a PDF for good",
        "x-pdfluent-credits": {
          "credits": 1,
          "kind": "per_page",
          "min": 1,
          "per_pages": 10
        },
        "x-pdfluent-credits-claim": "B119"
      }
    },
    "/v1/pdf/replace-text": {
      "post": {
        "operationId": "pdf_replace_text",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/pdf/replace-text`.",
                      "properties": {
                        "password": {
                          "default": null,
                          "description": "Password of an encrypted document.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "replacements": {
                          "description": "Replacements, applied in order.",
                          "items": {
                            "additionalProperties": false,
                            "description": "One replacement.",
                            "properties": {
                              "case_insensitive": {
                                "default": false,
                                "description": "Ignore case. Default false.",
                                "type": "boolean"
                              },
                              "find": {
                                "description": "The text to find.",
                                "type": "string"
                              },
                              "regex": {
                                "default": false,
                                "description": "Treat `find` as a regular expression. Default false.",
                                "type": "boolean"
                              },
                              "replace": {
                                "description": "What to put in its place.",
                                "type": "string"
                              }
                            },
                            "required": [
                              "find",
                              "replace"
                            ],
                            "type": "object"
                          },
                          "type": "array"
                        }
                      },
                      "required": [
                        "replacements"
                      ],
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/pdf": {
                "schema": {
                  "format": "binary",
                  "type": "string"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Find and replace text, keeping fonts and layout",
        "x-pdfluent-credits": {
          "credits": 1,
          "kind": "per_page",
          "min": 1,
          "per_pages": 10
        },
        "x-pdfluent-credits-claim": "B119"
      }
    },
    "/v1/pdf/split": {
      "post": {
        "operationId": "pdf_split",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/pdf/split`.",
                      "properties": {
                        "password": {
                          "default": null,
                          "description": "Password of an encrypted document.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "ranges": {
                          "default": null,
                          "description": "One-based page ranges, one output file each, for example `1-3,5,7-9`.\nDefault: one file per page.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/zip": {
                "schema": {
                  "format": "binary",
                  "type": "string"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Split a PDF into one file per page or per page range, returned as a zip",
        "x-pdfluent-credits": {
          "credits": 1,
          "kind": "per_page",
          "min": 1,
          "per_pages": 10
        },
        "x-pdfluent-credits-claim": "B119"
      }
    },
    "/v1/pdf/watermark": {
      "post": {
        "operationId": "pdf_watermark",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/pdf/watermark`.",
                      "properties": {
                        "background": {
                          "default": false,
                          "description": "Draw behind the page content instead of over it. Default false.",
                          "type": "boolean"
                        },
                        "color": {
                          "default": null,
                          "description": "Colour as red, green, blue from 0 to 1. Default grey.",
                          "items": {
                            "format": "float",
                            "type": "number"
                          },
                          "minItems": 3,
                          "type": [
                            "array",
                            "null"
                          ]
                        },
                        "font_size": {
                          "default": 48,
                          "description": "Font size in points. Default 48.",
                          "format": "float",
                          "type": "number"
                        },
                        "opacity": {
                          "default": 0.30000001192092896,
                          "description": "Opacity from 0 to 1. Default 0.3.",
                          "format": "float",
                          "type": "number"
                        },
                        "password": {
                          "default": null,
                          "description": "Password of an encrypted document.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "rotation": {
                          "default": 45,
                          "description": "Rotation in degrees, counter-clockwise. Default 45.",
                          "format": "float",
                          "type": "number"
                        },
                        "text": {
                          "description": "The text, a limit.",
                          "type": "string"
                        }
                      },
                      "required": [
                        "text"
                      ],
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/pdf": {
                "schema": {
                  "format": "binary",
                  "type": "string"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Stamp a text watermark on every page",
        "x-pdfluent-credits": {
          "credits": 1,
          "kind": "per_page",
          "min": 1,
          "per_pages": 10
        },
        "x-pdfluent-credits-claim": "B119"
      }
    },
    "/v1/pdfa/convert": {
      "post": {
        "operationId": "pdfa_convert",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/pdfa/validate`.",
                      "properties": {
                        "password": {
                          "default": null,
                          "description": "Password of an encrypted document.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "profile": {
                          "description": "Profile to check against. Default `a2b`.",
                          "oneOf": [
                            {
                              "const": "a1b",
                              "description": "PDF/A-1b.",
                              "type": "string"
                            },
                            {
                              "const": "a2b",
                              "description": "PDF/A-2b. The default.",
                              "type": "string"
                            },
                            {
                              "const": "a3b",
                              "description": "PDF/A-3b.",
                              "type": "string"
                            }
                          ]
                        }
                      },
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/pdf": {
                "schema": {
                  "format": "binary",
                  "type": "string"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Convert a PDF toward PDF/A and report whether the result validates; not every document converts to a conforming file, so read x-pdfluent-compliant and x-pdfluent-violations from the response",
        "x-pdfluent-credits": {
          "credits": 1,
          "kind": "per_page",
          "min": 1,
          "per_pages": 1
        },
        "x-pdfluent-credits-claim": "B119"
      }
    },
    "/v1/pdfa/validate": {
      "post": {
        "operationId": "pdfa_validate",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/pdfa/validate`.",
                      "properties": {
                        "password": {
                          "default": null,
                          "description": "Password of an encrypted document.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "profile": {
                          "description": "Profile to check against. Default `a2b`.",
                          "oneOf": [
                            {
                              "const": "a1b",
                              "description": "PDF/A-1b.",
                              "type": "string"
                            },
                            {
                              "const": "a2b",
                              "description": "PDF/A-2b. The default.",
                              "type": "string"
                            },
                            {
                              "const": "a3b",
                              "description": "PDF/A-3b.",
                              "type": "string"
                            }
                          ]
                        }
                      },
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Check a PDF against a PDF/A profile"
      }
    },
    "/v1/pdfua/check": {
      "post": {
        "operationId": "pdfua_check",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/pdfua/check`.",
                      "properties": {
                        "password": {
                          "default": null,
                          "description": "Password of an encrypted document.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Check a PDF against PDF/UA accessibility rules"
      }
    },
    "/v1/search": {
      "post": {
        "operationId": "search",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/search`.",
                      "properties": {
                        "case_insensitive": {
                          "default": false,
                          "description": "Ignore case. Default false.",
                          "type": "boolean"
                        },
                        "limit": {
                          "default": 1000,
                          "description": "Most matches returned. Default 1000, a limit",
                          "format": "uint",
                          "minimum": 0,
                          "type": "integer"
                        },
                        "password": {
                          "default": null,
                          "description": "Password of an encrypted document.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "query": {
                          "description": "The text to find, or a regular expression when `regex` is true.",
                          "type": "string"
                        },
                        "regex": {
                          "default": false,
                          "description": "Treat `query` as a regular expression. Default false.",
                          "type": "boolean"
                        }
                      },
                      "required": [
                        "query"
                      ],
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Find a text in a PDF, with page and position of each match"
      }
    },
    "/v1/signatures/verify": {
      "post": {
        "operationId": "signatures_verify",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/signatures/verify`.",
                      "properties": {
                        "password": {
                          "default": null,
                          "description": "Password of an encrypted document.",
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Verify the digital signatures of a PDF"
      }
    },
    "/v1/uploads": {
      "post": {
        "operationId": "uploads_create",
        "responses": {
          "201": {
            "description": "Signed upload and download URLs, valid for 15 minutes"
          },
          "401": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "503": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Signed URLs for one input document, for a client with no presigned URL of its own: PUT the file to `upload_url` (with `upload_headers`), then pass `input_url` to a job. The object is deleted 15 minutes later"
      }
    },
    "/v1/zugferd/create": {
      "post": {
        "operationId": "zugferd_create",
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "properties": {
                  "file": {
                    "format": "binary",
                    "type": "string"
                  },
                  "options": {
                    "contentMediaType": "application/json",
                    "description": "JSON object with the operation options",
                    "type": "string",
                    "x-options-schema": {
                      "additionalProperties": false,
                      "description": "Options of `POST /v1/zugferd/create`.",
                      "properties": {
                        "invoice": {
                          "description": "The invoice: profile (`Minimum`, `BasicWL`, `Basic`, `EN16931`, `Extended`), invoice_number,\ntype_code, issue_date (YYYY-MM-DD), seller and buyer (name, address, tax_id), line_items,\ncurrency, the totals and the optional payment fields, as in the SDK's `ZugferdInvoice`."
                        },
                        "password": {
                          "default": null,
                          "description": "Password of an encrypted document.",
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "pdfa3": {
                          "default": true,
                          "description": "Convert the document to PDF/A-3b first, as the e-invoicing standards require. Default true.",
                          "type": "boolean"
                        }
                      },
                      "required": [
                        "invoice"
                      ],
                      "type": "object"
                    }
                  }
                },
                "required": [
                  "file"
                ],
                "type": "object"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/pdf": {
                "schema": {
                  "format": "binary",
                  "type": "string"
                }
              }
            },
            "description": "The result",
            "headers": {
              "x-pdfluent-credits": {
                "schema": {
                  "type": "integer"
                }
              },
              "x-pdfluent-pages": {
                "schema": {
                  "type": "integer"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/Error"
          },
          "413": {
            "$ref": "#/components/responses/Error"
          },
          "422": {
            "$ref": "#/components/responses/Error"
          },
          "500": {
            "$ref": "#/components/responses/Error"
          },
          "501": {
            "$ref": "#/components/responses/Error"
          },
          "504": {
            "$ref": "#/components/responses/Error"
          }
        },
        "summary": "Embed a ZUGFeRD / Factur-X invoice in a PDF"
      }
    }
  }
}
