Skip to main content

Documentation Index

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

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

Use GET /credits to inspect the authenticated organization’s available balance before kicking off more work or to display usage state in an admin UI.

​
Response shape

The credits response includes:
  • organization_id: the owner of the balance
  • total_available_credits: the current spendable total
  • total_expiring_in_30_days: credits that will age out soon
  • buckets: individual balance buckets with remaining tokens and expiration timestamps

​
Example

curl https://api.capout.ai/credits \
  -H "capout-api-key: $CAPOUT_API_KEY"

{
  "organization_id": "org_123",
  "total_available_credits": 1800,
  "total_expiring_in_30_days": 250,
  "buckets": [
    {
      "id": "bucket_01",
      "tokens_remaining": 1200,
      "expires_at": "2026-05-10T00:00:00Z",
      "created_at": "2026-03-10T00:00:00Z"
    },
    {
      "id": "bucket_02",
      "tokens_remaining": 600,
      "expires_at": null,
      "created_at": "2026-04-01T00:00:00Z"
    }
  ]
}

​
Practical uses

  • Block or warn before high-volume upload and export batches
  • Surface expiring balances in internal tooling
  • Reconcile billing and usage reports against CapOut balances