Documents

Copy a Document

You can use this endpoint to copy the document, without having to reupload it to Document Engine

The copy includes the latest version of all layers and their annotations from the original document.

A common use case for copying a document is to create an individual document for each user, allowing different users work on the same file without seeing each other's annotations. However, we recommend leveraging named Instant Layers for such scenarios as they provide more efficient API to manage different document versions.

post/api/copy_document

Request

  • Base URL: http://localhost:5000
  • URL: http://localhost:5000/api/copy_document
  • Auth: one of:
    • API key in header Authorization
    • HTTP bearer

Request body

document_idstring

The ID of the original document.

new_document_idstring

The ID of the copy.

Example request

{
  "document_id": "7KPSA689RP53HB64GKKZX64XFV",
  "new_document_id": "7KPS5BP7NVPZPFTEMN2PB6D3XY"
}

Response

The document has been copied.

Example response

{
  "data": {
    "document_id": "7KPS5BP7NVPZPFTEMN2PB6D3XY"
  }
}

Changes

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