README.md

Charles API

The API consists of two parts, the REST API and the Streaming API.

Rest API

Unless otherwise noted, the REST API follows the JSON API specification. Requests for fetching, creating and updating different types of resources are documented by resource type:

• Activity
• Branch
• Commit
• Comment
• Deployment
• Notification
• Project
• Preview

See the errors section in the JSON API documentation for information on error responses.

Streaming API

The Streaming API provides support for realtime updates based on server-sent events.