Test Nucleus One APIs
Interactively
Make real API calls, test endpoints, and explore responses in our interactive playground. Perfect for testing integrations and learning the API.
Get your API key from the Nucleus One developer console
Retrieve a list of documents with optional filtering and pagination
/DocumentsParameters
What is the Nucleus One API Playground?
The Nucleus One API Playground is an interactive testing environment designed for developers to explore, test, and integrate with the Nucleus One REST API. Unlike traditional API documentation that only provides static examples, our playground allows you to make real API calls directly from your browser, see live responses, and experiment with different parameters and configurations in real-time.
Whether you're building a custom integration, testing workflows, or learning how to use the Nucleus One API, the playground provides instant feedback and helps you understand API behavior without writing any code. Simply enter your API key, select an endpoint, configure parameters, and click Send to see actual responses from our production API servers.
The playground supports all major Nucleus One API operations including document management, project creation, task assignment, user management, form submissions, and folder organization. Each endpoint is fully documented with parameter descriptions, example values, and expected response formats to help you get started quickly.
Key Features
Live API Testing
Make real API calls directly from your browser. Test endpoints with your actual API key and see live responses from production servers. Perfect for validating integrations before deploying code.
Code Generation
Automatically generate cURL commands and request URLs based on your configurations. Copy and paste generated code directly into your applications, saving development time and reducing errors.
Smart Filtering
Browse endpoints by category including Documents, Projects, Forms, Tasks, Users, and Folders. Use the search function to quickly find specific API operations across all categories.
Parameter Configuration
Configure query parameters, path variables, headers, and request bodies through an intuitive interface. All required fields are clearly marked, with helpful descriptions and example values provided.
Response Inspection
View detailed response information including status codes, headers, response bodies, and request timing. JSON responses are automatically formatted for easy reading and debugging.
Secure Authentication
Test with your personal API keys in a secure environment. API keys are never stored or logged, ensuring your credentials remain private and secure during testing sessions.
Common Use Cases
Testing Document Upload Workflows
Before implementing document upload features in your application, use the playground to test the upload endpoint with different file types, sizes, and metadata configurations. Verify that your API key has the correct permissions and understand the response format before writing code.
Exploring Project Management APIs
Experiment with creating projects, assigning tasks, and managing workflows. The playground helps you understand the relationships between projects, tasks, and users before building complex project management integrations.
Learning API Response Structures
See actual API responses in real-time to understand data structures, field types, and nested objects. This hands-on approach helps you design your data models and parse responses correctly in your applications.
Debugging Integration Issues
When your integration isn't working as expected, use the playground to isolate issues. Compare your application's requests with working playground requests to identify parameter mismatches, authentication problems, or incorrect request formats.
Generating Integration Code
Use the automatic cURL command generation to create working examples for your development team. Share these commands in documentation, tickets, or chat to help teammates understand exactly how to call specific endpoints.
Getting Started with the API Playground
Obtain Your API Key
Visit the Nucleus One developer console to generate your personal API key. Each key is tied to your account and provides secure access to your organization's data through the API.
Enter Your Credentials
Paste your API key into the Authentication section at the top of the playground. The base URL is pre-configured to point to the production Nucleus One API servers, but you can change it if testing against a different environment.
Select an Endpoint
Browse endpoints by category or use the search function to find specific operations. Click on any endpoint to view its parameters, required fields, and documentation.
Configure Parameters
Fill in the required parameters (marked with an asterisk) and any optional parameters you want to test. The playground provides helpful descriptions and example values for each field.
Send Request and Review Response
Click the "Send Request" button to make the API call. The response section will display the status code, headers, response body, and request timing. Use this information to verify the API is working as expected.
Copy Code for Your Application
Once you have a working request, expand the Request Details section to view and copy the generated cURL command or request URL. Use this code as a starting point for your integration.
Need Help?
Explore our comprehensive documentation and resources