Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.katalo.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Usage summary

The usage summary endpoint combines entitlement state, billing-period usage, job totals, and the active rate-limit policy for the calling organization. 
GET /api/v1/usage/summary

curl https://app.katalo.ai/api/v1/usage/summary \
  -H "Authorization: Bearer $KATALO_API_KEY"
FieldMeaning
entitlementCurrent API access and billing entitlement state.
billing_periodActive billing period boundaries.
usageBilling-period usage totals.
jobsJob totals by state.
rate_limitsActive limit policy for the calling organization.

​
Billing events ledger

The billing events endpoint is a cursor-paginated ledger of API-originated usage events. Use it for reconciliation and audit, not job state. 
GET /api/v1/billing/events

curl "https://app.katalo.ai/api/v1/billing/events?limit=100" \
  -H "Authorization: Bearer $KATALO_API_KEY"
FieldMeaning
event_idStable public id for the ledger event.
job_idGeneration job associated with the billing event.
usage_typeUsage category recorded by the API.
config_fingerprintStable fingerprint for distinct configuration reconciliation.
created_atTime the billing event was recorded.
next_cursorCursor for the next page, if more results are available.

​
Reconciliation guidance

Use event_id, job_id, and config_fingerprint as your primary reconciliation keys. They are public identifiers and do not require depending on hidden internal ids.