Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.chamelio.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Chamelio External API

The Chamelio External API provides programmatic access to core platform functionality, enabling you to:
  • 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: 
https://platform.chamelio.ai

​
Authentication

The External API uses API key authentication. All requests must include a valid API key in the request header.

​
API Key Header

Include your API key in every request using the X-API-Key header: 
X-API-Key: ca_your_api_key_here

​
API Key Format

API keys follow the format: ca_<base64url_encoded_string> Example: ca_xYz123AbCdEfGhIjKlMnOpQrStUvWxYz

​
Authentication Errors

The API will return a 401 Unauthorized status code with the following error messages:
ErrorDescription
API key requiredThe X-API-Key header is missing from the request
Invalid API keyThe provided API key does not exist in our system
API key is inactiveThe API key has been deactivated
API key has been revokedThe API key has been permanently revoked
API key has expiredThe API key has passed its expiration date

​
Available Endpoints

​
Organization

Get Organization Info

Retrieve your organization details and configuration

​
Core

Upload Document

Upload documents to Core for processing

Update File Attributes

Update or add metadata attributes on an existing document

​
Workflows

List Workflows

Retrieve all available workflows for your organization

Get Workflow Schema

Get the complete schema for a specific workflow version

Initiate Workflow

Start a new workflow task instance with specified variables

​
Tasks

Get Task

Retrieve the current status and details of a workflow task

Cancel Task

Cancel a running or pending workflow task

Approve Task

Submit approval or rejection decision for a task

Get Approval Details

Retrieve approval details, eligible approvers, and pending variables for a task

Initiate Signature

Start the signature collection process for a task

List Task Files

Retrieve all files associated with a workflow task

Download Step Document

Download a document generated by a specific workflow step

Get Latest Negotiation Version

Retrieve the latest negotiation document version for a workflow task

Get Signed Documents

Retrieve all signed documents associated with a workflow task

​
Files

Download File

Download a file by its unique file ID

​
Webhooks

Webhooks Overview

Subscribe to real-time event notifications for documents, workflows, and tasks

​
Getting Started

  1. Obtain an API key - Generate an API key through the Chamelio web application
  2. Test authentication - Make a test request to /users/org-info to verify your API key
  3. Start integrating - Use the available endpoints to build your integration

​
Support

For questions about the API or integration support, contact our team at support@chamelio.ai.