Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

API token obtained from the Tokens endpoint or CLI device login. Include as Authorization: Bearer <token>. Requests made with a managed CLI session also include X-Strix-Workspace: <organization_id> to pin a process to the workspace it started in; recovery endpoints report the current workspace after a concurrent switch.

Scopes

chat:read

Query Parameters

chat_id
string<uuid>

Chat id. The response then includes the usage of this chat.

Response

Chat credit usage.

available_microcredits
integer
required

Credits that Chat can still spend, in microcredits. One credit is 1,000,000 microcredits.

chat_microcredits
integer
required

Credits that the chat given with chat_id has used so far, in microcredits. Zero when no chat_id is given.

chat_auto_topup_credits
integer
required

Credits that automatic top-up bought for the chat given with chat_id. Zero when no chat_id is given.

chat_auto_topup_cap_lifted
boolean
required

True when an admin lifted the per-chat automatic top-up limit for the chat given with chat_id. False when no chat_id is given.

typical_chat_microcredits
integer | null
required

Median total cost of the organization's recent chats, in microcredits. Null when the organization has no charged chat in the last 90 days.

sampled_chats
integer
required

Number of recent chats behind typical_chat_microcredits. At most 50.