Get started

Introduction

What the OpenCharts REST API can do, the base URL, and how the pieces fit together.

What you can build

The OpenCharts REST API lets you create and manage every OpenCharts artifact from your own backend: flowcharts, whiteboards, notes, presentations, sheets, boards, personas, and agents. It also runs the same AI engines Theo uses in-app, so you can generate images, video, music, code builds, and deep research with one key.

Everything here is the real production surface. The API reference is generated live from the OpenAPI document that also drives the contract tests, so paths, methods, scopes, and schemas can never drift from what is deployed.

Plan access

The API is available on the Unlimited and Teams plans. Manage keys and webhooks in the Developers hub.

Base URL

All endpoints live under one base URL:

base url
https://www.opencharts.com/api/v1

Authentication

Every request authenticates with a Bearer token: the same oc_ API keys the OpenCharts MCP server accepts, carrying read, write, and ai scopes.

curl
curl https://www.opencharts.com/api/v1/account \
  -H "Authorization: Bearer oc_your_api_key"

Details in Authentication.

Async work

Long-running generation (video, music, code builds, research) returns a job envelope immediately instead of blocking. Poll it at GET /jobs/{id}, or register a webhook and skip polling entirely. See Jobs & polling and Webhooks.

OpenAPI spec

The full machine-readable specification (OpenAPI 3.1) is served live, ready for codegen and API tooling:

spec
https://www.opencharts.com/api/v1/openapi

Next steps

Start with the Quickstart, skim Envelopes & errors so responses never surprise you, then jump into the build guides for Chat, Sheets, Media generation, and more.