> ## Documentation Index > Fetch the complete documentation index at: https://docs.app.strix.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get chat credit usage > Not available on self-hosted deployments (returns 404). Get the credits that Chat can spend and the cost of a typical chat in the organization. Give `chat_id` to also get what that chat has used and what automatic top-up bought for it. A chat uses part of a credit for each agent step. Requires the chat:read scope. ## OpenAPI ````yaml /openapi.json get /chat/usage openapi: 3.1.0 info: title: Strix API version: 1.0.0 description: >- Public REST API for the Strix autonomous penetration testing platform. Manage scans, vulnerabilities, assets, schedules, API tokens, and webhooks. servers: - url: /api/v1 description: Strix v1 API security: - BearerAuth: [] tags: - name: Scans description: Launch, monitor, and manage security scans. - name: Vulnerabilities description: View and triage discovered vulnerabilities. - name: Assets description: Domains and repositories registered for scanning. - name: Schedules description: Recurring scan schedules (Pro plan). - name: Tokens description: Manage API tokens for authentication. - name: Webhooks description: Configure webhook subscriptions for real-time event notifications. - name: Organization description: Workspace configuration for the authenticated organization. - name: Members description: Manage organization members and roles. - name: Invitations description: List and revoke organization invitations. - name: PR Reviews description: Automated security review of pull requests. - name: Connectors description: Network connectors for scanning internal/private targets. - name: Knowledge description: >- Organization knowledge base: documents, policies, and repo profiles that steer the agent. - name: Uploads description: Upload source/code/documentation archives for whitebox scans. - name: Integrations description: Third-party integrations (GitLab, Bitbucket, ticketing). - name: Chat description: Conversational agent sessions. - name: Analytics description: Aggregate dashboard analytics. - name: Test Users description: >- Per-domain test accounts (with optional MFA) the agent authenticates as during scans. - name: License description: Self-hosted license state, entitlements, and aggregate usage. - name: Supply Chain description: >- SBOM inventory, supply-chain findings, scans, and policy for connected repositories. - name: CLI description: >- Device authorization endpoints that let the Strix CLI and coding agents sign in and receive an API token. - name: Billing description: Credit balance, agent-payable top-ups, and automatic top-up settings. - name: Workspaces description: List, create, and switch workspaces. - name: Asset Discovery description: >- Passive reconnaissance runs that map the organization's external attack surface, and the discovered-asset inventory they fill. - name: Run Logs description: Persisted engine logs and the diagnostics bundle of a self-hosted install. paths: /chat/usage: get: tags: - Chat summary: Get chat credit usage description: >- Not available on self-hosted deployments (returns 404). Get the credits that Chat can spend and the cost of a typical chat in the organization. Give `chat_id` to also get what that chat has used and what automatic top-up bought for it. A chat uses part of a credit for each agent step. Requires the chat:read scope. operationId: getChatCreditUsage parameters: - name: chat_id in: query required: false description: Chat id. The response then includes the usage of this chat. schema: type: string format: uuid responses: '200': description: Chat credit usage. content: application/json: schema: $ref: '#/components/schemas/ChatCreditUsage' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalError' security: - BearerAuth: - chat:read components: schemas: ChatCreditUsage: type: object properties: available_microcredits: type: integer description: >- Credits that Chat can still spend, in microcredits. One credit is 1,000,000 microcredits. chat_microcredits: type: integer description: >- 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: type: integer description: >- 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: type: boolean description: >- 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: type: - integer - 'null' description: >- 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: type: integer description: >- Number of recent chats behind `typical_chat_microcredits`. At most 50. required: - available_microcredits - chat_microcredits - chat_auto_topup_credits - chat_auto_topup_cap_lifted - typical_chat_microcredits - sampled_chats ErrorResponse: type: object properties: detail: type: string description: Human-readable explanation of the error. code: type: string description: >- Stable machine-readable error code. `insufficient_scope` means the token does not hold the scope that this endpoint requires. required_scope: $ref: '#/components/schemas/ApiV1Scope' description: >- Scope that the caller must add to the token. Returned with the `insufficient_scope` code. docs: type: string format: uri description: Documentation page that explains how to resolve the error. hint: type: string description: >- One instruction that resolves the error. For `insufficient_scope`, a CLI session gets the `strix cloud session scopes set full` or `strix cloud login --scope-profile full` command, and an API token gets the settings page where the user creates a token with the scope. When the owner's role cannot hold the scope, the hint asks for a role change instead. required: - detail ApiV1Scope: type: string enum: - scans:read - scans:write - vulnerabilities:read - vulnerabilities:write - dependencies:read - schedules:read - schedules:write - assets:read - assets:write - organizations:read - organizations:write - members:read - members:write - invitations:read - invitations:write - webhooks:read - webhooks:write - tokens:write - audit:read - pr_reviews:read - pr_reviews:write - connectors:read - connectors:write - knowledge:read - knowledge:write - uploads:write - integrations:read - integrations:write - chat:read - chat:write - scans:message - analytics:read - llm:read - llm:write - test_users:read - test_users:write - discovery:read - discovery:write - license:read - supply_chain:read - supply_chain:write - billing:read - billing:write - logs:read responses: Unauthorized: description: Missing or invalid API token. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Forbidden: description: >- Insufficient permissions or missing scope. A missing scope returns the `insufficient_scope` code, the `required_scope` field, and a `hint` with the command or page that grants the scope, so a client can request the correct scope and retry. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' NotFound: description: Resource not found. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' InternalError: description: Internal server error. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' securitySchemes: BearerAuth: type: http scheme: bearer description: >- API token obtained from the Tokens endpoint or CLI device login. Include as `Authorization: Bearer `. Requests made with a managed CLI session also include `X-Strix-Workspace: ` to pin a process to the workspace it started in; recovery endpoints report the current workspace after a concurrent switch. ````