Paperful Icon

Paperfuldocs

Papers

Retrieve a paper

Retrieve a paper and check its status.

Retrieve a paper by its ID to read its details, such as its name, page count and processing status.

Retrieve a paper by ID

const paper = await paperful.papers.get("00000000-0000-0000-0000-000000000000");

console.log(paper.fileName, paper.pages, paper.status);

Check if a paper is ready

A paper's content is available once its status is ready. You can then read its graph or search it.

const paper = await paperful.papers.get("00000000-0000-0000-0000-000000000000");

if (paper.status === "ready") {
  // read the graph, search it, etc.
}
StatusDescription
pendingThe paper was accepted and is being processed.
readyProcessing finished. The paper is ready to use.
failedProcessing couldn't be completed.
deletedThe paper was deleted.

Upload a paper

Upload a document and wait for it to be processed.

List papers

List and filter the papers in your workspace.

On this page

Retrieve a paper by IDCheck if a paper is ready