​

Introduction

The ChartDB API enables programmatic access to manage and auto-update your database diagrams. It supports authenticated requests using API keys, follows standard HTTP methods and response codes, and accepts JSON-formatted request and response bodies. Use the API to sync your schema changes, automate diagram generation, and integrate ChartDB into your CI/CD workflows or internal tools.

​

Base URL

All API requests should be made to the following base URL:

https://api.chartdb.com/api

​

Authentication

To authenticate your requests, include an API key in the Authorization header:

Authorization: Bearer ch_123456789

Your API key can be found in your ChartDB dashboard settings. Keep it secure and never share it publicly.

​

Response Format

All responses are returned in JSON format. Successful responses will include status & message fields:

{
  "status": "success",
  "message": "Diagram updated successfully"
}

Error responses will include status & message fields:

{
  "status": "error",
  "message": "Invalid API key"
}

​

Request Format

For POST and PUT requests, send data in JSON format with the appropriate Content-Type header:

Content-Type: application/json

​

API Versioning

The current version is api. We include versioning in the URL path:

https://api.chartdb.com/api/update_diagram

Future versions will be announced with appropriate migration guides and deprecation notices.