Get started

Quickstart

Create a key, make your first request, and have Theo build a flowchart in under five minutes.

Create an API key
Open the Developers hub, create a key, and copy it immediately (it is shown once and stored hashed). Keep it server-side, e.g. as OPENCHARTS_API_KEY in your environment.
2
Your first request
GET /account is the whoami: it confirms auth and returns the account the key acts as.
```
curl https://www.opencharts.com/api/v1/account \
  -H "Authorization: Bearer $OPENCHARTS_API_KEY"
```

Create with Theo

One chat turn can create real artifacts. Ask for a flowchart and read it off the response's artifacts array (requires the ai scope):

curl https://www.opencharts.com/api/v1/chat \
  -H "Authorization: Bearer $OPENCHARTS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Create a flowchart of a SaaS onboarding funnel",
    "mode": "fast",
    "stream": false
  }'

Open the result

Each project artifact carries its project id plus an absolute openUrl deep link into the OpenCharts editor (/editor/{projectId} for flowcharts and whiteboards; notes, presentations, sheets, code, and boards each have their own route — see the Chat guide). The thread itself also appears in the account's in-app sidebar:

response (abridged)

{
  "conversationId": "6870f2...",
  "message": {
    "role": "assistant",
    "content": "Here is your onboarding funnel...",
    "artifacts": [
      {
        "type": "flowchart",
        "title": "SaaS onboarding funnel",
        "projectId": "6870f3...",
        "projectType": "chart",
        "openUrl": "https://www.opencharts.com/editor/6870f3..."
      }
    ]
  },
  "usage": { "inputTokens": 812, "outputTokens": 964 }
}

What's next

Read Authentication for scopes, Jobs & polling for async generation, and Webhooks to get pushed when work finishes.

Tip

The whole surface is browsable in the API reference: press / there to filter endpoints instantly.