Need to manage API keys, view logs, or check usage?Open the Developer portal →

Quickstart

From zero to a successful API call in 60 seconds.

You'll need a Circa account. Sign up at app.circa.ai, then open the Developer portal and generate an API key in API keys → Create new key. The plain key (circa_live_…) is shown once — copy it.

Pick Live or Test when you create the key — test keys remain revealable in the portal, live keys are shown once.

Every public API request must include both x-api-key and x-team-id. Read the team id off Team Settings → General (the gear icon next to the team selector in the app navbar); it has a copy button.

Make your first request

curl -s 'https://api.circa.ai/public/me' \
  -H 'x-api-key: circa_live_REPLACE_ME' \
  -H 'x-team-id: TEAM_ID_FROM_OVERVIEW' \
  -H 'Circa-Version: 2026-05-11.obsidian'

A successful call returns your profile:

200OK
{
  "id": "u_a13c…",
  "email": "dev@example.com",
  "firstname": "Ada",
  "lastname": "Lovelace",
  "recentTeam": "t_72f3…"
}

What's next