profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyCEL Scripting in Template BuilderProject ScaffoldingMedia Library

Headless

Quick startSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

REST API OverviewgetConnect your websitegetGET /routesgetGET /routegetGET /blocksgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPOST /translationpatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /usage

Report an org's estimated translation token usage and per-table database byte usage.

Report a WorkOS org's estimated translation token usage (by language) and per-table database byte usage.

Auth: Bearer JWT (WorkOS).

Query parameters

ParamTypeRequiredNotes
orgIduuidyesThe WorkOS organization to report on.

Response

{
  "orgId": "...",
  "translations": {
    "translations": 120,
    "estimatedPromptTokens": 45000,
    "estimatedCompletionTokens": 42000,
    "estimatedTotalTokens": 87000,
    "byLanguage": [
      {
        "language": "fr",
        "translations": 40,
        "estimated_prompt_tokens": 15000,
        "estimated_completion_tokens": 14000,
        "estimated_total_tokens": 29000
      }
    ],
    "note": "..."
  },
  "database": {
    "totalBytes": 1048576,
    "totalHuman": "1.0 MB",
    "byTable": [ { "table": "documents", "rows": 42, "bytes": 500000 } ],
    "note": "..."
  }
}

Token counts are estimates (a ~4-chars-per-token heuristic plus a fixed per-call system-prompt allowance), not the provider's billed usage. Database usage sums pg_column_size per owned table; image binaries stored in object storage are not counted. Note the serde quirk: inside byLanguage the token keys are snake_case (estimated_prompt_tokens, etc.) while the parent object uses camelCase.

Example

curl '{CMS_API_URL}/usage?orgId=<uuid>' \
  -H 'Authorization: Bearer <workos-jwt>'

Errors

  • 400 β€” missing or invalid orgId
  • 401 β€” missing or invalid JWT
  • 500 β€” query failure
Continue Reading
Previousβ€ΉPATCH /translationsNextPOST /csvβ€Ί