Skip to main content
GET
Read today's preview allowance

Authorizations

X-API-Key
string
header
required

Response

Successful Response

What is left of the workspace's free preview allowance today.

limit
integer
required

How many preview units the workspace may use per UTC day; 0 is none.

remaining
integer | null
required

How many it may still use today; a preview needing more is refused (a step's preview says what writing it needs in preview_units). Null when the count cannot be read right now, and previews are then not refused.

resets_at
string<date-time>
required

When the allowance starts again: midnight UTC.

used
integer | null
required

How many it has used today, never more than limit; null when the count cannot be read right now.