profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialБлогPhilosophy
DocsTutorialБлогPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyНаписание скриптов в конструкторе шаблоновProject ScaffoldingМедиатека

Без интерфейса

Быстрый стартSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

Обзор REST APIgetConnect your websitegetПолучить маршрутыgetGET /routegetПолучение блоковgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetПолучить компонентыgetGET /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

Предоставляет отчет о примерном использовании токенов перевода и использовании байтов базы данных по таблицам для организации.

Предоставляет отчет о примерном использовании токенов перевода (по языкам) и об использовании байтов базы данных по таблицам для организации WorkOS.

Аутентификация: Bearer JWT (WorkOS).

Параметры запроса

ПараметрТипОбязательныйПримечания
orgIduuidдаОрганизация WorkOS, для которой формируется отчет.

Ответ

{
  "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": "..."
  }
}

Количество токенов является оценочным (эвристика примерно 4 символа на токен плюс фиксированное выделение для системного промпта на вызов) и не соответствует тарифицируемому использованию у провайдера. Использование базы данных суммирует pg_column_size для каждой принадлежащей таблицы; двоичные файлы изображений, хранящиеся в объектном хранилище, не учитываются. Обратите внимание на особенность сериализации: внутри byLanguage ключи токенов записаны в snake_case (estimated_prompt_tokens и т. д.), тогда как родительский объект использует camelCase.

Пример

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

Ошибки

  • 400 — отсутствует или недействительный orgId
  • 401 — отсутствует или недействительный JWT
  • 500 — сбой запроса
Continue Reading
Previous‹PATCH /translationsNextPOST /csv›