Skip to main content
GET
Analysis credits and API request usage
This reference is generated from the canonical Ultiwrite OpenAPI contract, shared with the native API documentation. Follow the quickstart to obtain approved account access before calling the API.

Authorizations

Authorization
string
header
required

Create a key at /settings/api after an administrator approves your account. The key is shown once, can be revoked, and shares the account request allowance with other keys and partner OAuth grants. Send only in Authorization. These keys are not accepted by MCP or the legacy provisioned routes.

Response

Usage.

metered
boolean
required
allowance
integer | null
required

Lifetime analyses granted. Null when not metered or unlimited.

used
integer | null
required
inProgress
integer | null
required

Reserved by analyses that have not finished.

remaining
integer | null
required
chargedFor
string
required
purchase
string
required
apiRequests
object