openapi: 3.0.1 info: title: PDF.co API description: "PDF.co Web API \u2014 programmatic PDF and document automation: AI invoice parsing, document parsing, PDF\ \ conversion (to/from PDF, Excel, CSV, JSON, XML, HTML, images), OCR, merging, splitting, compression, barcodes, e-signature\ \ workflows, and more. Authenticated via the x-api-key header." version: '1.0' contact: name: PDF.co Support url: https://support.pdf.co/en email: support@pdf.co license: name: Proprietary url: https://pdf.co/terms termsOfService: https://pdf.co/terms servers: - url: https://api.pdf.co security: - ApiKeyAuth: [] tags: - name: Extraction - name: Editing - name: PDF Conversion - name: Excel Conversion - name: PDF Merging & Splitting - name: Forms - name: Find & Search - name: Document, File & System - name: Pages - name: Barcodes components: securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key schemas: url: type: string format: uri description: URL to the source file [`url` attribute](/api-reference/url-input-and-request-limits). httpusername: type: string description: HTTP auth user name if required to access source URL. httppassword: type: string description: HTTP auth password if required to access source URL. template: type: string description: The raw format of the document parser template to be used directly. see [Template](/api-reference/documentparser/parser) inline: default: false type: boolean description: Set to true to return results inside the response. Otherwise, the endpoint will return a URL to the output file generated. password: type: string description: Password for the PDF file. async: type: boolean default: false description: Set `async` to `true` for long processes to run in the background, API will then return a `jobId` which you can use with the [Background Job Check endpoint](/api-reference/job-check). Also see [Webhooks & Callbacks](/api-reference/webhooks) callback: type: string format: uri description: The callback URL (or Webhook) used to receive the POST data. see [Webhooks & Callbacks](/api-reference/webhooks). This is only applicable when `async` is set to `true`. pages0: type: string description: 'Page indices/ranges (0-based). Items are comma-separated. Each item is one of: N (e.g., 0), N-M (e.g., 3-7), N- (open-ended, e.g., 10-), or !N (reverse index; !0 is last page, !1 is second-to-last). Whitespace is allowed. If not specified, the default configuration processes all pages.' pattern: ^\s*(?:!?\d+\s*-\s*!?\d+|!?\d+\s*-\s*|!?\d+)\s*(?:,\s*(?:!?\d+\s*-\s*!?\d+|!?\d+\s*-\s*|!?\d+)\s*)*$ example: 0,2,5-10, !0, !5-!2 pages1: type: string description: Page indices/ranges (1-based). Same syntax as PagesBase0 but first page is 1; !1 is last page. pattern: ^\s*(?:!?\d+\s*-\s*!?\d+|!?\d+\s*-\s*|!?\d+)\s*(?:,\s*(?:!?\d+\s*-\s*!?\d+|!?\d+\s*-\s*|!?\d+)\s*)*$ example: 1,2,3-7, !1, !6-!2 replacementlimit: type: number default: 0 description: Limit the number of searches & replacements for every item. The value 0 means every found occurrence will be replaced. casesensitive: type: boolean default: true description: Set to `false` to don't use case-sensitive search. regex: type: boolean default: false description: Set to `true` to use regular expression for search string(s). unwrap: type: boolean default: false description: Unwrap lines into a single line within table cells in provided PDF documents. This is only applicable when `lineGrouping` is set to `1`. rect: type: string format: '{x} {y} {width} {height}' description: Defines coordinates for extraction. Use[PDF Edit Add Helper](https://app.pdf.co/pdf-edit-add-helper) to get or measure PDF coordinates. The format is `{x} {y} {width} {height}`. example: 10 20 300 400 lang: type: string description: 'Set the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. see [Language Support](/api-reference/language-support). You can also use 2 languages simultaneously like this: `eng+deu` (any combination).' pattern: ^[a-z]{3}(\+[a-z]{3})*$ default: eng example: eng+deu linegrouping: type: string pattern: ^[123]$ enum: - '1' - '2' - '3' description: 'Controls how lines of text are grouped when extracting data from a PDF. Line grouping within table cells. The available modes are: `1`, `2`, `3`. For more information, see [Line Grouping](#line-grouping-options).' name: type: string description: File name for generated output. templateid: type: number description: Set ID of HTML template to be used. View and manage your templates at HTML to PDF Templates. expiration: type: number default: 60 description: "Sets the expiration time for the output link, in minutes. After this period, generated output file(s)\ \ are automatically deleted from [PDF.co Temporary Files Storage](/api-reference/file-upload/overview). The maximum\ \ allowed duration depends on your subscription plan. For permanent storage of input files (e.g., reusable images,\ \ PDF templates, documents), use `PDF.co Built\u2011In Files Storage`." margins: type: string format: '{topMargin} {rightMargin} {bottomMargin} {leftMargin}' description: Set custom margins, overriding CSS default margins. Specify the margins in the format `{top} {right} {bottom} {left}`. You can use`px`,`mm`,`cm`or`in`units. Also, you can set margins for all sides at once using a single value. example: 10px 10px 10px 10px papersize: description: "Specifies the paper size. Accepts standard sizes like 'Letter', 'Legal', 'Tabloid', 'Ledger', 'A0'\u2013\ 'A6'. You can also set a custom size by providing width and height separated by a space, with optional units: `px`\ \ (pixels), `mm` (millimeters), `cm` (centimeters), or `in` (inches). Examples: '200 300', '200px 300px', '200mm 300mm',\ \ '20cm 30cm', '6in 8in'." oneOf: - type: string enum: - Letter - Legal - Tabloid - Ledger - A0 - A1 - A2 - A3 - A4 - A5 - A6 - type: string pattern: ^\s*\d+(?:\.\d+)?(?:px|mm|cm|in)?\s+\d+(?:\.\d+)?(?:px|mm|cm|in)?\s*$ default: A4 example: A4 orientation: type: string enum: - Portrait - Landscape default: Portrait description: 'Sets the document orientation. Options: `Portrait` for vertical layout, and `Landscape` for horizontal layout.' printbackground: type: boolean default: true description: Set to `false` to disable background colors and images are included when generating PDFs from HTML/URL mediatype: type: string default: print enum: - print - screen - none description: 'Controls how content is rendered when converting to PDF. Options: `print` (uses print styles), `screen` (uses screen styles), `none` (no media type applied).' donotwaitfullload: type: boolean default: false description: Controls how thoroughly the converter waits for a page to load before converting HTML to PDF --- false waits for full page load, while true speeds up conversion by waiting only for minimal loading. header: type: string format: html description: Set this to can add user definable HTML for the header to be applied on every page header. The format is html. footer: type: string format: html description: Set this to can add user definable HTML for the footer to be applied on every page bottom. The format is html. searchstrings: type: array items: type: string description: The array of strings to search. searchstring: type: string description: The string to search. regexsearch: type: boolean default: false description: Set to true to enable regular expression search for the `searchString(s)` parameter. autosize: type: boolean description: Set to `true` to page dimensions adjust to content with automatic page sizing. If false, uses worksheet's page setup. type: type: string enum: - AustralianPostCode - Aztec - Codabar - CodablockF - Code128 - Code16K - Code39 - Code39Extended - Code39Mod43 - Code39Mod43Extended - Code93 - DataMatrix - DPMDataMatrix - EAN13 - EAN2 - EAN5 - EAN8 - GS1DataBarExpanded - GS1DataBarExpandedStacked - GS1DataBarLimited - GS1DataBarOmnidirectional - GS1DataBarStacked - GTIN12 - GTIN13 - GTIN14 - GTIN8 - IntelligentMail - Interleaved2of5 - ITF14 - MaxiCode - MICR - MicroPDF - MSI - PatchCode - PDF417 - Pharmacode - PostNet - PZN - QRCode - RoyalMail - RoyalMailKIX - Trioptic - UPCA - UPCE - UPU default: QRCode description: 'Set the barcode type to be used. See available barcode types in the [Supported Barcode Types](/api-reference/barcode/overview#supported-barcode-types) ' worksheetindex: type: string format: number pattern: ^\d+$ description: Set the index of the worksheet to be used. The first worksheet has index 1. file: type: string format: path to a local file description: The path to the local file to be uploaded. readOnly: true x: type: number minimum: 0 description: X coordinate (zero point is in the top left corner). You can use [PDF Edit Add Helper](https://app.pdf.co/pdf-edit-add-helper) to measure coordinates. The unit is `pt`. y: type: number minimum: 0 description: Y coordinate (zero point is in the top left corner). You can use [PDF Edit Add Helper](https://app.pdf.co/pdf-edit-add-helper) to measure coordinates. The unit is `pt`. width: type: number minimum: 0 description: Width of the text box. You can use [PDF Edit Add Helper](https://app.pdf.co/pdf-edit-add-helper) to measure pdf coordinates. The unit is `pt`. height: type: number minimum: 0 description: Height of the text box. You can use [PDF Edit Add Helper](https://app.pdf.co/pdf-edit-add-helper) to measure pdf coordinates. The unit is `pt`. timeout: type: number description: Timeout for output links in seconds readOnly: true profiles: type: string description: Profiles are used configure extra options for specific API endpoints and may be unique to an API. For more information, see [Profiles](/api-reference/profiles) and the documentation of each endpoint for profiles specific to it. templatedata: type: string description: please set to string converted from JSON with data for Mustache template or leave empty if no template is used readOnly: true makeunsearchable: type: boolean customscript: type: string description: custom script to execute on page load readOnly: true legacyrendition: type: boolean description: use legacy rendition (optional) rendertimeout: type: number description: timeout for rendering in milliseconds (optional) readOnly: true responses: Success: description: Success. content: application/json: schema: type: object properties: status: type: string example: success description: Status of the API response. message: type: string example: Success description: Descriptive message for the response status. url: type: string format: uri example: https://pdf-temp-files.s3.us-west-2.amazonaws.com/output.pdf description: URL to the output file. jobId: type: string example: 6YSZD3U872ZYYFEDMQCQSGEEO8YSF5WA description: Unique identifier for the job. credits: type: integer example: 2 description: Credits used for this operation. remainingCredits: type: integer example: 1480582 description: Credits remaining after this operation. duration: type: integer example: 33 description: Time taken to complete the request, in milliseconds. BadRequest: description: Bad request. Typically due to bad input parameters or unreachable input URLs (e.g., access restrictions like login or password). content: application/json: schema: type: object properties: error: type: boolean example: true status: type: integer example: 400 message: type: string example: Bad request. Typically due to bad input parameters or unreachable input URLs (e.g., access restrictions like login or password). Unauthorized: description: Unauthorized. Authentication is required and has failed or has not yet been provided. content: application/json: schema: type: object properties: error: type: boolean example: true status: type: integer example: 401 message: type: string example: Unauthorized. Authentication is required and has failed or has not yet been provided. NotEnoughCredits: description: Not enough credits. content: application/json: schema: type: object properties: error: type: boolean example: true status: type: integer example: 402 message: type: string example: Not enough credits. Forbidden: description: Access forbidden for input URL. content: application/json: schema: type: object properties: error: type: boolean example: true status: type: integer example: 403 message: type: string example: Access forbidden for input URL. NotFound: description: The requested resource could not be found. content: application/json: schema: type: object properties: error: type: boolean example: true status: type: integer example: 404 message: type: string example: The requested resource could not be found. Timeout: description: The server timed out waiting for the request. content: application/json: schema: type: object properties: error: type: boolean example: true status: type: integer example: 408 message: type: string example: The server timed out waiting for the request. TooManyRequests: description: Too many requests in a given time period. content: application/json: schema: type: object properties: error: type: boolean example: true status: type: integer example: 429 message: type: string example: Too many requests in a given time period. InvalidPassword: description: Invalid Password. Password protected document. content: application/json: schema: type: object properties: error: type: boolean example: true status: type: integer example: 441 message: type: string example: Invalid Password. Password protected document. DamagedDocument: description: Input document is damaged or of incorrect type. content: application/json: schema: type: object properties: error: type: boolean example: true status: type: integer example: 442 message: type: string example: Input document is damaged or of incorrect type. PermissionsError: description: 'Permissions. The operation is prohibited by document security settings. You can turn off this check by setting the `profiles` param to `{CheckPermissions: false}`. Important: only use this if you are the owner or have legal permission.' content: application/json: schema: type: object properties: error: type: boolean example: true status: type: integer example: 443 message: type: string example: Permissions. The operation is prohibited by document security settings. ProfilesParsingError: description: Profiles parsing error. Please ensure that the configuration is supported. See `/profiles` samples. content: application/json: schema: type: object properties: error: type: boolean example: true status: type: integer example: 444 message: type: string example: Profiles parsing error. Please ensure that the configuration is supported. TimeoutError: description: Timeout error. For large documents, use asynchronous mode (`async=true`) and check status via `/job/check`. For many-page files, use the `pages` parameter. content: application/json: schema: type: object properties: error: type: boolean example: true status: type: integer example: 445 message: type: string example: Timeout error. For large documents, use asynchronous mode (async=true) and check status via /job/check. MissingFiles: description: Some files required for conversion are missing. content: application/json: schema: type: object properties: error: type: boolean example: true status: type: integer example: 446 message: type: string example: Some files required for conversion are missing. InvalidTemplate: description: Invalid template. content: application/json: schema: type: object properties: error: type: boolean example: true status: type: integer example: 447 message: type: string example: Invalid template. InvalidUrlOrHtml: description: Invalid URL or HTML. Ensure the provided URL is valid and accessible. content: application/json: schema: type: object properties: error: type: boolean example: true status: type: integer example: 448 message: type: string example: Invalid URL or HTML. Ensure the provided URL is valid and accessible. InvalidIndexRange: description: Invalid index range. Page index is out of range. Use `/pdf/info` to get page count. First page is `0`. content: application/json: schema: type: object properties: error: type: boolean example: true status: type: integer example: 449 message: type: string example: Invalid index range. Page index is out of range. InvalidPageRange: description: Invalid page range specified. content: application/json: schema: type: object properties: error: type: boolean example: true status: type: integer example: 450 message: type: string example: Invalid page range specified. InvalidUrl: description: Invalid URL. content: application/json: schema: type: object properties: error: type: boolean example: true status: type: integer example: 452 message: type: string example: Invalid URL. InvalidParameters: description: Invalid parameters. content: application/json: schema: type: object properties: error: type: boolean example: true status: type: integer example: 454 message: type: string example: Invalid parameters. InternalServerError: description: Something went wrong. Please try again or contact support. content: application/json: schema: type: object properties: error: type: boolean example: true status: type: integer example: 500 message: type: string example: Something went wrong. Please try again or contact support. paths: /v1/ai-invoice-parser: post: tags: - Extraction x-mint: href: /api-tester/ai-invoice-parser content: '## Prerequisites Before using the AI Invoice Parser API, please note: - **Invoices only**: The API processes invoices exclusively to ensure accurate parsing. - **Asynchronous processing**: When you make a request, you get a JobID immediately while processing happens in the background. To get your results, you can either: - Poll the [**job/check**](/api-tester/job-check) endpoint using your `JobID`, or - Provide a callback URL to get results automatically via webhook. ' operationId: post_v1_ai-invoice-parser summary: AI Invoice Parser description: Process invoices faster than ever by extracting data and structuring it automatically with our advanced AI. Get quick and accurate data from any invoice, no matter the layout. requestBody: content: application/json: schema: type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/document-parser/sample-invoice.pdf customfield: type: string description: JSON string containing [custom field](/api-reference/ai-invoice-parser/#custom-fields) names to extract. Use `camelCase` for field names (e.g., `storeNumber`, `deliveryDate`). Multiple fields should be comma-separated. callback: allOf: - $ref: '#/components/schemas/callback' default: https://example.com/callback/url/you/provided additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body /v1/pdf/documentparser: post: tags: - Extraction x-mint: href: /api-tester/documentparser summary: Parse Document operationId: post_v1_pdf_documentparser requestBody: content: application/json: schema: type: object properties: file: $ref: '#/components/schemas/file' url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/document-parser/MultiPageTable.pdf templateid: $ref: '#/components/schemas/templateid' template: allOf: - $ref: '#/components/schemas/template' default: "{\r\n \"templateVersion\": 3,\r\n \"templatePriority\": 0,\r\n \"sourceId\": \"Multipage Table\ \ Test\",\r\n \"detectionRules\": {\r\n \"keywords\": [\r\n \"Sample document with multi-page\ \ table\"\r\n ]\r\n },\r\n \"fields\": {\r\n \"total\": {\r\n \"type\": \"regex\",\r\n \ \ \"expression\": \"TOTAL {{DECIMAL}}\",\r\n \"dataType\": \"decimal\"\r\n }\r\n },\r\n \"\ tables\": [\r\n {\r\n \"name\": \"table1\",\r\n \"start\": {\r\n \"expression\": \"\ Item\\\\s+Description\\\\s+Price\\\\s+Qty\\\\s+Extended Price\"\r\n },\r\n \"end\": {\r\n \ \ \"expression\": \"TOTAL\\\\s+\\\\d+\\\\.\\\\d\\\\d\"\r\n },\r\n \"row\": {\r\n \ \ \"expression\": \"^\\\\s*(?\\\\d+)\\\\s+(?.+?)\\\\s+(?\\\\d+\\\\.\\\\d\\\ \\d)\\\\s+(?\\\\d+)\\\\s+(?\\\\d+\\\\.\\\\d\\\\d)\"\r\n },\r\n \"columns\": [\r\ \n {\r\n \"name\": \"itemNo\",\r\n \"type\": \"integer\"\r\n },\r\n \ \ {\r\n \"name\": \"description\",\r\n \"type\": \"string\"\r\n },\r\n \ \ {\r\n \"name\": \"price\",\r\n \"type\": \"decimal\"\r\n },\r\n \ \ {\r\n \"name\": \"qty\",\r\n \"type\": \"integer\"\r\n },\r\n {\r\n\ \ \"name\": \"extPrice\",\r\n \"type\": \"decimal\"\r\n }\r\n ],\r\n \ \ \"multipage\": true\r\n }\r\n ]\r\n}" inline: allOf: - $ref: '#/components/schemas/inline' default: true outputformat: type: string description: 'Format of output File. Valid values: JSON, YAML, XML, CSV.' enum: - JSON - YAML - XML - CSV default: JSON generatecsvheaders: type: boolean name: $ref: '#/components/schemas/name' pages: $ref: '#/components/schemas/pages0' async: allOf: - $ref: '#/components/schemas/async' default: false password: $ref: '#/components/schemas/password' expiration: $ref: '#/components/schemas/expiration' timeout: $ref: '#/components/schemas/timeout' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: This API method extracts data from documents based on a document parser extraction template. With this API method, you can extract data from custom areas by searching form fields, tables, multiple pages, and more. /v1/pdf/documentparser/templates: get: tags: - Extraction x-mint: href: /api-tester/documentparser/templates summary: List All Templates operationId: get_v1_documentparser_templates responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' description: Returns all **Document Parser** data extraction templates available to the current user. /v1/pdf/documentparser/templates/{id}: get: tags: - Extraction x-mint: href: /api-tester/documentparser/templates-id summary: Retrieve Template by ID description: "Returns detailed information for document parser template by template\u2019s id." operationId: get_v1_documentparser_templates_id parameters: - name: id in: path description: Document parser template id required: true schema: type: string responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' /v1/pdf/attachments/extract: post: tags: - Extraction x-mint: href: /api-tester/pdf-extract-attachments operationId: post_v1_pdf_attachments_extract requestBody: content: application/json: schema: type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-attachments/attachments.pdf inline: allOf: - $ref: '#/components/schemas/inline' default: true password: $ref: '#/components/schemas/password' expiration: $ref: '#/components/schemas/expiration' async: allOf: - $ref: '#/components/schemas/async' default: false httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' profiles: $ref: '#/components/schemas/profiles' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body summary: Extract Attachment description: Extracts attachments from a PDF file. /v1/pdf/edit/add: post: tags: - Editing x-mint: href: /api-tester/pdf-add summary: PDF Add operationId: post_v1_pdf_edit_add requestBody: content: application/json: schema: type: object properties: file: $ref: '#/components/schemas/file' url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-edit/sample.pdf annotations: type: array description: Annotation (textual) signatures to add. items: type: object properties: text: type: string description: Text to be added to the PDF file as an annotation. type: type: string enum: - text - textField - TextFieldMultiline - checkbox default: text description: Type of annotation to be added. id: type: string description: Unique identifier for the annotation. x: $ref: '#/components/schemas/x' y: $ref: '#/components/schemas/y' width: $ref: '#/components/schemas/width' height: $ref: '#/components/schemas/height' alignment: type: string default: left enum: - left - center - right description: 'Controls alignment of the annotation. The available alignments are: `left`, `center`, `right`.' pages: $ref: '#/components/schemas/pages0' color: type: string default: '#000000' description: 'Controls color of the annotation. Color in RRGGBB or AARRGGBB format where AA is the transparency component. For example, 50% transparent green is #8000FF00.' link: type: string format: uri description: Controls link to the annotation. size: type: integer default: 12 description: Controls size of the annotation. transparent: type: boolean default: true description: Controls transparency of the annotation. Set to false to force disable any transparency and draw a white background under the text. fontName: type: string default: Arial description: Controls Font name of the annotation. See [Available fonts](/api-reference/pdf-add/#available-fonts) for the list of available fonts. fontBold: type: boolean description: Controls boldness of the annotation. Set to true to make the text bold. fontStrikeout: type: boolean description: Controls Strikethrough of the annotation. Set to true to add a strikethrough line through the text. fontUnderline: type: boolean description: Controls Underline of the annotation. Set to true to add a line under the text. required: - x - y default: - text: sample prefilled text x: 10 y: 30 size: 12 pages: 0- type: TextField id: textfield1 - x: 100 y: 150 size: 12 pages: 0- type: Checkbox id: checkbox2 - x: 100 y: 170 size: 12 pages: 0- link: https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-edit/logo.png type: CheckboxChecked id: checkbox3 images: type: array description: Image signatures to add. items: type: object properties: url: type: string format: uri description: "Input can be one of the following:\n - an HTTP URL to an image or PDF\n - a file token\ \ from a prior upload\n - a data URI with a base64-encoded image or PDF." x: $ref: '#/components/schemas/x' y: $ref: '#/components/schemas/y' width: $ref: '#/components/schemas/width' height: $ref: '#/components/schemas/height' pages: $ref: '#/components/schemas/pages0' link: type: string format: uri description: Link to the image. keepAspectRatio: type: boolean default: true description: Control whether the image should maintain its aspect ratio. Set to false to use the specified width and height, which will stretch the image to fit the page width. required: - x - y default: - url: pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-edit/logo.png x: 200 y: 250 pages: '0' link: www.pdf.co fields: type: array items: type: object properties: fieldName: type: string description: Name of the form field. To find form fields. You can use [PDF Edit Add Helper](https://app.pdf.co/pdf-edit-add-helper). text: type: string description: Value to set for this field. If you have a checkbox, set X, true, 1, or another text which is different from false to enable the checkbox. For radio buttons and combo boxes, you need to set the index of the item to select. To find form fields please use [PDF Edit Add Helper](https://app.pdf.co/pdf-edit-add-helper). pages: $ref: '#/components/schemas/pages0' size: type: integer description: Override the font size of the text inside the given input field. See [Available fonts](/api-reference/pdf-add/#available-fonts). fontName: type: string description: Name of the font to use to fill out the input field. fontBold: type: boolean description: Override font bold style of the text input field. fontItalic: type: boolean description: Override font italic style of the text input field. fontStrikeout: type: boolean description: Override font strikeout style of the text input field. fontUnderline: type: boolean description: Override font underline style of the text input field. required: - fieldName - text name: allOf: - $ref: '#/components/schemas/name' default: newDocument async: allOf: - $ref: '#/components/schemas/async' default: false inline: allOf: - $ref: '#/components/schemas/inline' default: true templatedata: $ref: '#/components/schemas/templatedata' expiration: $ref: '#/components/schemas/expiration' x: type: number readOnly: true y: type: number readOnly: true width: type: number readOnly: true height: type: number readOnly: true pages: type: string readOnly: true password: type: string readOnly: true type: type: string readOnly: true urlimage: type: string description: URL of the signature image file. readOnly: true text: type: string readOnly: true size: type: string description: Font size. readOnly: true color: type: string readOnly: true transparent: type: boolean readOnly: true fontname: type: string readOnly: true timeout: $ref: '#/components/schemas/timeout' annotationsString: type: string format: '{x};{y};{pages};{text};{fontsize};{fontname};{fontcolor};{link};{transparent};{width};{height};{alignment}' description: This parameter represents one or more text objects to add to a PDF. Each object is made of parameter separated by the `;` symbol. imagesString: type: string format: '{x};{y};{pages};{urltoimageOrPdf};{linkToOpen};{width};{height}' description: Adds one or more images or other PDF objects on top of the source PDF. Each object is made of parameter separated by the `;` symbol. fieldsString: type: string format: '{page};{fieldName};{value}' description: Set values for fillable PDF field objects. Each object is made of parameter separated by the `;` symbol. profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url - annotationsString required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Add text, images, forms, other PDFs, fill forms, links to external sites and external PDF files. You can update or modify PDF and scanned PDF files. /v1/pdf/edit/replace-text: post: tags: - Editing x-mint: href: /api-tester/pdf-search-text-and-replace/text operationId: post_v1_pdf_edit_replace-text requestBody: content: application/json: schema: type: object properties: file: $ref: '#/components/schemas/file' url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-search-and-replace/sample-agreement-template-signature-page-1.pdf searchstring: allOf: - $ref: '#/components/schemas/searchstring' default: '[CLIENT-NAME]' replacestring: type: string default: John Doe searchstrings: $ref: '#/components/schemas/searchstrings' replacestrings: type: array items: type: string regex: $ref: '#/components/schemas/regex' casesensitive: allOf: - $ref: '#/components/schemas/casesensitive' default: true replacementlimit: allOf: - $ref: '#/components/schemas/replacementlimit' default: 1 makeunsearchable: $ref: '#/components/schemas/makeunsearchable' pages: $ref: '#/components/schemas/pages0' name: allOf: - $ref: '#/components/schemas/name' default: finalFile async: allOf: - $ref: '#/components/schemas/async' default: false password: $ref: '#/components/schemas/password' timeout: $ref: '#/components/schemas/timeout' expiration: $ref: '#/components/schemas/expiration' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body summary: Search and Replace with Text description: Replaces text in a PDF file with a new text. /v1/pdf/edit/replace-text-with-image: post: tags: - Editing x-mint: href: /api-tester/pdf-search-text-and-replace/image operationId: post_v1_pdf_edit_replace-text-with-image requestBody: content: application/json: schema: type: object properties: file: $ref: '#/components/schemas/file' url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-search-and-replace/sample-agreement-template-signature-page-2.pdf searchstring: allOf: - $ref: '#/components/schemas/searchstring' default: '[CLIENT-SIGNATURE]' replaceimage: type: string default: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAloAAAEuCAYAAABWALygAAAAAXNSR0IArs4c6QAAIABJREFUeF7t3Qv0vdd85/FPa+o2KkQIoUyjFVGt0lpBqekwFXVrdWGUUKLMMHGJW/SyMrNWaQyjaDGiEsVgMUOjSrXMlLqWNKXFMC11GfeWjojbYNZnde/Jd7Zzzu+57vM8Z7/3Wln/5P8/z7P3fu2T/L7Zl+/+LlEQOByBfybptpL+uaSflXSVPXXtTyT91J7qploEEEAAgQUJfNeC2kJTEBgicHVJz5Z0qqQrdXzBRyX9raS/kPTF8Ksf9z9vCtAcxOW//Of574/ZUqcDLQdcFAQQQACBhgUItBoe/APo+l0lnSHp9kf05U0p6HHgk4OrKbt/H0nHSjozBWB+9wMkvWDKSngXAggggMD6BAi01jdmtPhSgWdJemgB8g8hqMqBVS2zz0ryDJvLv5f072pVTD0IIIAAAssUINBa5rjQqm4C3w4fu0DSI9OSYLenp//U+ZJ+Mb3Ws1me1aIggAACCDQsQKDV8OCvvOveI/WR0Ifv33OQ5aa8Km3C99+fK+khKzem+QgggAACIwUItEYC8vjeBG4p6W0LC7S8VHh2aNM1JH1ub0JUjAACCCCwdwECrb0PAQ0YKOAlOi/V5bKEoOZGki6SdNnUqHtKesXA/vEYAggggMABCBBoHcAgNtqF35B0Vuj7Ur7LcZ/WFyTdnTQPjX5D6TYCCCAgaSk/nBgMBPoKfCnkzVraCb+PS7pO6pBntDyzRUEAAQQQaFCAQKvBQT+ALj9c0jNCP5aWHPQcSY8P7WMJ8QC+dHQBAQQQGCIwRaD165JOkvReSc5h9DFJb5H0+SEN4hkEOgi8W9KPpc/9qaSf7PBMzY/4CqDflvRDqdJPSvqJBZyKrGlAXQgggAACEywdxjxGJei3JL1S0qslvQhtBCYSeJqkR61gtsjB1n8P7eT+w4m+ALwGAQQQWJPAmBmtl0u6R8fOeunEP2g46t4RjI9tFYjB/dsl3UGS92stsZTpHk6T9OIlNpQ2IYAAAgjMIzA00Cr/b71L635P0s91+SCfQWCLgK/b8bU7uTwsXSi9ZDDPavnfF5e/k3Qy/8Ox5OGibQgggMC0AkMCLc9ieTZrSPGelfcPeZBnEEh5s/IVN973dO0VqJT/U8LG+BUMGk1EAAEEphIYEmhtWzL0ks43JV0s6cqSvrtopI+8X3eqhvOeJgU8I3Rs6vnTi71aSwZ5rqQHpwZ+WNLt2Bi/5OGibQgggMB0AkMCrTIjt1vzWUnHF81ylmxvgr9Z+v2l5TqaTpE31RC4ejrRevlUmZehvRzdt3iG6d6SvL/L+wb/tu8LBnze9zK+VdIJ6dlnS/KyJwUBBBBA4MAFhgRa/qHh/0P/6WTzxZTTyBt/N5XbSnrTgTvSvfkFHGg5oM/lxyVd2LPactm75r7Bsu4lXILdk4+PI4AAAgj0FRgSaOU6PGPlwp6rvup8fqhAPHE4ZIZ007J3zX2DfxVyazlNxaOHQvAcAggggMA6BMYEWuvoIa08JIF4gm9IoFWmW7BNzZmlMyQ9MwwI//4d0reTviCAAAIbBPgPPV+LNQl8Ipw0HJLawdf2+PqeXL4h6bKVAeKs1gMkvaBy/VSHAAIIIFBRgECrIjZVjRaIS4c+ZHFRzzf6up5bh2d8bdRNer5j7MfjrJpP4noJ3id1KQgggAACByhAoHWAg3qgXSrzUfkE36d69NV3I/qOxFj2MaN0LUl/LumaqSG+A/FtPfrBRxFAAAEEViRAoLWiwWq8qc5D5dOuLk7J4L1VfcrZksqTsddLKSP6vGeKzz5F0mPSi0j1MIUo70AAAQQWKrC0QMtH+H0fomcvnOOIgkAWiCcGhwQn75B0SuB8jiRf6bOPEmfn/H2/xj4aQZ0IIIAAAvMLLCHQ8iyDNzZ/a8MPHM9c/FNJOQBzZvC3SPpfkpyfy8Wf+aqkv5R0ScpI/54BOZbm16aGMQJxf9ZP9QzEnYn9DUXlt0nfpTFtGvpsuQz6s5IuGPoynkMAAQQQWK7AEgKtr1U4+ZUzgDto8wzCuyQ5w/inJX0oBXgO2NyWPvt+ljuyl7bsPinI+MwaGruljWVg0jf3VUwL4SpeJ+ln9uzxlfQddDNOl3TenttD9QgggAACMwjsO9C6oaQPjOzXFyRddcA7fC/jZTY852zj3jjtgOx9KSGrZ9S8YdlZ8P84zbD9xYA6az5SBif72Pg9VX/j/iyPyY17vjjOhvnRJVzs/GpJd0n98HVAt+rZJz6OAAIIILACgX0HWt8ryUfsfa1PLP69R6RlwSumGSd/5oPpjrrjJH2+eManuS4n6f+kexdPTMuOfu6T6Z45b372rNZNJV0pLTnmpcmuw+XlSbcpF8+E+S8HYfFX//1HK92lt6ntPmHngDEXL69eoWsnF/a58yX5jk0X551y0Ni1lAFn3+e71tP3c7FP/n56ls7fIQoCCCCAwAEJ7DvQMqWvITkzXLibeT1z8UspsKpBnoM9B0j+4fylVKlnyxy03T79849IOqlngzz75ff6V//lPWRzX2ZczuK4yX2X3Hp2c7aPezk3p0PoOzPn+wzvFlp2mqQXz9bS7i9+pKTfDB8fcndj99r4JAIIIIDAXgSWEGi549eR5B+IcQYmgwy5aqUGpoMxB2c/Kukq6de+yS+9dywGX1MtR5azONljKePdd3w84+MZSxfvrfIeq67FOas8g+lib2+kX0Ip83ot9Xu+BCvagAACCKxWYGk/eDdd+mtc/5//C1NQsnRsB145APPf+y8vWXYtDga8Sf/1kr4c9ol1fd5B1svS8mn5jNMIeO/Z2kpMzdCnD/eQ5O9ULg64pgpmpzCMm/SXFARO0TfegQACCCAgaWmBlgdl08W//n0vJT5R0ktXOnJxBszBV05P0aU7eR/YmyS9SNLfbHmoDCzKj9W8QLlLv7p+JgYkfb6zMXD3jOnPda2w0ue878x7tXLp07dKTaQaBBBAAIExAkv5D7uDkDPS8tA/SDombVr3fqhYvO/I99X1CVLG+Mz9bJ7xir+670eVV6TTkGWm820zgvl9a90HNCTQ8ixi3Ae3hJOG5biWgdYS23jUd5E/RwABBBDYIbCEQGvXLIyTk/oUoQOxsjxI0vMPcHS97Hh8uuzY+3ic2mBbceJWny78A0lvlPSTxQxJ+VzfRJ9L4fUs3n1TY7pu6I8zo54NvWU44LCUfrkd8XSoA2gHWxQEEEAAgQMRWEKgddQsjDN6O2u8f8Beu3D3n50ryT+gDrk4GPVfnvn6wR0d/YSkb6R7ADflCVtroOU7DnPA2fU7G09dLnmjeZlMtWv/Dvn7Tt8QQACBgxFYwn/Uy+WTbbjeEO9N3r7nrjyd6I3Ent1awrH9ub8cnt17oCSnKdhVfHjgfsUHnJbCmfDXVuKsZ5fvbHmi7wd27Gvbt4XvW3xWaESfzf77bjv1I4AAAggcIdDlh9bciF4qcxDl+968TOj7DJ0Q1MlMy5KTTcZM4fEz3iTuJcUWLqT+HkmPTTNcd0rZ6o8aqyWM91Ft3PTnMRjvss8szpK+UtLPD6m00jO+deCzoS72aVWCpxoEEECghsCSfvDeKG3wdr+dV+vjWwC898ZLQQ7QHGh4RqAsXkr0Cb04U1DDc591eBbHHvfa0oj/IenkfTZwRN0x0Oqy/Ok8W6em+nzI4rdH1F3jUV/rlBPidulfjTZRBwIIIIDABAJLCrQ2dWfb/q24IdoB17+R9LgNL3B297um1BBrzB81ZIi9j+uX056u+PxjJP3HIS9cwDMx0DoqM/yxaVY0N9uZ/Zd+tY0D5P+QGvxkSWctwJwmIIAAAghMILD0QMtd3JRXy6fIfAotJp/0cqODrbM3uHiT+K+le/ImYFv8Kxx8fiS00hvD/8WKl1QdLF+Q+nPUjI9nhjxD5LKWU3xOY+JrmVx8uOMhi/+G0UAEEEAAgU4Cawi03JF86s6/5uJg685b7gz057xp3Ne1xAurfSm1N82/WdI7Owmt80NloOVerGWsN4nHK4WOOkEY9+/9fprRXMMoeqncS+bOI+crnSgIIIAAAgcgsKYfvt4s/wvFkpg3vfv3fOnwtuKM4LeWdLXiA/6B7ecPceP8DSV9IPT3kpQAdq1f2Rg4HhVoxXQJR312SR5xX9laM/gvyZO2IIAAAosQWFOgZTAf03faAiefzKXrUssTJD1pg7oDLW+cL7OsL2KABjYiLp/5FX8p6T9JcuqAz4QgzHvYfLrTlzbfJizFXjiw3rkec1oKb+Z3ySdPt9XlJdM8i/lbkh4+V6Mmfm/ch9Y1KevETeB1CCCAAAJTC6wt0HL/fTrRQVFcRuwzc+FTaDfeknHd7/kzSa8dAO3lrZtIunlKGupXOIBzIBevghnw6t6PxKW23g9LcqDlrPPeVO8l2iUUp+44MZ043RUUO1WCUya4OMhysLWGEnOF3UHSH62h0bQRAQQQQGC3wBoDrdyjMqO2Lwz2MmGfsu1Uo2fJfHl1l2VFz7B4o/n3bal4H5cZb8sz1sfGn/V+ofMkPU2SDxTss+SZKgetXlrbVuL34qiN8/vsT1n3cZLyyVifQHz8khpHWxBAAAEEhgmsOdByj+MPVQdF/sE6pHhT/ekpaWp83pvmny7pVRte2jWjvR+tvRQUZ3WGeJTPvD3NbnUJPKeob9M7PAbep7cr0PJMlr8T9nZZU6Dl9uZ7D9e0iX+u8ea9CCCAwEEIrD3QKmdufC3NmGt4rpz2cT2sGF3/4PMs12vS779LkjOUdylfSZnuu3x2is/8V0l3L170BUmevfPMmw8OOBi5lqTLSvLG+WMkeUbFJS+7lW3xPi7vc/MeuX2U8yU5uHXZtVk8XtLsNAket7WUeD/j2v/dXIs57UQAAQRmFTiE/5jHWS1f3+MAaIo9UV7yc7Z1H7nPxSkhHKBcd8Oo+DJnXyF0heLPPCP2qFlH8dKXO7fYizbU1Xdmx8HaCZJuUbzrYkmP3lPwck5YTvPF2n+9xXQtl0lvan6eifQM4q0qfWeoBgEEEEBgRoFDCLR8wsz5sTw743JU5vC+nL+SrrbxrM+24g3Xf5gSZDpxai5OqHrTvhWO+Hy5b82v+uqG4K9rFd6g/bw04xWfydcgdX3PFJ+Lm8V33XcYAy3foXnmFJVXeserJd0l1XUI/25WYqMaBBBAYLkCh/Ifc99ll5f75pgN8CyWr0kpZ6Y8A3GKpH8i6X9uGObrSfpYxeHftDfLM1z3G9EGn/J0wOhLrGOZOqA9qom+0zLfXblrSfDzIWeagywHW2spb5B0u9RYL+n6fyAoCCCAAAIrFjiUQMsn/hwM+J47l3um2aWphuaOabksLiPmdzu/k38olsWzS94TVbN8eMOJvCmuoXGw5YDlp0NnXinp5yt2LiYt3TVTtdZTh6Z8r6QfTqa7lkcrslMVAggggMAYgUMJtGwQ70R07qdTJ0xJEDdiuy6nOviopJ/Ygv91SZcbMzADn3ViUucIi8Uzfc8e+L74mLPr/2n4De/XcrLTWsXBXs7p9daU7X9T3WsOtOJ3uPZJ1VrjSD0IIIBAUwKHFGiVSTqnmtVyNvpyWTBvLvcPfgcAsbxD0uv3lGn+Ikk/WrSn70b4bf8C3Kc40ems8j6lWbPEE4XbltbiZ6aYzavZPy+NeonUZapxq9l+6kIAAQQQKAQOKdBy134n5cPy34/JqxWZ/J7bht+IAVyZS8sJPp2T6y17+qZ9WtLxRd1TBZxlIOsgs5w9m6rbN0in7uzumUMHkP9NkjeLux27ApG4GX6q78BU/TrqPTFdyZMlnXXUA/w5AggggMCyBQ4t0HL+KKcmyMV3++Vs20NGwnuy/MM9nxz0Hqjrhxd535D3C+VEmr+7p5ksN2lbAtWplg7LQGvqIMYzh05PcfaWgXIQeZmQ52vbZvw1B1rRuM+1UkO+2zyDAAIIIFBB4NACLZPFPTpjgwxfPRNPGjrg8qb7snj58P0VxmtbFVeR5Ctq/Ktn1WIqiql+YMf9Q7kdY78/nrn6BUk+RXjNnn7b+hUDrTlOoPZsZq+PR+OpA9leDeHDCCCAAALTCIz9QTlNK6Z9y1Q/rJwh3ctjOVP6Pu4s7Crjtt0tBVl/X5w8dI4vX648tpQzWt635kBpSPHyqhOf5mXAIe/4q3BCLz6/5vQOU313h3jyDAIIIIDADAKHGGiZ6X+HE3G7rmvZRVrO4Ey112nqYfSyZb6L0Rdr+0JipwbI5UmSnHR1bPEme++VymVoMtZNG/bLtvndntH5QEop4Rxe3q8VZ+qciPUmkj4UHna+M18VlMvaNpTH/YBrS7Y69vvF8wgggMBBChxqoOV7/ZxJ3GXofXcx+edST695qdCBi/eKvSedOIyn7tz/qRKLxjxWfu9LJPkkYp+y645I78FycPvcLS908Oi+xZOO5fKar0zyZ3LZlUG+T7trfdZXRznJrcsTJf1qrYqpBwEEEEBgHoFDDbScYPS1icy5pX6kJ99cqSJ6NuPIj/sexUekT+X9Yw5UfHotlzcXpyaPfOmWD5QmTtR6co+Xbdrj5cuufQm4k586aDqqxGt48mfjXq2yjrV9v2NwP3Qm9ihD/hwBBBBAoKLA2n4Q9aHx5nDPwrj0/aH1Mkn3Ss/61KJPLy6txMDnGZIemRpYzhoNXeIr++tg1bNmuXgm7WYdUXx603u6Lh8+/xhJF3YMsPJjTpD6Rkk3D+/xOzxz5RLHfFdS047NrvqxOBvHRviq9FSGAAIIzCdwyIHW/SW9INF55qe8p3CbasxA7s9MdWpvylGMS4bOM+Wgy8tOLj5pd4tQ2VSBll8ZT/T1yfNUnt4ck/W8nLFzu/LysIPi41Lfz02/P6X7nO+KObScyT/f3TlnnbwbAQQQQGBmgUMOtHxa0JfyXjX9uuk+wk28cfnJG6v/5Z5TN2xqY9w0XW74jukt/KyXo8okpkO/VjHQ6hqAlkuO3ovlTetDy6Z8YfbwXjTPaOUy1d60oe3s+9yUaUn61s3nEUAAAQRmEjjkQMtkztCe7yO8tyQvCR5VfIXOKelDfWbCjnrvVH8eA8G4ZJjf/9SUOiH/s9M9XG2CysuN5l1njDbNQPVdyo3N35aY1e+MgZbzmnnmbA3FG+DzjKTbu+16oTX0hTYigAACCASBQw+0+uYl+iVJDiByOUHSpxb0jXEqB19w7aXDfMqwbN45kh4ffvNrxd6ood0Zmhl+0yb4MbNNvgvQdwKW5QmSfiP85tt2XPo91GCu5+Kl5WvbWzaXCe9FAAEEDkLg0AOtMjjwMuIXd4zcMyWdkf58qkSfU31RYh6rcl9WrOPXN+TN8ozJx0Y2ZGigdSdJrynqHpMuo5xZy6/29UgnhnqeEy5oHtn1WR8vLy0fE4TO2lBejgACCCDQX+DQAy2LfEnSlRLNrh9ivqfwfoFwSTY+Pek9PPkU5bargNx8/9mfF1+FKYKOMtB6Z7Hpfte37xOSrh0+MCarfNmObfUuNcFs2d7nS3pg+k1OG/b/bxhPIIAAAosWWFIwMRdUvp7G73cw5T0+ZfHpRJ9SzOVBkvwDcAnFy4QOsjyj5XsMvXy4K+eUT91tukh7irH+sqQrJpQ+Geedc+ukgLlt2bOrd0zjcEloU37+4pSS4ytdX7inz8Wg0TnFnAD2dXtqC9UigAACCMwgMMUP3xmaNekrnV/K15m4eNnQy4exlNe2TJkOYWxHHGT5eh3/QHaQ5b7klBW73u17AONG8G9IuuzYxhQXdve53uaFkk4L9Xc9sbityTGx56bP+FqeGNhN0PXJXxHH1i/3oYF/PXktvBABBBBAYK8CLQRa5dUxZYBQbta+y4Y9RfsYJP8gdoCYZ+D6BCevT3cE5nY7LcOxR+xP69LHmIKgT6Dl63p86jMXt+/ULhVu+cxTJDnh6bZynqTTR7y/xqPl9+6o/YM12kQdCCCAAAITC7QQaJnMs1S+gNilDFhi8LCULPAOshws+JLoTW0+6mvwPEle/oxlinv/4j2Kfe6QLFNOjM3tVZ6s9Lg5b1ouS9+f5fH1UmEubIA/6hvNnyOAAAIrFWgl0Ip3Ar4pLcV5yMos8EvIyB1nsr4lyacf8/U6Xb9mcQ9TfqbPDNS2eoYkLPW7HPQ5+MvFe6h8nc7Q8mhJDt42lW+mww9fHfryCs/FhLPx+1ihaqpAAAEEEKgp0Eqg5Q3k3uuUS16mKU+wTRGMjB2/+EN42+b9o+qoEWh5+e5xRzUk/bmz6/9R+KxPgl6547ObPrYtxYM/6wDrCiPePfejZcLVXSdI524L70cAAQQQmFmglUDLjHE2xktyPo1Y7pNxTqO/mdl82+t9qtDBYE7hMGamwyfXyj1QY7Kx5zbHVBnO1/VrHa0eLslZ7GPxRd2bTkd2eaVnw7z8GC+pjs/9sCQfCFhaKdN0bMrsv7Q20x4EEEAAgRECLQVacaYo/4CLMz++jPlWIyzHPFoGfENnsnIbylkTp1c4eUwD07NDN8OXBxL8urGzh76HctudiTeTdNEE/Z36FXEJ20lnHVzvSqA7df28DwEEEECgskBLgVYMZvJsUUykuY9M8F669PUreRbLw/8oSf6BPKb4fT6x6CVT36HnwM39H1O82dyBVk4b0SdQ8rOegYrFwaDbNbR45jFmgo/vWeJm+HL5Os+qDu0/zyGAAAIIrECgpUArXmHjofE9hp4VyaVP4DB2aGMglN/lGQ4HH7uSkfat15v9fbnyFKXcz9bn1KHrL3N7+Voep9IYWuLsWvmOJ0s6a+iLZ3jOBxw8e+pfXcYsC8/QPF6JAAIIIDCXQEuBlg09u+N7/1w8axRP843ZM9RnfOLykZ9zIlL/3tgZpz5tGPLZMtDqk9crez8iVDw2iequQKtv24Z49Hkm3k7g8XagzZJhH0E+iwACCKxUoLVAK16146ArL9nVuGOu3Ozur4z3ijnIcluWXsYGWmVKhq/t2MzexaLchxafOVeSZ9yWUMp2smS4hFGhDQgggEAlgdYCrXKfTGZ+q6Rbz2Tu5SLP5MQZqwvSbNoaAqzMUgZaffe0ORWEl/RiuaGkDw503xVoLWVGy8G1Z97ykiGnDAcONo8hgAACaxVoLdDyOHnJ5piU7iH3f+wpv23j7+DEiTqdNsLFy0YOELyUtMbiHFWXSw3vc6m0Hykv7vbvjdkXdw9JL9+CuJRM6/FGAvZlrfEbT5sRQACBkQItBlpT/8DfNATlZvevS3ppuLdw5LDt7fG4L8o5v+7eoyXvkuRrgGIZE2iVM2zxvUsItOL3jFQOPb4ofBQBBBA4JIEWA61Ny4djfuCX3wdvsPdSYd7/5Vks/55/8K69xBQZvh7oDEm+tqhLKU8d+pmxSVRjEtrYhtMkvbhLo2b6jMfb6TVcHGT5O+fZLQoCCCCAQGMCLQZaHuJLimta+qYq2PQ1cWDlWR7vy8nl0H7I3q/IffUKSc5Z1aVsylY/9vu37eThnSX9QZdGzfAZz7T5e5D3ZXHFzgzIvBIBBBBYi8DYH3Rr6WfZzmdJemj4zbGnDsvM7n619+R4JuPQjvF/WtLxwa5rctByqe9Dkk4a+QXatBzpV47N0TW0WfGKnbXvxxtqwHMIIIAAAkGg1UDLR+xfGRyGnjp08OAlojiLtZa8WEP/RSiDyi9L8p4oz24dVZz1/kxJvu7Ibv51TNm2T+sLko4d8+KBz/o06V3ToYdDWS4eSMFjCCCAAAIWaDXQct+/Kem709fgVyT5FF3X4mWhs4uEp352juzuXdtU63OetfkzSb5WJxbv1fIpQM/k1SqeWfMM26biq4KmyorfpT/5FKRPZjqNxdIT0HbpE59BAAEEEBgp0Gqg5cuI4/U7XZe/zL3pfkL/vmcznLrh0JYKN33FnHz0iSHVQ/yMl2GfX3Ez+h3T7OTli4bWDLRiqoml5PAa+Z8GHkcAAQQQmEKg1UDLdvHEWpdM4p7F8nKXg6lYWt2L4+Ai/1V+Fz8n6QYVg854ys9tGZt1vs+/W3Epdexevz718lkEEEAAgRUItBpoeSO8N8Tn8mFJ198xXr8q6fSQsiF/1IlO/UO+hVmsbTxPleQZrrLUnFFy3U7n4Nmt96blyxpLd0+T5H1nLj5V+TMr+HeeJiKAAAIIVBRoNdDadErwYRtyQt1b0oPTcmEcFu9DcoBFbqR/VHHm+/tKuoWkO0h6oaT7V/we167qlinA8oyei2dEnZDWM1oUBBBAAAEE/p9Aq4HWpvxLcdnH+7Cc9PKBG74rPmHnK3RansXa9a+Q7Q454CiXKb2c7JOUFAQQQAABBL5DYMpAy/937yW5q0r6kqSPSHqspM8s0D3uz/LFzjmLu9M+OKu7g4WyePbKf76mi6AXSL/aJvk78qLi8vEpbxRYLQwNRwABBBDYLjBVoLXr3jnvW/H+lSUV51nKmbtfnXIfbWvf+yR5H9IhXKGzpDFYU1s25Uub6t+dNTnQVgQQQACBngJT/bB4btrLtKn6iyV9b892zf1xz7blWazPSzpG0vdsqNRH9b0MdshLYXNbr/39zu7v5cH8fXHgfeO1d4r2I4AAAgjUEZgq0PLmZ+9p2lamqmcKlV2zb36/Z7ucE+s5KTHnFHXyjnUKlIcmnrEhSe06e0arEUAAAQSqCEwVAMU9T2XDPWNUZhGv0rktlTxI0vN2NIB9N/scneXU7QMPdwvNcRqHpy+nebQEAQQQQGANAlMFWptO8eX+f0rSCQvCOC/dzbetSd/PhvcFjVb9pvjeylcVOdN8CMKBFwUBBBBAAIFeAlMFWr6O5Ze31PxGSbfv1ap5P+zM7ueHKi6R9PuS7pV+jxmtef2X/HYvKzvIygclfHel92iRL23Jo0bbEEAAgQULTBVo+WThS9Km8rK775HkWYKlFG9q9uZm/wC9UNJr0mzFRamBzpPFCcOljFa9dpT5sZyU1kE56TzqjQE1IYAAAgcnMFWgZZh4HUmE8mzATRcodyNJ7w/tyvvMuBQjt9UQAAASTUlEQVR4gYM1c5PK/Vhsep8ZnNcjgAACrQhMGWidKOmcdNFw9FvLRbvO9O40Dz5x6NkuyuELeInQ+wvzjKsvCPdJQza9H/7Y00MEEECgisCUgVZusH9IObt6Lu9Md+BV6dCIShwQ3jbtx1niDNyIrvHoBgEvITvIyvmxvB/LS4XkTOPrggACCCAwmcAcgdaPSXp3aKEv3H3IZC2e70U50PKeHJ88pByuQLnp3bOY3qPFfqzDHXN6hgACCOxFYI5Aq0wIupalwzgTN4fLXgaYSr9DwMvCPnWaTxayJ48vCQIIIIDAbAJzBBRrDbRiFnByac32ldvri2NqD+/H8j+TH2uvQ0LlCCCAwGELzBFoec+L7xLMxakSnDJh6SUe7yeX1tJHq1/7PHv1eElnpce8H8v/Q8BSYT9HPo0AAggg0FNgjkDLF0j7vsDLpLY8RdLjerZrHx/3kpKTVboQaO1jBOap00HW2WkP1tclvTTNZM1TG29FAAEEEEAgCMwRaPn1vt/waqke733yPXFLLzHQ4sqVpY9Wt/bF5LReKvR30UvEFAQQQAABBKoIzBVovU7SqakHvlvw9Cq9GVdJ3FtGoDXOcglPx/QNDrK8NEzG/yWMDG1AAAEEGhKYK9C6o6TXJkffI3jXFZjGQItreFYwYDua6ASkzpHlZUPyY617LGk9AgggsGqBuQIto3xc0nWSzpz1TDUAMdDyUifZwaeSrfuemL7BM1keVy6FrjsG1IYAAgggUCEAenm4jmcNuYoItNb/r0U8OeqZLM9s+WolCgIIIIAAAnsRmHOmydfw5Fmhz0m6xl562L3SuBmeGa3ubkv5ZMyD9qZ0XyVB1lJGh3YggAACjQrMGWiZ9NvB1T8IPbO11BIDLfZoLXWUNrfLm9zvn/6IIGtdY0drEUAAgYMWmDvQ8nKclxCvnhQfK+mpCxWNy06cOpxnkPx98F+5XC9tVvdl3jl5qJf8XL6STq7+Z0mflfTXkt6/oVnlTFZ8/zy94K0IIIAAAgh0FJg70HIzHizpuaE9S00GSqDV8Uuz5WM5wLmBpBMlOXHt8ZKuKenvJZ0gyReOjynld8fX59wtvfAZKYXDmPfzLAIIIIAAApMK1Ai03OCXSbpXavkrJN1z0l5M87I4M7LUYHCank73FqftuEM69JBnLad6+/skXTfNbOX9fT8u6cKUtsFZ/HNwx566qdR5DwIIIIDApAK1Ai03+h2STgmtr1l3FzRv3PcGfhcCrd1iTttxZo+M/3lZ0ElE/yS9+nfTr1+W5MMS+TP+9bh0u0BuxZ0k+XN+1rmxnCPLJwpJRNrlm81nEEAAAQT2JlA72IkpH9zph0v6rb31/v+vmEDr6IH4AUnPlOSA6eQtH/9k2kv1YUlvTzmspspj5eDqolQviUiPHi8+gQACCCCwZ4HagVbMGJ+77pOI/uHtfTz7LG+WdJvUAGa0vnMkvEznpcJN91Z6Oc83AHhZeNOG9SnG9V+lC6H9Lp8s/MUwCzbF+3kHAggggAACkwvUDrTcAc+KPCkkM/XveT+ON8zva3bLbXpe2PPzg+mU2+TgK37hsyQ9tGi/gysvIfpE4FzFS4Vnp43uF0t6Ppve56LmvQgggAACUwvsI9DKffDm81tLul3o1Acl/VtJb5i6o1ved+d0KvIu4c89O+NN15RLBW6UguH8Ow6MPbP1xzMjeYnyN1PyUfZjzYzN6xFAAAEEphfYZ6AVAy7PWMTiTc/eLO1ElFOWG0u6dloCu0fI7xXrcMoA59GiXCoQT2T6d72M6OW7OYv3Y/lkoYOt96RZrLyRfs56eTcCCCCAAAKTCSwh0HJnvN/mMZJ+qOjZOyX9YTptNuaH7H0lnV4ky9yE+DZJ92Hvz3fQ+JRfTqXgcfAetjlLzNLvIMv/nE8lzlkv70YAAQQQQGBSgaUEWnmWxLmYfDJxU3EKgNenma4uS4t+18PSvqKjcjx55uQ8Sa+ZVPdwXvZ3ko5N3XmIpHNn7Fq8TueCFGTNWB2vRgABBBBAYD6BJQVauZde0jtNUtw3VQp8KN2j+G5JvyPJ2cidedxXuXjmxScYryjp8jvovM/IgVWeMZtPed1vdpD6sWB5q5S2YepeeYnw/DBz5tOoXrKkIIAAAgggsFqBJQZaGdMB090lnTGhrjdWO43DW1OSzAlffbCvcuCbZxmdu8oB0dTF1x95n55PGLLpfWpd3ocAAgggsDeBJQdaESVfRnwtSc6ndOUeYp65+i+SXjxzGoIeTVrVR2Nah6lnmcpZLAdyHmv2Y63qK0JjEUAAAQS2Cawl0Irtv6qkJ0g6SdL108yULzDOFxZ7s/ZLJX1ckpcWvbeLMlwgnjh8dtr3Nvxt//hkzo3lQxD+exdfCu26vjj25TyPAAIIIIDAUgTWGGgtxa6VdsRAa4oLwb0U7JsAcvGpQgdcU13T08q40E8EEEAAgRUIEGitYJD23EQv5Tm9g4sPGXyfpEsGtMl7vZxZPqeJ8CseMEOutAFN4xEEEEAAAQTmESDQmsf10N76DkmnpE7dLFzs3KWfzir/iJSBP3/+yZLOYZmwCx+fQQABBBBYswCB1ppHr17bnxYuk35JSup6VO2+P9J5zHyiMBcvQzpocz40CgIIIIAAAgcvQKB18EM8WQe/Hd7kzPDbMvV7BsvLgz6tmIv3duW/JmsQL0IAAQQQQGDpAgRaSx+h5bQv7tX6REqV4fsOb5hOeB4n6eYbrlGaOiXEckRoCQIIIIAAAkcIEGjxFekj4BODXv7L1/FsezbnLvOs15g7Kvu0jc8igAACCCCwOAECrcUNyeIb5JktZ3H3rznnlfOV+Vqk30snEy9cfC9oIAIIIIAAAhUECLQqIFMFAggggAACCLQpQKDV5rjTawQQQAABBBCoIECgVQGZKhBAAAEEEECgTQECrTbHnV4jgAACCCCAQAUBAq0KyFSBAAIIIIAAAm0KEGi1Oe70GgEEEEAAAQQqCBBoVUCmCgQQQAABBBBoU4BAq81xp9cIIIAAAgggUEGAQKsCMlUggAACCCCAQJsCBFptjju9RgABBBBAAIEKAgRaFZCpAgEEEEAAAQTaFCDQanPc6TUCCCCAAAIIVBAg0KqATBUIIIAAAggg0KYAgVab406vEUAAAQQQQKCCAIFWBWSqQAABBBBAAIE2BQi02hx3eo0AAggggAACFQQItCogUwUCCCCAAAIItClAoNXmuNNrBBBAAAEEEKggQKBVAZkqEEAAAQQQQKBNAQKtNsedXiOAAAIIIIBABQECrQrIVIEAAggggAACbQoQaLU57vQaAQQQQAABBCoIEGhVQKYKBBBAAAEEEGhTgECrzXGn1wgggAACCCBQQYBAqwIyVSCAAAIIIIBAmwIEWm2OO71GAAEEEEAAgQoCBFoVkKkCAQQQQAABBNoUINBqc9zpNQIIIIAAAghUECDQqoBMFQgggAACCCDQpgCBVpvjTq8RQAABBBBAoIIAgVYFZKpAAAEEEEAAgTYFCLTaHHd6jQACCCCAAAIVBAi0KiBTBQIIIIAAAgi0KUCg1ea402sEEEAAAQQQqCBAoFUBmSoQQAABBBBAoE0BAq02x51eI4AAAggggEAFAQKtCshUgQACCCCAAAJtChBotTnu9BoBBBBAAAEEKggQaFVApgoEEEAAAQQQaFOAQKvNcafXCCCAAAIIIFBBgECrAjJVIIAAAggggECbAgRabY47vUYAAQQQQACBCgIEWhWQqQIBBBBAAAEE2hQg0Gpz3Ok1AggggAACCFQQINCqgEwVCCCAAAIIINCmAIFWm+NOrxFAAAEEEECgggCBVgVkqkAAAQQQQACBNgUItNocd3qNAAIIIIAAAhUECLQqIFMFAggggAACCLQpQKDV5rjTawQQQAABBBCoIECgVQGZKhBAAAEEEECgTQECrTbHnV4jgAACCCCAQAUBAq0KyFSBAAIIIIAAAm0KEGi1Oe70GgEEEEAAAQQqCBBoVUCmCgQQQAABBBBoU4BAq81xp9cIIIAAAgggUEGAQKsCMlUggAACCCCAQJsCBFptjju9RgABBBBAAIEKAgRaFZCpAgEEEEAAAQTaFCDQanPc6TUCCCCAAAIIVBAg0KqATBUIIIAAAggg0KYAgVab406vEUAAAQQQQKCCAIFWBWSqQAABBBBAAIE2BQi02hx3eo0AAggggAACFQQItCogUwUCCCCAAAIItClAoNXmuNNrBBBAAAEEEKggQKBVAZkqEEAAAQQQQKBNAQKtNsedXiOAAAIIIIBABQECrQrIVIEAAggggAACbQoQaLU57vQaAQQQQAABBCoIEGhVQKYKBBBAAAEEEGhTgECrzXGn1wgggAACCCBQQYBAqwIyVSCAAAIIIIBAmwIEWm2OO71GAAEEEEAAgQoCBFoVkKkCAQQQQAABBNoUINBqc9zpNQIIIIAAAghUECDQqoBMFQgggAACCCDQpgCBVpvjTq8RQAABBBBAoIIAgVYFZKpAAAEEEEAAgTYFCLTaHHd6jQACCCCAAAIVBAi0KiBTBQIIIIAAAgi0KUCg1ea402sEEEAAAQQQqCBAoFUBmSoQQAABBBBAoE0BAq02x51eI4AAAggggEAFAQKtCshUgQACCCCAAAJtChBotTnu9BoBBBBAAAEEKggQaFVApgoEEEAAAQQQaFOAQKvNcafXCCCAAAIIIFBBgECrAjJVIIAAAggggECbAgRabY47vUYAAQQQQACBCgIEWhWQqQIBBBBAAAEE2hQg0Gpz3Ok1AggggAACCFQQINCqgEwVCCCAAAIIINCmAIFWm+NOrxFAAAEEEECgggCBVgVkqkAAAQQQQACBNgUItNocd3qNAAIIIIAAAhUECLQqIFMFAggggAACCLQpQKDV5rjTawQQQAABBBCoIECgVQGZKhBAAAEEEECgTQECrTbHnV4jgAACCCCAQAUBAq0KyFSBAAIIIIAAAm0KEGi1Oe70GgEEEEAAAQQqCBBoVUCmCgQQQAABBBBoU4BAq81xp9cIIIAAAgggUEGAQKsCMlUggAACCCCAQJsCBFptjju9RgABBBBAAIEKAgRaFZCpAgEEEEAAAQTaFCDQanPc6TUCCCCAAAIIVBAg0KqATBUIIIAAAggg0KYAgVab406vEUAAAQQQQKCCAIFWBWSqQAABBBBAAIE2BQi02hx3eo0AAggggAACFQQItCogUwUCCCCAAAIItClAoNXmuNNrBBBAAAEEEKggQKBVAZkqEEAAAQQQQKBNAQKtNsedXiOAAAIIIIBABQECrQrIVIEAAggggAACbQoQaLU57vQaAQQQQAABBCoIEGhVQKYKBBBAAAEEEGhTgECrzXGn1wgggAACCCBQQYBAqwIyVSCAAAIIIIBAmwIEWm2OO71GAAEEEEAAgQoCBFoVkKkCAQQQQAABBNoUINBqc9zpNQIIIIAAAghUECDQqoBMFQgggAACCCDQpgCBVpvjTq8RQAABBBBAoIIAgVYFZKpAAAEEEEAAgTYFCLTaHHd6jQACCCCAAAIVBAi0KiBTBQIIIIAAAgi0KUCg1ea402sEEEAAAQQQqCBAoFUBmSoQQAABBBBAoE0BAq02x51eI4AAAggggEAFAQKtCshUgQACCCCAAAJtChBotTnu9BoBBBBAAAEEKggQaFVApgoEEEAAAQQQaFOAQKvNcafXCCCAAAIIIFBBgECrAjJVIIAAAggggECbAgRabY47vUYAAQQQQACBCgIEWhWQqQIBBBBAAAEE2hQg0Gpz3Ok1AggggAACCFQQINCqgEwVCCCAAAIIINCmAIFWm+NOrxFAAAEEEECgggCBVgVkqkAAAQQQQACBNgUItNocd3qNAAIIIIAAAhUECLQqIFMFAggggAACCLQpQKDV5rjTawQQQAABBBCoIECgVQGZKhBAAAEEEECgTQECrTbHnV4jgAACCCCAQAUBAq0KyFSBAAIIIIAAAm0KEGi1Oe70GgEEEEAAAQQqCBBoVUCmCgQQQAABBBBoU4BAq81xp9cIIIAAAgggUEGAQKsCMlUggAACCCCAQJsCBFptjju9RgABBBBAAIEKAgRaFZCpAgEEEEAAAQTaFCDQanPc6TUCCCCAAAIIVBAg0KqATBUIIIAAAggg0KYAgVab406vEUAAAQQQQKCCAIFWBWSqQAABBBBAAIE2BQi02hx3eo0AAggggAACFQQItCogUwUCCCCAAAIItClAoNXmuNNrBBBAAAEEEKgg8H8BB/pmif/QXBwAAAAASUVORK5CYII= regex: $ref: '#/components/schemas/regex' casesensitive: allOf: - $ref: '#/components/schemas/casesensitive' default: true replacementlimit: $ref: '#/components/schemas/replacementlimit' makeunsearchable: $ref: '#/components/schemas/makeunsearchable' pages: $ref: '#/components/schemas/pages0' default: '0' name: $ref: '#/components/schemas/name' async: allOf: - $ref: '#/components/schemas/async' default: false password: $ref: '#/components/schemas/password' timeout: $ref: '#/components/schemas/timeout' expiration: $ref: '#/components/schemas/expiration' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body summary: Search and Replace with Image description: Modify a PDF file by searching for specific text and replacing it with an image. /v1/pdf/edit/delete-text: post: tags: - Editing x-mint: href: /api-tester/pdf-search-text-and-delete operationId: post_v1_pdf_edit_delete-text requestBody: content: application/json: schema: type: object properties: file: $ref: '#/components/schemas/file' url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-search-and-replace/sample-agreement-template-signature-page-1.pdf searchstring: $ref: '#/components/schemas/searchstring' searchstrings: allOf: - $ref: '#/components/schemas/searchstrings' default: - '[CLIENT-NAME]' - '[CLIENT-COMPANY]' - '[CLIENT-SIGNATURE]' - 1 FEB 2023 regex: $ref: '#/components/schemas/regex' casesensitive: $ref: '#/components/schemas/casesensitive' replacementlimit: allOf: - $ref: '#/components/schemas/replacementlimit' default: 2 makeunsearchable: $ref: '#/components/schemas/makeunsearchable' pages: type: string description: 'Page indices/ranges (0-based). Items are comma-separated. Each item is one of: N (e.g., 0), N-M (e.g., 3-7), N- (open-ended, e.g., 10-), Whitespace is allowed. If not specified, the default configuration processes all pages.' example: 1,2,3-7 default: all pages name: $ref: '#/components/schemas/name' async: allOf: - $ref: '#/components/schemas/async' default: false password: $ref: '#/components/schemas/password' timeout: $ref: '#/components/schemas/timeout' expiration: $ref: '#/components/schemas/expiration' profiles: allOf: - $ref: '#/components/schemas/profiles' default: '{''UsePatch'': true, ''PatchColor'': ''#000000''}' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body summary: PDF Search and Delete Text description: Delete text from the PDF document with search strings. /v1/pdf/convert/to/csv: post: tags: - PDF Conversion x-mint: href: /api-tester/pdf-to-csv summary: PDF to CSV operationId: post_v1_pdf_convert_to_csv requestBody: content: application/json: schema: type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-to-csv/sample.pdf lang: allOf: - $ref: '#/components/schemas/lang' default: eng rect: $ref: '#/components/schemas/rect' unwrap: $ref: '#/components/schemas/unwrap' linegrouping: $ref: '#/components/schemas/linegrouping' inline: allOf: - $ref: '#/components/schemas/inline' default: true file: $ref: '#/components/schemas/file' pages: $ref: '#/components/schemas/pages0' default: 0- name: allOf: - $ref: '#/components/schemas/name' default: result.csv async: allOf: - $ref: '#/components/schemas/async' default: false password: $ref: '#/components/schemas/password' timeout: $ref: '#/components/schemas/timeout' expiration: $ref: '#/components/schemas/expiration' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Convert PDF and scanned images into CSV representation with layout, columns, rows, and tables. /v1/pdf/convert/to/json2: post: tags: - PDF Conversion x-mint: href: /api-tester/pdf-to-json/basic summary: PDF to JSON operationId: post_v1_pdf_convert_to_json2 requestBody: content: application/json: schema: type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-to-json/sample.pdf lang: $ref: '#/components/schemas/lang' rect: $ref: '#/components/schemas/rect' unwrap: $ref: '#/components/schemas/unwrap' linegrouping: $ref: '#/components/schemas/linegrouping' inline: allOf: - $ref: '#/components/schemas/inline' default: true pages: $ref: '#/components/schemas/pages0' file: $ref: '#/components/schemas/file' name: $ref: '#/components/schemas/name' async: allOf: - $ref: '#/components/schemas/async' default: false password: $ref: '#/components/schemas/password' expiration: $ref: '#/components/schemas/expiration' timeout: $ref: '#/components/schemas/timeout' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Convert PDF and scanned images into JSON representation with text, fonts, images, vectors, and formatting preserved. /v1/pdf/convert/to/json-meta: post: tags: - PDF Conversion x-mint: href: /api-tester/pdf-to-json/with-ai summary: PDF to JSON with AI operationId: post_v1_pdf_convert_to_json-meta requestBody: content: application/json: schema: type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-to-json/sample.pdf lang: $ref: '#/components/schemas/lang' rect: $ref: '#/components/schemas/rect' unwrap: $ref: '#/components/schemas/unwrap' linegrouping: $ref: '#/components/schemas/linegrouping' inline: allOf: - $ref: '#/components/schemas/inline' default: true file: $ref: '#/components/schemas/file' pages: $ref: '#/components/schemas/pages0' name: $ref: '#/components/schemas/name' async: allOf: - $ref: '#/components/schemas/async' default: false password: $ref: '#/components/schemas/password' timeout: $ref: '#/components/schemas/timeout' expiration: $ref: '#/components/schemas/expiration' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Convert PDF and scanned images into JSON using AI. /v1/pdf/convert/to/text: post: tags: - PDF Conversion x-mint: href: /api-tester/pdf-to-text/basic summary: PDF to Text operationId: post_v1_pdf_convert_to_text requestBody: content: application/json: schema: type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-to-text/sample.pdf lang: $ref: '#/components/schemas/lang' rect: $ref: '#/components/schemas/rect' unwrap: $ref: '#/components/schemas/unwrap' linegrouping: $ref: '#/components/schemas/linegrouping' inline: allOf: - $ref: '#/components/schemas/inline' default: true pages: $ref: '#/components/schemas/pages0' file: $ref: '#/components/schemas/file' name: $ref: '#/components/schemas/name' async: allOf: - $ref: '#/components/schemas/async' default: false password: $ref: '#/components/schemas/password' timeout: $ref: '#/components/schemas/timeout' expiration: $ref: '#/components/schemas/expiration' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Convert PDF and scanned images to text with layout preserved. This method uses OCR and reporoduces layout. /v1/pdf/convert/to/text-simple: post: tags: - PDF Conversion x-mint: href: /api-tester/pdf-to-text/simple summary: PDF to Text (Simple) operationId: post_v1_pdf_convert_to_text-simple requestBody: content: application/json: schema: type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-to-text/sample.pdf inline: allOf: - $ref: '#/components/schemas/inline' default: true pages: $ref: '#/components/schemas/pages0' file: $ref: '#/components/schemas/file' name: $ref: '#/components/schemas/name' async: allOf: - $ref: '#/components/schemas/async' default: false password: $ref: '#/components/schemas/password' timeout: $ref: '#/components/schemas/timeout' expiration: $ref: '#/components/schemas/expiration' lineending: type: string readOnly: true httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: This endpoint works faster and requires fewer credits as it is not using AI-powered layout analysis, OCR support, and also has no support for profiles for fine-tuning. For advanced conversion with layout analysis, OCR (for scanned pages), PDF repair, and other features please use the [PDF to Text](/api-reference/pdf-to-text) endpoint instead. /v1/pdf/convert/to/xls: post: tags: - PDF Conversion x-mint: href: /api-tester/pdf-to-excel/xls summary: PDF to XLS operationId: post_v1_pdf_convert_to_xls requestBody: content: application/json: schema: type: object properties: file: $ref: '#/components/schemas/file' url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-to-excel/sample.pdf lang: $ref: '#/components/schemas/lang' rect: $ref: '#/components/schemas/rect' unwrap: $ref: '#/components/schemas/unwrap' linegrouping: $ref: '#/components/schemas/linegrouping' pages: $ref: '#/components/schemas/pages0' name: $ref: '#/components/schemas/name' async: allOf: - $ref: '#/components/schemas/async' default: false password: $ref: '#/components/schemas/password' timeout: $ref: '#/components/schemas/timeout' expiration: $ref: '#/components/schemas/expiration' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Convert PDF to Excel(.xls) with layout and fonts preserved. /v1/pdf/convert/to/xlsx: post: tags: - PDF Conversion x-mint: href: /api-tester/pdf-to-excel/xlsx summary: PDF to XLSX operationId: post_v1_pdf_convert_to_xlsx requestBody: content: application/json: schema: type: object properties: file: $ref: '#/components/schemas/file' url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-to-excel/sample.pdf lang: $ref: '#/components/schemas/lang' rect: $ref: '#/components/schemas/rect' unwrap: $ref: '#/components/schemas/unwrap' linegrouping: $ref: '#/components/schemas/linegrouping' pages: $ref: '#/components/schemas/pages0' name: $ref: '#/components/schemas/name' async: allOf: - $ref: '#/components/schemas/async' default: false password: $ref: '#/components/schemas/password' timeout: $ref: '#/components/schemas/timeout' expiration: $ref: '#/components/schemas/expiration' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Convert PDF to Excel(.xlsx) with layout and fonts preserved. /v1/pdf/convert/to/xml: post: tags: - PDF Conversion x-mint: href: /api-tester/pdf-to-xml summary: PDF to XML operationId: post_v1_pdf_convert_to_xml requestBody: content: application/json: schema: type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-to-xml/sample.pdf lang: $ref: '#/components/schemas/lang' rect: $ref: '#/components/schemas/rect' unwrap: $ref: '#/components/schemas/unwrap' linegrouping: $ref: '#/components/schemas/linegrouping' inline: $ref: '#/components/schemas/inline' file: $ref: '#/components/schemas/file' name: $ref: '#/components/schemas/name' async: allOf: - $ref: '#/components/schemas/async' default: false pages: $ref: '#/components/schemas/pages0' password: $ref: '#/components/schemas/password' timeout: $ref: '#/components/schemas/timeout' expiration: $ref: '#/components/schemas/expiration' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Convert PDF to XML with information about text value, tables, fonts, images, objects positions. /v1/pdf/convert/to/html: post: tags: - PDF Conversion x-mint: href: /api-tester/pdf-to-html summary: PDF to HTML operationId: post_v1_pdf_convert_to_html requestBody: content: application/json: schema: type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-to-html/sample.pdf lang: $ref: '#/components/schemas/lang' rect: $ref: '#/components/schemas/rect' inline: allOf: - $ref: '#/components/schemas/inline' default: false pages: $ref: '#/components/schemas/pages0' name: $ref: '#/components/schemas/name' async: allOf: - $ref: '#/components/schemas/async' default: false password: $ref: '#/components/schemas/password' expiration: $ref: '#/components/schemas/expiration' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' simple: type: boolean description: Set `true` to convert to a plain HTML format. Default is the rich HTML & CSS format keeping the document design. readOnly: true columns: type: boolean description: Set `true` if the PDF document is arranged in columns like a newspaper. Default is `false`. readOnly: true file: $ref: '#/components/schemas/file' timeout: $ref: '#/components/schemas/timeout' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Convert PDF and scanned images into HTML representation with text, fonts, images, vectors, formatting preserved. /v1/pdf/convert/to/jpg: post: tags: - PDF Conversion x-mint: href: /api-tester/pdf-to-image/jpg summary: PDF to JPG operationId: post_v1_pdf_convert_to_jpg requestBody: content: application/json: schema: type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/encryption/sample_encrypted_aes128.pdf rect: $ref: '#/components/schemas/rect' inline: allOf: - $ref: '#/components/schemas/inline' default: true file: $ref: '#/components/schemas/file' pages: $ref: '#/components/schemas/pages0' default: '0' name: allOf: - $ref: '#/components/schemas/name' default: result.jpg async: allOf: - $ref: '#/components/schemas/async' default: false password: $ref: '#/components/schemas/password' timeout: $ref: '#/components/schemas/timeout' expiration: $ref: '#/components/schemas/expiration' profiles: allOf: - $ref: '#/components/schemas/profiles' default: '{ ''DataDecryptionAlgorithm'': ''AES128'', ''DataDecryptionKey'': ''HelloThisKey1234'', ''DataDecryptionIV'': ''TreloThisKey1234'' }' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Convert PDF to JPEG image with high quality rendering. /v1/pdf/convert/to/png: post: tags: - PDF Conversion x-mint: href: /api-tester/pdf-to-image/png summary: PDF to PNG operationId: post_v1_pdf_convert_to_png requestBody: content: application/json: schema: type: object properties: file: $ref: '#/components/schemas/file' url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-to-image/sample.pdf rect: $ref: '#/components/schemas/rect' inline: allOf: - $ref: '#/components/schemas/inline' default: true pages: $ref: '#/components/schemas/pages0' default: 0- name: $ref: '#/components/schemas/name' async: allOf: - $ref: '#/components/schemas/async' default: false password: $ref: '#/components/schemas/password' timeout: $ref: '#/components/schemas/timeout' expiration: $ref: '#/components/schemas/expiration' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Convert PDF to PNG image with high quality rendering. /v1/pdf/convert/to/webp: post: tags: - PDF Conversion x-mint: href: /api-tester/pdf-to-image/webp summary: PDF to WEBP operationId: post_v1_pdf_convert_to_webp requestBody: content: application/json: schema: type: object properties: file: $ref: '#/components/schemas/file' url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-to-image/sample.pdf rect: $ref: '#/components/schemas/rect' inline: allOf: - $ref: '#/components/schemas/inline' default: true pages: $ref: '#/components/schemas/pages0' default: 0- name: $ref: '#/components/schemas/name' async: allOf: - $ref: '#/components/schemas/async' default: false password: $ref: '#/components/schemas/password' timeout: $ref: '#/components/schemas/timeout' expiration: $ref: '#/components/schemas/expiration' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Convert PDF to WebP image with high quality rendering. /v1/pdf/convert/to/tiff: post: tags: - PDF Conversion x-mint: href: /api-tester/pdf-to-image/tiff summary: PDF to TIFF operationId: post_v1_pdf_convert_to_tiff requestBody: content: application/json: schema: type: object properties: file: $ref: '#/components/schemas/file' url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-to-image/sample.pdf rect: $ref: '#/components/schemas/rect' unwrap: $ref: '#/components/schemas/unwrap' pages: $ref: '#/components/schemas/pages0' default: 0- name: $ref: '#/components/schemas/name' async: allOf: - $ref: '#/components/schemas/async' default: false password: $ref: '#/components/schemas/password' timeout: $ref: '#/components/schemas/timeout' expiration: $ref: '#/components/schemas/expiration' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Convert PDF to TIFF image with high quality rendering. /v1/pdf/convert/from/doc: post: tags: - PDF Conversion x-mint: href: /api-tester/pdf-from-document/doc summary: PDF from DOC operationId: post_v1_pdf_convert_from_doc requestBody: content: application/json: schema: type: object properties: file: $ref: '#/components/schemas/file' url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/encryption/sample_encrypted_aes128.docx name: allOf: - $ref: '#/components/schemas/name' default: result.pdf async: allOf: - $ref: '#/components/schemas/async' default: false expiration: $ref: '#/components/schemas/expiration' profiles: allOf: - $ref: '#/components/schemas/profiles' default: '{ ''DataDecryptionAlgorithm'': ''AES128'', ''DataDecryptionKey'': ''HelloThisKey1234'', ''DataDecryptionIV'': ''TreloThisKey1234'' }' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Convert DOC, DOCX, RTF, TXT, XPS files into PDF. /v1/pdf/convert/from/csv: post: tags: - PDF Conversion x-mint: href: /api-tester/pdf-from-document/csv summary: PDF from CSV operationId: post_v1_pdf_convert_from_csv requestBody: content: application/json: schema: type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/csv-to-pdf/sample.csv name: allOf: - $ref: '#/components/schemas/name' default: result.pdf async: allOf: - $ref: '#/components/schemas/async' default: false file: $ref: '#/components/schemas/file' expiration: $ref: '#/components/schemas/expiration' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Convert CSV, XLS, XLSX files into PDF. /v1/pdf/convert/from/image: post: tags: - PDF Conversion x-mint: href: /api-tester/pdf-from-image summary: PDF from Image operationId: post_v1_pdf_convert_from_image requestBody: content: application/json: schema: type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/image-to-pdf/image1.png,https://pdfco-test-files.s3.us-west-2.amazonaws.com/image-to-pdf/image2.jpg name: $ref: '#/components/schemas/name' async: allOf: - $ref: '#/components/schemas/async' default: false file: $ref: '#/components/schemas/file' expiration: $ref: '#/components/schemas/expiration' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Convert JPG, PNG, TIFF image formats into PDF. /v1/pdf/convert/from/url: post: tags: - PDF Conversion x-mint: href: /api-tester/pdf-from-url summary: PDF from URL operationId: post_v1_pdf_convert_from_url requestBody: content: application/json: schema: required: - url type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: https://wikipedia.org/wiki/Wikipedia:Contact_us margins: allOf: - $ref: '#/components/schemas/margins' default: 5mm papersize: allOf: - $ref: '#/components/schemas/papersize' default: Letter orientation: allOf: - $ref: '#/components/schemas/orientation' default: Portrait printbackground: allOf: - $ref: '#/components/schemas/printbackground' default: true mediatype: allOf: - $ref: '#/components/schemas/mediatype' default: print donotwaitfullload: $ref: '#/components/schemas/donotwaitfullload' header: $ref: '#/components/schemas/header' footer: $ref: '#/components/schemas/footer' legacyrendition: $ref: '#/components/schemas/legacyrendition' name: $ref: '#/components/schemas/name' async: allOf: - $ref: '#/components/schemas/async' default: false expiration: $ref: '#/components/schemas/expiration' profiles: allOf: - $ref: '#/components/schemas/profiles' default: '{ "CustomScript": ";; // put some custom js script here "}' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' rendertimeout: $ref: '#/components/schemas/rendertimeout' templatedata: $ref: '#/components/schemas/templatedata' customscript: $ref: '#/components/schemas/customscript' additionalProperties: false required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Convert URL into PDF. This method will process any JavaScript which the webpage triggers when it loads. For example if the the webpage triggers a JavaScript popup window then that will be included in the conversion process. There is no option to disable JavaScript on the supplied HTML page. /v1/pdf/convert/from/html: post: tags: - PDF Conversion x-mint: href: /api-tester/pdf-from-html/convert summary: PDF from HTML operationId: post_v1_pdf_convert_from_html requestBody: content: application/json: schema: type: object properties: html: type: string description: HTML code. templateid: allOf: - $ref: '#/components/schemas/templateid' default: 1 templatedata: allOf: - $ref: '#/components/schemas/templatedata' default: '{"paid":true,"invoice_id":"0021","invoice_date":"August 29, 2041","invoice_dateDue":"September 29, 2041","issuer_name":"Sarah Connor","issuer_company":"T-800 Research Lab","issuer_address":"435 South La Fayette Park Place, Los Angeles, CA 90057","issuer_website":"www.example.com","issuer_email":"info@example.com","client_name":"Cyberdyne Systems","client_company":"Cyberdyne Systems","client_address":"18144 El Camino Real, Sunnyvale, California","client_email":"sales@example.com","items":[{"name":"T-800 Prototype Research","price":1000.0},{"name":"T-800 Cloud Sync Setup","price":300.0}],"discount":0.1,"tax":0.0725,"note":"Thank you for your support of advanced robotics."}' margins: allOf: - $ref: '#/components/schemas/margins' default: 40px 20px 20px 20px papersize: allOf: - $ref: '#/components/schemas/papersize' default: Letter orientation: allOf: - $ref: '#/components/schemas/orientation' default: Portrait printbackground: allOf: - $ref: '#/components/schemas/printbackground' default: true mediatype: allOf: - $ref: '#/components/schemas/mediatype' default: print donotwaitfullload: $ref: '#/components/schemas/donotwaitfullload' header: $ref: '#/components/schemas/header' footer: $ref: '#/components/schemas/footer' legacyrendition: $ref: '#/components/schemas/legacyrendition' rendertimeout: $ref: '#/components/schemas/rendertimeout' name: allOf: - $ref: '#/components/schemas/name' default: multipagedInvoiceWithQRCode.pdf async: allOf: - $ref: '#/components/schemas/async' default: false customscript: $ref: '#/components/schemas/customscript' expiration: $ref: '#/components/schemas/expiration' profiles: $ref: '#/components/schemas/profiles' additionalProperties: false required: - html - templateid required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Convert HTML into PDF. This method will process any JavaScript which the webpage triggers when it loads. For example if the the webpage triggers a JavaScript popup window then that will be included in the conversion process. There is no option to disable JavaScript on the supplied HTML page. /v1/templates/html: get: tags: - PDF Conversion x-mint: href: /api-tester/pdf-from-html/templates summary: Return All Templates operationId: get_v1_templates_html responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' description: Return all HTML templates for the current user. /v1/templates/html/{id}: get: tags: - PDF Conversion x-mint: href: /api-tester/pdf-from-html/template-id summary: Return HTML Template by ID description: "Returns HTML template by template\u2019s id." operationId: get_v1_templates_html_id parameters: - name: id in: path description: HTML template id required: true schema: type: string responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' /v1/pdf/convert/from/email: post: tags: - PDF Conversion x-mint: href: /api-tester/pdf-from-email summary: PDF from Email operationId: post_v1_pdf_convert_from_email requestBody: content: application/json: schema: type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/email-to-pdf/sample.eml margins: $ref: '#/components/schemas/margins' papersize: $ref: '#/components/schemas/papersize' orientation: $ref: '#/components/schemas/orientation' embedattachments: type: boolean default: true convertattachments: type: boolean name: allOf: - $ref: '#/components/schemas/name' default: email-with-attachments async: allOf: - $ref: '#/components/schemas/async' default: false header: $ref: '#/components/schemas/header' footer: $ref: '#/components/schemas/footer' file: $ref: '#/components/schemas/file' expiration: $ref: '#/components/schemas/expiration' profiles: allOf: - $ref: '#/components/schemas/profiles' default: '{"orientation": "landscape", "paperSize": "letter" }' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Convert email files (.msg or .eml) code into PDF. Extract attachments (if any) from input email and embeds into PDF as PDF attachments. /v1/xls/convert/to/csv: post: tags: - Excel Conversion x-mint: href: /api-tester/convert-from-excel/csv summary: Excel to CSV operationId: post_v1_xls_convert_to_csv requestBody: content: application/json: schema: type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/other/Input.xls worksheetindex: $ref: '#/components/schemas/worksheetindex' name: $ref: '#/components/schemas/name' async: allOf: - $ref: '#/components/schemas/async' default: false file: $ref: '#/components/schemas/file' quotationsymbol: type: string readOnly: true separatorsymbol: type: string readOnly: true timeout: $ref: '#/components/schemas/timeout' expiration: $ref: '#/components/schemas/expiration' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Converts a xls/xlsx file to csv. /v1/xls/convert/to/json: post: tags: - Excel Conversion x-mint: href: /api-tester/convert-from-excel/json summary: Excel to JSON operationId: post_v1_xls_convert_to_json requestBody: content: application/json: schema: type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/other/Input.xls worksheetindex: $ref: '#/components/schemas/worksheetindex' name: $ref: '#/components/schemas/name' async: allOf: - $ref: '#/components/schemas/async' default: false file: $ref: '#/components/schemas/file' timeout: $ref: '#/components/schemas/timeout' expiration: $ref: '#/components/schemas/expiration' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Converts a xls/xlsx/csv file to json. /v1/xls/convert/to/html: post: tags: - Excel Conversion x-mint: href: /api-tester/convert-from-excel/html summary: Excel to HTML operationId: post_v1_xls_convert_to_html requestBody: content: application/json: schema: type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/other/Input.xls worksheetindex: $ref: '#/components/schemas/worksheetindex' async: allOf: - $ref: '#/components/schemas/async' default: false file: $ref: '#/components/schemas/file' name: $ref: '#/components/schemas/name' timeout: $ref: '#/components/schemas/timeout' expiration: $ref: '#/components/schemas/expiration' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Converts a xls/xlsx/csv file to html. /v1/xls/convert/to/txt: post: tags: - Excel Conversion x-mint: href: /api-tester/convert-from-excel/text operationId: post_v1_xls_convert_to_txt requestBody: content: application/json: schema: type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/other/Input.xls worksheetindex: $ref: '#/components/schemas/worksheetindex' name: $ref: '#/components/schemas/name' async: allOf: - $ref: '#/components/schemas/async' default: false file: $ref: '#/components/schemas/file' timeout: $ref: '#/components/schemas/timeout' expiration: $ref: '#/components/schemas/expiration' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body summary: Excel to Text description: Converts a xls/xlsx/csv file to text. /v1/xls/convert/to/xml: post: tags: - Excel Conversion x-mint: href: /api-tester/convert-from-excel/xml operationId: post_v1_xls_convert_to_xml requestBody: content: application/json: schema: type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/other/Input.xls worksheetindex: $ref: '#/components/schemas/worksheetindex' name: $ref: '#/components/schemas/name' async: allOf: - $ref: '#/components/schemas/async' default: false file: $ref: '#/components/schemas/file' timeout: $ref: '#/components/schemas/timeout' expiration: $ref: '#/components/schemas/expiration' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body summary: Excel to XML description: Converts a xls/xlsx/csv file to xml. /v1/xls/convert/to/pdf: post: tags: - Excel Conversion x-mint: href: /api-tester/convert-from-excel/pdf summary: Excel to PDF operationId: post_v1_xls_convert_to_pdf requestBody: content: application/json: schema: type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/other/Input.xls worksheetindex: $ref: '#/components/schemas/worksheetindex' name: $ref: '#/components/schemas/name' async: allOf: - $ref: '#/components/schemas/async' default: false file: $ref: '#/components/schemas/file' autosize: $ref: '#/components/schemas/autosize' expiration: $ref: '#/components/schemas/expiration' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Converts a xls/xlsx/csv file to pdf. /v1/pdf/merge: post: tags: - PDF Merging & Splitting x-mint: href: /api-tester/merge/pdf summary: Merge PDF operationId: post_v1_pdf_merge requestBody: content: application/json: schema: type: object properties: file: $ref: '#/components/schemas/file' url: allOf: - $ref: '#/components/schemas/url' description: URL to the source file [`url` attribute](/api-reference/url-input-and-request-limits). If you use multiple URLs, please separate them with a comma (`,`) default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/encryption/sample_encrypted_aes128.pdf, https://pdfco-test-files.s3.us-west-2.amazonaws.com/encryption/sample_encrypted_aes128.pdf name: allOf: - $ref: '#/components/schemas/name' default: result.pdf async: allOf: - $ref: '#/components/schemas/async' default: false timeout: $ref: '#/components/schemas/timeout' expiration: $ref: '#/components/schemas/expiration' profiles: allOf: - $ref: '#/components/schemas/profiles' default: '{ ''DataDecryptionAlgorithm'': ''AES128'', ''DataDecryptionKey'': ''HelloThisKey1234'', ''DataDecryptionIV'': ''TreloThisKey1234'', ''DataEncryptionAlgorithm'': ''AES128'', ''DataEncryptionKey'': ''HelloThisKey1234'', ''DataEncryptionIV'': ''TreloThisKey1234'' }' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Merge multiple PDF files into a single PDF document. /v1/pdf/merge2: post: tags: - PDF Merging & Splitting x-mint: href: /api-tester/merge/various-files summary: Merge Various Document Type operationId: post_v1_pdf_merge2 requestBody: content: application/json: schema: type: object properties: file: $ref: '#/components/schemas/file' url: allOf: - $ref: '#/components/schemas/url' description: URL to the source file [`url` attribute](/api-reference/url-input-and-request-limits). If you use multiple URLs, please separate them with a comma (`,`) default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-merge/sample1.pdf,https://pdfco-test-files.s3.us-west-2.amazonaws.com/other/Input.xls, https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-merge/images-and-documents.zip name: $ref: '#/components/schemas/name' async: allOf: - $ref: '#/components/schemas/async' default: false timeout: $ref: '#/components/schemas/timeout' expiration: $ref: '#/components/schemas/expiration' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Merge PDF from two or more PDF, DOC, XLS, images, even ZIP with documents and images into a new PDF. This Merge 2 endpoint is similar to [Merge PDF](/api-reference/merge/pdf) but it also supports `zip`, `doc`, `docx`, `xls`, `xlsx`, `rtf`, `txt`, `png`, `jpg` files as source. This Merge2 endpoint also consumes more credits than [Merge PDF](/api-reference/merge/pdf) because of the internal conversions. /v1/pdf/split: post: tags: - PDF Merging & Splitting x-mint: href: /api-tester/pdf-split/by-pages summary: Split PDF operationId: post_v1_pdf_split requestBody: content: application/json: schema: type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-split/sample.pdf inline: allOf: - $ref: '#/components/schemas/inline' default: true pages: $ref: '#/components/schemas/pages1' default: 1-2,3- name: allOf: - $ref: '#/components/schemas/name' default: result.pdf async: allOf: - $ref: '#/components/schemas/async' default: false password: $ref: '#/components/schemas/password' file: $ref: '#/components/schemas/file' timeout: $ref: '#/components/schemas/timeout' expiration: $ref: '#/components/schemas/expiration' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Split a PDF into multiple PDF files using page indexes or page ranges. /v1/pdf/split2: post: tags: - PDF Merging & Splitting x-mint: href: /api-tester/pdf-split/by-text-search-or-barcode summary: Split PDF by Text Search operationId: post_v1_pdf_split2 requestBody: content: application/json: schema: required: - searchstring - url type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-split/split_by_barcode.pdf searchstring: allOf: - $ref: '#/components/schemas/searchstring' default: '[[barcode:qrcode,datamatrix /bytescout\.com/]]' regexsearch: allOf: - $ref: '#/components/schemas/regexsearch' default: false excludekeypages: type: boolean default: true casesensitive: allOf: - $ref: '#/components/schemas/casesensitive' default: false lang: $ref: '#/components/schemas/lang' inline: allOf: - $ref: '#/components/schemas/inline' default: true name: allOf: - $ref: '#/components/schemas/name' default: output-split-by-barcode async: allOf: - $ref: '#/components/schemas/async' default: false file: $ref: '#/components/schemas/file' password: $ref: '#/components/schemas/password' expiration: $ref: '#/components/schemas/expiration' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Split a PDF into multiple PDF files using page indexes or page ranges. /v1/pdf/info/fields: post: tags: - Forms x-mint: href: /api-tester/forms/info-reader operationId: post_v1_pdf_info_fields requestBody: content: application/json: schema: type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-form/f1040.pdf async: allOf: - $ref: '#/components/schemas/async' default: false password: $ref: '#/components/schemas/password' file: $ref: '#/components/schemas/file' timeout: $ref: '#/components/schemas/timeout' expiration: $ref: '#/components/schemas/expiration' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body summary: PDF Forms Info Reader description: Get information about fillable form fields inside a PDF file. /v1/pdf/find: post: tags: - Find & Search x-mint: href: /api-tester/pdf-find/basic operationId: post_v1_pdf_find requestBody: content: application/json: schema: required: - searchstring - url type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: pdfco-test-files.s3.us-west-2.amazonaws.compdf-to-text/sample.pdf file: $ref: '#/components/schemas/file' searchstring: allOf: - $ref: '#/components/schemas/searchstring' default: Invoice Date \d+/\d+/\d+ regexsearch: allOf: - $ref: '#/components/schemas/regexsearch' default: true wordmatchingmode: type: string casesensitive: $ref: '#/components/schemas/casesensitive' pages: $ref: '#/components/schemas/pages0' default: 0- name: allOf: - $ref: '#/components/schemas/name' default: output inline: allOf: - $ref: '#/components/schemas/inline' default: true async: allOf: - $ref: '#/components/schemas/async' default: false password: $ref: '#/components/schemas/password' timeout: $ref: '#/components/schemas/timeout' expiration: $ref: '#/components/schemas/expiration' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body summary: PDF Find Text description: Find text in PDF and get coordinates. Supports regular expressions. /v1/pdf/find/table: post: tags: - Find & Search x-mint: href: /api-tester/pdf-find/table operationId: post_v1_pdf_find_table requestBody: content: application/json: schema: type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: pdfco-test-files.s3.us-west-2.amazonaws.compdf-to-text/sample.pdf pages: $ref: '#/components/schemas/pages0' inline: allOf: - $ref: '#/components/schemas/inline' default: true async: allOf: - $ref: '#/components/schemas/async' default: false password: $ref: '#/components/schemas/password' expiration: $ref: '#/components/schemas/expiration' file: $ref: '#/components/schemas/file' name: $ref: '#/components/schemas/name' timeout: $ref: '#/components/schemas/timeout' profiles: allOf: - $ref: '#/components/schemas/profiles' default: '{ ''Mode'': ''Legacy'', ''ColumnDetectionMode'': ''BorderedTables'', ''DetectionMinNumberOfRows'': 1, ''DetectionMinNumberOfColumns'': 1, ''DetectionMaxNumberOfInvalidSubsequentRowsAllowed'': 0, ''DetectionMinNumberOfLineBreaksBetweenTables'': 0, ''EnhanceTableBorders'': false }' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body summary: Find Text in Table with AI description: AI powered document analysis can scan your document for tables and return the array of tables on pages with coordinates and information about columns detected in these tables. /v1/pdf/makesearchable: post: tags: - Find & Search x-mint: href: /api-tester/pdf-change-text-searchable/searchable summary: Make Text Searchable operationId: post_v1_pdf_makesearchable requestBody: content: application/json: schema: type: object properties: file: $ref: '#/components/schemas/file' url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/image-to-pdf/image2.jpg lang: allOf: - $ref: '#/components/schemas/lang' default: eng pages: $ref: '#/components/schemas/pages0' name: allOf: - $ref: '#/components/schemas/name' default: result.pdf async: allOf: - $ref: '#/components/schemas/async' default: false password: $ref: '#/components/schemas/password' expiration: $ref: '#/components/schemas/expiration' rect: $ref: '#/components/schemas/rect' timeout: $ref: '#/components/schemas/timeout' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: This method converts scanned PDF documents (where pages are fully or partially made from scanned images) or image files into a text-searchable PDF. It runs OCR and adds an invisible text layer on top of your document that can be used for text search, text indexing, etc. /v1/pdf/makeunsearchable: post: tags: - Find & Search x-mint: href: /api-tester/pdf-change-text-searchable/unsearchable operationId: post_v1_pdf_makeunsearchable requestBody: content: application/json: schema: type: object properties: file: $ref: '#/components/schemas/file' url: allOf: - $ref: '#/components/schemas/url' default: pdfco-test-files.s3.us-west-2.amazonaws.compdf-to-text/sample.pdf pages: $ref: '#/components/schemas/pages0' name: allOf: - $ref: '#/components/schemas/name' default: result.pdf async: allOf: - $ref: '#/components/schemas/async' default: false password: $ref: '#/components/schemas/password' timeout: $ref: '#/components/schemas/timeout' expiration: $ref: '#/components/schemas/expiration' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body summary: Make Text Unsearchable description: This method converts PDF files into a "text unsearchable" version by converting your PDF into a "scanned" PDF file which is effectively a flat image. /v2/pdf/compress: post: tags: - Document, File & System x-mint: href: /api-tester/pdf-compress operationId: post_v2_pdf_compress requestBody: content: application/json: schema: type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-compress/sample.pdf async: allOf: - $ref: '#/components/schemas/async' default: false name: $ref: '#/components/schemas/name' config: type: object additionalProperties: true description: For more information, see the [PDF Compress Configuration options](/api-reference/pdf-compress#config). default: images: color: skip: false downsample: skip: false downsample_ppi: 150 threshold_ppi: 225 compression: skip: false compression_format: jpeg compression_params: quality: 60 grayscale: skip: false downsample: skip: false downsample_ppi: 150 threshold_ppi: 225 compression: skip: false compression_format: jpeg compression_params: quality: 60 monochrome: skip: false downsample: skip: false downsample_ppi: 300 threshold_ppi: 450 compression: skip: false compression_format: ccitt_g4 compression_params: {} save: garbage: 4 additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body summary: PDF Compress description: Compress PDF files to reduce their size. /v1/pdf/optimize: post: tags: - Document, File & System deprecated: true x-mint: href: /api-tester/pdf-optimize summary: PDF Optimize operationId: post_v1_pdf_optimize requestBody: content: application/json: schema: type: object properties: file: $ref: '#/components/schemas/file' url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-optimize/sample.pdf name: allOf: - $ref: '#/components/schemas/name' default: output.pdf async: allOf: - $ref: '#/components/schemas/async' default: false password: $ref: '#/components/schemas/password' timeout: $ref: '#/components/schemas/timeout' expiration: $ref: '#/components/schemas/expiration' profiles: allOf: - $ref: '#/components/schemas/profiles' default: '{ ''ImageOptimizationFormat'': ''JPEG'', ''JPEGQuality'': 25, ''ResampleImages'': true, ''ResamplingResolution'': 120, ''GrayscaleImages'': false }' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Optimize a PDF file to reduce its size. /v1/pdf/info: post: tags: - Document, File & System x-mint: href: /api-tester/pdf-info-reader summary: PDF Info Reader operationId: post_v1_pdf_info requestBody: content: application/json: schema: type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/encryption/sample_encrypted_aes128.pdf async: allOf: - $ref: '#/components/schemas/async' default: false password: $ref: '#/components/schemas/password' file: $ref: '#/components/schemas/file' timeout: $ref: '#/components/schemas/timeout' expiration: $ref: '#/components/schemas/expiration' profiles: allOf: - $ref: '#/components/schemas/profiles' default: '{ ''DataDecryptionAlgorithm'': ''AES128'', ''DataDecryptionKey'': ''HelloThisKey1234'', ''DataDecryptionIV'': ''TreloThisKey1234'' }' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: "Get detailed information about a PDF document, it\u2019s properties and security permissions." /v1/job/check: post: tags: - Document, File & System x-mint: href: /api-tester/job-check summary: Background & Job Check operationId: post_v1_job_check requestBody: content: application/json: schema: required: - jobid type: object properties: jobid: type: string description: Id of processing that was started asynchronously default: '12345' timeout: $ref: '#/components/schemas/timeout' force: type: boolean additionalProperties: false required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Checks the [status](/api-reference/job-check/available-status-values) of a background job that was previously created with PDF.co API. Use this API to check the status of your asynchronous API calls. /v1/account/credit/balance: get: tags: - Document, File & System x-mint: href: /api-tester/account-balance-info summary: Get Account Balance Info operationId: get_v1_account_credit_balance responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' description: '' /v1/pdf/classifier: post: tags: - Document, File & System x-mint: href: /api-tester/document-classifier operationId: post_v1_pdf_classifier requestBody: content: application/json: schema: type: object properties: file: $ref: '#/components/schemas/file' url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/document-parser/sample-invoice.pdf rulescsv: type: string rulescsvurl: type: string casesensitive: $ref: '#/components/schemas/casesensitive' password: $ref: '#/components/schemas/password' async: allOf: - $ref: '#/components/schemas/async' default: false timeout: $ref: '#/components/schemas/timeout' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body summary: Document Classifier description: Automatically find class of input PDF, JPG, PNG document by analyzing its content using the built-in AI or custom defined classification rules. /v1/email/send: post: tags: - Document, File & System x-mint: href: /api-tester/email/send operationId: post_v1_email_send requestBody: content: application/json: schema: required: - from - smtppassword - smtpserver - smtpusername - subject - to - url type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-info/sample.pdf from: type: string default: John Doe to: type: string default: Partner replyto: type: string cc: type: string bcc: type: string subject: type: string default: Check attached sample pdf bodytext: type: string default: Please check the attached pdf bodyhtml: type: string default: Please check the attached pdf smtpserver: type: string default: smtp.gmail.com smtpport: type: string default: '587' smtpusername: type: string default: my@gmail.com smtppassword: type: string default: app specific password created as https://support.google.com/accounts/answer/185833 name: $ref: '#/components/schemas/name' async: allOf: - $ref: '#/components/schemas/async' default: false timeout: $ref: '#/components/schemas/timeout' expiration: $ref: '#/components/schemas/expiration' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body summary: Send Email with File description: Send an email. An email can be with or without attachment. /v1/email/decode: post: tags: - Document, File & System x-mint: href: /api-tester/email/decode summary: Extract Data from Email File operationId: post_v1_email_decode requestBody: content: application/json: schema: type: object properties: file: $ref: '#/components/schemas/file' url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/email-extractor/sample.eml inline: allOf: - $ref: '#/components/schemas/inline' default: true async: allOf: - $ref: '#/components/schemas/async' default: false profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Decode an email message to extract its components. /v1/email/extract-attachments: post: tags: - Document, File & System x-mint: href: /api-tester/email/extract-attachments summary: Extract Email Attachment operationId: post_v1_email_extract-attachments requestBody: content: application/json: schema: type: object properties: file: $ref: '#/components/schemas/file' url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/email-extractor/sample.eml inline: allOf: - $ref: '#/components/schemas/inline' default: true async: allOf: - $ref: '#/components/schemas/async' default: false profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Extract attachments from an email /v1/file/upload: post: tags: - Document, File & System x-mint: href: /api-tester/file-upload/upload summary: Upload Small File operationId: post_v1_file_upload requestBody: content: application/json: schema: required: - file type: object properties: file: $ref: '#/components/schemas/file' name: $ref: '#/components/schemas/name' additionalProperties: false required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: 'Uploads a small (up to 100KB) local file as a temporary file in PDF.co storage. Note: temporary files are automatically permanently removed after 1 hour.' /v1/file/delete: post: tags: - Document, File & System x-mint: href: /api-tester/file-upload/delete summary: Delete Temporary File operationId: post_v1_file_delete requestBody: content: application/json: schema: required: - url type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: https://pdf-temp-files.s3.amazonaws.com/b5c1e67d98ab438292ff1fea0c7cdc9d/sample.pdf httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Deletes temporary file (that was uploaded by you or generated by API). /v1/file/hash: post: tags: - Document, File & System x-mint: href: /api-tester/file-upload/hash summary: Get MD5 Hash of File by URL operationId: post_v1_file_hash requestBody: content: application/json: schema: type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: pdfco-test-files.s3.us-west-2.amazonaws.compdf-split/sample.pdf httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Calculate and return MD5 hash of file by url. Commonly used to control if the source document has been changed or not because every little change will cause hash string to differ as well. /v1/file/upload/url: get: tags: - Document, File & System x-mint: href: /api-tester/file-upload/upload-url-get summary: Upload File from URL operationId: get_v1_file_upload_url parameters: - name: url in: query description: URL of the file to upload. required: true schema: type: string - name: name in: query description: The name the file will be stored with. schema: type: string - name: httpusername in: query schema: type: string - name: httppassword in: query schema: type: string responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' description: Downloads file from a source url and uploads it as a temporary file. Temporary files are automatically permanently removed after 1 hour. post: tags: - Document, File & System x-mint: href: /api-tester/file-upload/upload-url-post summary: Upload File from URL description: Downloads file from a source url and uploads it as a temporary file. Temporary files are automatically permanently removed after 1 hour. operationId: post_v1_file_upload_url requestBody: content: application/json: schema: required: - url type: object properties: name: $ref: '#/components/schemas/name' url: $ref: '#/components/schemas/url' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body /v1/file/upload/base64: post: tags: - Document, File & System x-mint: href: /api-tester/file-upload/upload-base64 summary: Upload File Using Base64 operationId: post_v1_file_upload_base64 requestBody: content: application/json: schema: required: - file type: object properties: file: $ref: '#/components/schemas/file' name: $ref: '#/components/schemas/name' permanent: type: boolean description: Store file permanently in the internal storage readOnly: true additionalProperties: false required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Creates a temporary file using base64 source data. You may use this temporary file URL with other API methods. Temporary files are automatically permanently removed after 1 hour. /v1/file/upload/get-presigned-url: get: tags: - Document, File & System x-mint: href: /api-tester/file-upload/generate-presigned-url summary: Generate Pre-signed URL description: This method generates links to upload your local file to. Use this presignedUrl from the response to upload your file. Once you upload your file to this presignedUrl using PUT, you can use the url link to access the uploaded file. operationId: get_v1_file_upload_get_presigned_url parameters: - name: name in: query description: File name for the generated output, the input must be in string format. schema: type: string - name: contenttype in: query description: The content type of the uploaded file schema: type: string format: mime type - name: timeout in: query description: Timeout for output links in seconds. schema: type: string responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body /v1/pdf/security/add: post: tags: - Document, File & System x-mint: href: /api-tester/pdf-password/add operationId: post_v1_pdf_security_add requestBody: content: application/json: schema: type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-merge/sample1.pdf ownerpassword: type: string description: Owner password default: '12345' userpassword: type: string description: User password default: '54321' encryptionalgorithm: type: string default: AES_128bit allowaccessibilitysupport: type: boolean allowassemblydocument: type: boolean allowprintdocument: type: boolean default: false allowfillforms: type: boolean default: false allowmodifydocument: type: boolean default: false allowcontentextraction: type: boolean default: false allowmodifyannotations: type: boolean default: false printquality: type: string default: LowResolution name: allOf: - $ref: '#/components/schemas/name' default: output-protected.pdf expiration: $ref: '#/components/schemas/expiration' async: allOf: - $ref: '#/components/schemas/async' default: false profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body summary: Add Password to PDF description: Add password and security limitations to PDF /v1/pdf/security/remove: post: tags: - Document, File & System x-mint: href: /api-tester/pdf-password/remove operationId: post_v1_pdf_security_remove requestBody: content: application/json: schema: type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-security/ProtectedPDFFile.pdf password: allOf: - $ref: '#/components/schemas/password' default: admin@123 name: allOf: - $ref: '#/components/schemas/name' default: unprotected expiration: $ref: '#/components/schemas/expiration' async: allOf: - $ref: '#/components/schemas/async' default: false profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body summary: Remove Password from PDF description: Remove existing limits and password from PDF file. /v1/pdf/edit/delete-pages: post: tags: - Pages x-mint: href: /api-tester/pdf-delete-pages summary: PDF Delete Pages operationId: post_v1_pdf_edit_delete-pages requestBody: content: application/json: schema: type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: pdfco-test-files.s3.us-west-2.amazonaws.compdf-split/sample.pdf pages: $ref: '#/components/schemas/pages1' default: 1-2 name: allOf: - $ref: '#/components/schemas/name' default: result.pdf file: $ref: '#/components/schemas/file' async: allOf: - $ref: '#/components/schemas/async' default: false password: $ref: '#/components/schemas/password' timeout: $ref: '#/components/schemas/timeout' expiration: $ref: '#/components/schemas/expiration' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body description: Deletes selected pages inside a PDF file. /v1/pdf/edit/rotate: post: tags: - Pages x-mint: href: /api-tester/pdf-rotate/basic operationId: post_v1_pdf_edit_rotate requestBody: content: application/json: schema: type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-optimize/sample.pdf pages: $ref: '#/components/schemas/pages0' default: 0-2,4 angle: type: string default: 90 name: allOf: - $ref: '#/components/schemas/name' default: result.pdf async: $ref: '#/components/schemas/async' password: $ref: '#/components/schemas/password' file: $ref: '#/components/schemas/file' timeout: $ref: '#/components/schemas/timeout' expiration: $ref: '#/components/schemas/expiration' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body summary: Rotate Selected Pages description: Rotates selected pages inside a PDF file. /v1/pdf/edit/rotate/auto: post: tags: - Pages x-mint: href: /api-tester/pdf-rotate/auto operationId: post_v1_pdf_edit_rotate_auto requestBody: content: application/json: schema: type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-fix-rotation/rotated_pages.pdf lang: $ref: '#/components/schemas/lang' name: allOf: - $ref: '#/components/schemas/name' default: result.pdf async: $ref: '#/components/schemas/async' password: $ref: '#/components/schemas/password' file: $ref: '#/components/schemas/file' timeout: $ref: '#/components/schemas/timeout' expiration: $ref: '#/components/schemas/expiration' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body summary: Auto-rotate Pages with AI description: Uses AI to automatically fix the rotation of pages inside scanned PDF based on text analysis. To change text language change the lang parameter (eng by default). /v1/barcode/generate: post: tags: - Barcodes x-mint: href: /api-tester/barcode/generate summary: Barcodes Generator description: Generate high quality barcode images. Supports QR Code, Datamatrix, Code 39, Code 128, PDF417 and many other barcode types. operationId: post_v1_barcode_generate requestBody: content: application/json: schema: type: object properties: value: type: string description: Barcode value. default: abcdef123456 type: allOf: - $ref: '#/components/schemas/type' default: QRCode decorationimage: type: string name: allOf: - $ref: '#/components/schemas/name' default: barcode.png async: allOf: - $ref: '#/components/schemas/async' default: false timeout: $ref: '#/components/schemas/timeout' expiration: $ref: '#/components/schemas/expiration' inline: allOf: - $ref: '#/components/schemas/inline' default: true profiles: $ref: '#/components/schemas/profiles' additionalProperties: false required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body /v1/barcode/read/from/url: post: tags: - Barcodes x-mint: href: /api-tester/barcode/read summary: Barcodes Reader description: Read barcodes from images and PDF. Can read all popular barcode types from QR Code and Code 128, EAN to Datamatrix, PDF417, GS1 and many other barcodes. operationId: post_v1_barcode_read_from_url requestBody: content: application/json: schema: type: object properties: url: allOf: - $ref: '#/components/schemas/url' default: https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-to-html/sample.pdf types: type: string description: 'Comma-separated list of barcode types to decode. Valid types: `AustralianPostCode`, `Aztec`, `CircularI2of5`, `Codabar`, `CodablockF`, `Code128`, `Code16K`, `Code39`, `Code39Extended`, `Code39Mod43`, `Code39Mod43Extended`, `Code93`, `DataMatrix`, `EAN13`, `EAN2`, `EAN5`, `EAN8`, `GS1`, `GS1DataBarExpanded`, `GS1DataBarExpandedStacked`, `GS1DataBarLimited`, `GS1DataBarOmnidirectional`, `GS1DataBarStacked`, `GTIN12`, `GTIN13`, `GTIN14`, `GTIN8`, `IntelligentMail`, `Interleaved2of5`, `ITF14`, `MaxiCode`, `MICR`, `MicroPDF`, `MSI`, `PatchCode`, `PDF417`, `Pharmacode`, `PostNet`, `PZN`, `QRCode`, `RoyalMail`, `RoyalMailKIX`, `Trioptic`, `UPCA`, `UPCE`, `UPU`.' default: Checkbox,UnderlinedField pages: $ref: '#/components/schemas/pages0' async: allOf: - $ref: '#/components/schemas/async' default: false file: $ref: '#/components/schemas/file' timeout: $ref: '#/components/schemas/timeout' profiles: $ref: '#/components/schemas/profiles' httpusername: $ref: '#/components/schemas/httpusername' httppassword: $ref: '#/components/schemas/httppassword' additionalProperties: false required: - url - types required: false responses: '200': $ref: '#/components/responses/Success' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/NotEnoughCredits' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '408': $ref: '#/components/responses/Timeout' '429': $ref: '#/components/responses/TooManyRequests' '441': $ref: '#/components/responses/InvalidPassword' '442': $ref: '#/components/responses/DamagedDocument' '443': $ref: '#/components/responses/PermissionsError' '444': $ref: '#/components/responses/ProfilesParsingError' '445': $ref: '#/components/responses/TimeoutError' '446': $ref: '#/components/responses/MissingFiles' '447': $ref: '#/components/responses/InvalidTemplate' '448': $ref: '#/components/responses/InvalidUrlOrHtml' '449': $ref: '#/components/responses/InvalidIndexRange' '450': $ref: '#/components/responses/InvalidPageRange' '452': $ref: '#/components/responses/InvalidUrl' '454': $ref: '#/components/responses/InvalidParameters' '500': $ref: '#/components/responses/InternalServerError' x-codegen-request-body-name: body x-original-swagger-version: '2.0'