Getting Started

Getting started

Import APIs

Easily bring in external documents or data sources into your workspace:

• POST /v2/docs/imports — Initiate a new document import job.
• GET /v2/docs/imports/{importId}/status — Check the real-time status of an ongoing or completed import.

Use these endpoints to automate data ingestion, monitor import progress, and handle large-scale document imports with minimal manual effort.

File Management APIs

Manage your files and document hierarchy with full CRUD support:

• POST /v2/docs/files — Create a new file entry.
• GET /v2/docs/files/{fileId} — Retrieve detailed information about a file.
• PATCH /v2/docs/files/{fileId} — Update file metadata or attributes.
• DELETE /v2/docs/files/{fileId} — Permanently remove a file.
• GET /v2/docs/files/{fileId}/children — List child files or sub-documents within a parent file.

These endpoints provide developers with granular control over document structure, enabling features such as nested folders, file versioning, and structured content management.

File Uploads API

Handle raw file uploads efficiently:

• Apps should call this API first POST /v2/docs/file_uploads, then /v2/docs/imports/, finally /v2/docs/imports/{importId}/status.

This endpoint integrates seamlessly with the File Management APIs for a smoother end-to-end workflow.

Why It Matters

This release makes it easier for developers to:

• Build automated document ingestion pipelines
• Manage complex file hierarchies programmatically
• Support file uploads at scale with robust monitoring and control

Whether you're syncing data from external sources, managing collaborative document repositories, or processing user uploads, these new APIs lay the foundation for a more powerful document management experience.