API v1.0

Nucleus One API Documentation

Build powerful integrations with our comprehensive REST API. Full documentation, code examples, and interactive testing.

RESTful

Modern REST API design

99.9%

API uptime SLA

100ms

Average response time

v1.0

Stable API version

Quick Start

Get up and running in minutes

Base URL: https://client-api.nucleus.one/api/v1
HTTPS Only

Full API Reference Available

The complete API documentation with all endpoints, detailed schemas, and interactive testing is available at:

https://client-api.nucleus.one/api/v1/docs
POST
/auth/login

Authenticate user and receive access token

GET
/documents
Auth Required

List all documents with pagination and filtering

POST
/documents
Auth Required

Upload a new document

GET
/documents/{id}
Auth Required

Get document details by ID

DELETE
/documents/{id}
Auth Required

Delete a document

GET
/folders
Auth Required

List all folders in the workspace

POST
/folders
Auth Required

Create a new folder

GET
/workflows
Auth Required

List all workflows

POST
/workflows/{id}/execute
Auth Required

Execute a workflow on documents

GET
/users
Auth Required

List all users in the organization

POST
/users
Auth Required

Create a new user

POST
/search
Auth Required

Search across all documents and metadata

GET
/webhooks
Auth Required

List all configured webhooks

POST
/webhooks
Auth Required

Create a new webhook

GET
/projects
Auth Required

List all projects in your workspace

POST
/projects
Auth Required

Create a new project

GET
/tasks
Auth Required

List all tasks

POST
/tasks
Auth Required

Create a new task

GET
/forms
Auth Required

List all forms

POST
/forms/{id}/submissions
Auth Required

Submit a form

Developer Resources

Everything you need to build with Nucleus One

SDKs & Libraries

Official SDKs for popular languages and frameworks

JavaScript/TypeScript
Python
PHP
Ruby
Java
.NET
View all SDKs
Webhooks

Real-time notifications for document events

  • Document uploaded
  • Workflow completed
  • User actions
Configure webhooks
API Status

Real-time API health and performance metrics

API Status
Operational
Uptime (30d)99.99%
Avg Response98ms
View status page

Start Building with Nucleus One

Join thousands of developers building powerful document management solutions

Free

Development API access

1M+

API calls per month

24/7

Developer support