Supported formats
A TIFF’s frames, a deck’s slides and a workbook’s sheets are its pages. An animated GIF is read as its first frame.
Pulse refuses a document before any work starts if its type isn’t supported (
415), or it’s empty or can’t be opened, such as a password-protected PDF (422). Save .doc and .ppt files as .docx and .pptx first, and scan paper documents at 300 DPI where you can.
Send a document
Parse, Classify and pipelines take one document. Send it in one of two ways, never both:file: the file itself, as amultipart/form-datapart.file_url: a link Pulse downloads: anhttporhttpsURL anyone can download, such as a presigned URL, or thes3://orgs://URL of a public object.
parse_id instead. To send many documents at once, use Batch.
This request uploads a PDF from disk and parses it:
client is the one from SDKs. In a multipart request, send config as a JSON text part.
Give a file_url a file extension in its path, or serve it with a matching Content-Type, so Pulse reads it as the right type.
Links Pulse won't download
Links Pulse won't download
Pulse refuses a
file_url that points to a private or internal address, a sign-in page, or a share link that opens a viewer instead of the file. For Google Drive, Dropbox, OneDrive and similar services, send a direct download link.Redirects and slow servers
Redirects and slow servers
Pulse follows up to 5 redirects. If the server takes more than 30 seconds to answer, the request fails with
504 (FILE_DOWNLOAD_TIMEOUT).Size limits
These limits apply to Parse and to pipelines:
For a TIFF over 100 MB, the URL’s path must end in
.tif or .tiff.
Long documents
Send long documents withasync: true (Jobs and results). However long a document is, it returns one result.
A long document can complete with some pages missing. failed_pages then lists those pages, counting from 1, warnings includes PAGES_FAILED, and markdown marks each missing page with an HTML comment. Treat a missing or empty failed_pages as every page parsed.