Skip to main content
GET
Get current workspace quota and billing information.
This endpoint returns your remaining credits, plan, and billing cycle. It does not consume credits. For how each API endpoint is priced, see Credit costs.

Use Cases

  • Monitor API Usage: Track your credit consumption to avoid hitting limits and ensure uninterrupted service
  • Manage Billing: Monitor your billing cycle and plan details for better cost management
  • Optimize Performance: Analyze usage patterns to determine if you need to upgrade your plan

Authorizations

X-API-Key
string
header
required

API key required for authentication. Add your API key in the X-API-Key header.

Response

Successfully retrieved the current workspace quota.

name
string
required

The name of the workspace (maximum 55 characters)

Maximum string length: 55
uid
string<uuid>
credits_left
number
default:0
credits_max
integer
default:0
credits_used
number
default:0
plan_name
string | null
current_month_start
string<date-time> | null
current_month_end
string<date-time> | null