API Reference
The machine-readable shape of every endpoint below — request/response schemas, exact field types — is published as OpenAPI:
This page is the curated, human-readable index. It lists only the customer-facing surface — nothing here calls into an operator-only, webhook, or internal route, and the OpenAPI document enforces the same boundary structurally (see Security below).
Identity
| Method | Path | Scope |
|---|---|---|
GET |
/api/v1/me |
account.read |
Feed
| Method | Path | Scope |
|---|---|---|
GET |
/api/v1/feed |
feed.read |
See Feed API.
Taxonomy & subscriptions
| Method | Path | Scope |
|---|---|---|
GET |
/api/v1/taxonomy |
subscription.manage |
GET |
/api/v1/subscriptions |
subscription.manage |
PUT |
/api/v1/subscriptions |
subscription.manage |
AI usage visibility
| Method | Path | Scope |
|---|---|---|
GET |
/api/v1/ai-usage |
ai.usage.read |
GET |
/api/v1/ai-images |
ai.images.read |
See Usage & Quotas.
Account / Site / Credential self-management
| Method | Path | Scope |
|---|---|---|
GET / PUT |
/api/v1/account |
account.manage |
GET / POST |
/api/v1/account/sites |
account.manage |
GET / PUT |
/api/v1/account/sites/{siteId} |
account.manage |
GET / POST |
/api/v1/account/sites/{siteId}/credentials |
account.manage |
POST |
/api/v1/account/sites/{siteId}/credentials/{credentialId}/revoke |
account.manage |
GET |
/api/v1/account/sites/{siteId}/entitlements |
account.manage |
Most integrations manage these from the dashboard instead of calling this surface directly — it exists for programmatic account management.
Billing
| Method | Path | Scope |
|---|---|---|
POST |
/api/v1/billing/checkout |
billing.manage |
GET |
/api/v1/billing/subscription |
billing.manage |
POST |
/api/v1/billing/subscription/cancel |
billing.manage |
Most integrations manage billing from the dashboard instead — see the dashboard's Billing page.
Public media
| Method | Path | Auth |
|---|---|---|
GET |
/media/generated/{key} |
None required |
See Images & Media.
Versioning
/api/v1 is the current, and only, public version.
- Within
v1, changes should remain additive where possible. - An existing field is never removed or given an incompatibly different meaning without a version change.
- This is not a formal SLA, deprecation-duration promise, or notice-period commitment — it
describes the convention this API follows, not a contractual guarantee. If a breaking change is
ever genuinely needed, it would be introduced as a new version (
v2), decided separately.
See the Changelog for what's actually changed so far.
A note on scope
Every endpoint above requires a Credential scope from the customer-issuable list — see API Keys & Scopes. Nothing in this reference, or in the published OpenAPI document, ever includes an operator-only, webhook, or internal route — those are structurally excluded, not just omitted from this page's authoring.