- Retrieve organization information - Access details about your organization and configuration
- Manage documents in Core - Programmatically upload documents and update their attributes
- Manage workflows - List, initiate, and monitor workflow execution
- Control tasks - Get task status, approve, cancel, and manage task operations
- Handle files - Download files and documents associated with workflows
- Receive webhooks - Subscribe to real-time event notifications for documents, workflows, and tasks
- Integrate with your systems - Connect Chamelio with your existing tech stack
Base URL
All API requests should be made to:Choose your access model
Chamelio offers two ways to authenticate, and they behave differently. Pick the one that matches what you are building before you write any code - the credential you use determines the base path, the permissions that apply, and who your calls are attributed to.API Keys
A single organization-wide credential. Every call has full access to everything in the
organization. Best for trusted server-to-server integrations you control end to end.
OAuth Apps
A registered application that acts on behalf of a specific user, limited to the scopes that user
consented to. Best for applications used by more than one person, or where a call should never
reach data its user cannot see.
How they compare
Getting Started
1
Pick an access model
Read API Keys or OAuth Apps and choose
based on the comparison above.
2
Get a credential
Generate an API key, or register an OAuth application and complete a token request.
3
Verify it works
Call
GET /users/org-info with an API key, or GET /v2/users/user-info with an access token.
Both are read-only and confirm your credential resolves to the right organization.4
Start integrating
Work through the endpoints in your section’s navigation group.
Webhooks
Webhooks are independent of the access model you choose.Webhooks Overview
Subscribe to real-time event notifications for documents, workflows, and tasks