DocusPocus Developer API v1 reference

Tenant-scoped server-to-server API. Every resource owner is derived from the authenticated dpk_ API key, and every scope is constrained by the owner's current plan. All non-GET operations require Idempotency-Key.

Profile

  • GET /me Get API-key owner and quota summary

Zones

  • GET /zones List owned zones
  • POST /zones Create a zone within the account plan quota
  • GET /zones/{zoneId} Get an owned zone
  • PATCH /zones/{zoneId} Update an owned zone

Files

  • GET /zones/{zoneId}/folders List active folders
  • POST /zones/{zoneId}/folders Create a folder
  • PATCH /zones/{zoneId}/folders/{folderId} Rename or move a folder
  • DELETE /zones/{zoneId}/folders/{folderId} Archive a folder tree and its file records
  • POST /zones/{zoneId}/secure-documents Convert a PDF into an encrypted Zone protected file without creating an e-book
  • GET /zones/{zoneId}/files List safe file metadata
  • POST /zones/{zoneId}/files Upload one file with multipart form data
  • POST /zones/{zoneId}/files/presigned-upload Create a 15-minute single-use upload token
  • POST /zones/{zoneId}/files/confirm-upload Validate and register a presigned upload
  • GET /zones/{zoneId}/files/{fileId} Get safe file metadata
  • PATCH /zones/{zoneId}/files/{fileId} Rename, move, or change file download permission
  • DELETE /zones/{zoneId}/files/{fileId} Archive a file record without deleting storage bytes

E-books

  • GET /ebooks List owned e-books without storage or encryption secrets
  • POST /ebooks Convert a PDF to an encrypted protected file, create an e-book, and optionally attach zones
  • GET /ebooks/{ebookId} Get safe e-book metadata
  • PATCH /ebooks/{ebookId} Update metadata, purchase URL, version history, or preview settings
  • PUT /ebooks/{ebookId}/content Replace PDF content while preserving book UUID and encryption key
  • PUT /ebooks/{ebookId}/cover Replace the public e-book cover image
  • GET /ebooks/{ebookId}/versions List archived e-book versions without storage paths
  • GET /ebooks/{ebookId}/zones List owned zones attached to an e-book
  • PUT /ebooks/{ebookId}/zones/{zoneId} Attach an owned e-book to an owned zone
  • DELETE /ebooks/{ebookId}/zones/{zoneId} Detach an owned e-book from an owned zone

Access

  • POST /zones/{zoneId}/access-grants Grant, extend, schedule cancellation, or revoke zone access
  • POST /zones/{zoneId}/access-grants/revoke Force zone access revocation
  • POST /ebooks/{ebookId}/licenses Grant or extend an e-book license
  • POST /ebooks/{ebookId}/licenses/revoke Force e-book license revocation

Audit

  • GET /audit List this tenant's Developer API mutation audit