Documents

Convert a document’s current file to PDF

Files the CURRENT file of an office document — Word (.docx, .doc), Excel (.xlsx, .xls), PowerPoint (.pptx, .ppt), OpenDocument, RTF or HTML — or of a JPEG, PNG or TIFF image (every page of a scan) again as a PDF, as the document’s NEXT version: the old file stays in the version history, the new one is named like it with .pdf for its extension, and a title that ended in the old extension ends in .pdf too. An office file’s PDF is the one the Archivio shows as its preview. REFUSED for a document that is a PDF already; for text, mail and ZIP files; for an e-invoice (.xml) or a signed .p7m, whose original is the record itself; and for a class that does not accept PDFs. status: "converted" means the PDF is the current version now; status: "pending" means it is being printed first and becomes the current version by itself in a few seconds — call documents_get and read file.filename. Like any new version, the PDF is then read again: conversion, extraction and indexing.

Examples

  • Turn this Word contract into a PDF POST /api/v1/rest/documents/11111111-2222-4333-8444-555555555555/pdf
post/api/v1/rest/documents/{id}/pdf

Request

  • Base URL: https://api.custodo.ai
  • URL: https://api.custodo.ai/api/v1/rest/documents/{id}/pdf
  • Auth: HTTP bearer

Path parameters

idstring uuid required

The document whose current file becomes a PDF.

Headers

X-Tenant-Idstring uuid

The organisation to act in. An API key is bound to exactly one, so this is optional for a key and must match the one it was minted for.

Response

Done. data is the tool’s own answer.

oktrue required
dataunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.