Read the account’s credit state without treating a displayed balance as unlimited admission.
Practical procedure
- Use the actual credits surface or GET /credits under the authenticated company identity.
- Inspect current entitlement and any available usage details alongside the balance. Paid admission can still refuse an operation for policy, capacity or account state.
- Keep reserved and settled usage concepts separate in reports and reread account state after a completed operation.
Call the supported chat contract
Normal web chat and the customer CLI use GoCux Gateway. Provider routing stays inside the service. The model catalog advertises the GoCux route alias gocux-deep, not an upstream provider identity. A compatible chat client supplies its message history and an explicit data-classification header; GoCux applies identity, policy, paid admission and credit reservation before a provider request.
Contract example
Developer examples below describe routes on an authorized, configured GoCux control-plane base URL. They are request shapes or operation references, not claims that a particular public hostname exposes the API. Use the workspace for the corresponding human workflow; availability and permissions depend on the actual deployment.
Operation reference for this workflow
GET /creditsInspect the result
Read the returned choices and handle an error response before showing a completed answer. When streaming, consume complete events and distinguish connection closure from a successful terminal result. GoCux route aliases are product contracts; do not let a client-selected upstream model bypass server routing or display provider identities as customer configuration.
What to keep explicit
This is the GoCux credit workflow, not an external service balance API. Avoid publishing fabricated numeric balances or treating a cached value as current.
Handle incomplete and refused work
Declare X-GoCux-Data-Classification exactly once. A data_classification field in the chat-completions body is rejected rather than used as the declaration. Missing classification is unclassified and can be refused by policy. An optional Idempotency-Key helps identify an operation, but a paid replay can return 409 without replaying the original response or contacting the provider again.
Continue with related guides
Bring this workflow into your workspace.
Set the scope. Review the evidence. Approve the steps that need it.