Skip to content
GOCUX
Documentation
GOCUX / Documentationgetting started

Understand credits and paid admission

Read billing state and usage without treating a documentation example as a price quote.

Read billing state and usage without treating a documentation example as a price quote.

Practical procedure

  1. Open the current GoCux pricing and billing surfaces for the plan and entitlement available to your account. Do not copy another service’s processor prices into a GoCux estimate.
  2. Bound the output size of a model operation and inspect admission failures separately from provider failures. A payment-verifying or unavailable-entitlement state can stop work before execution.
  3. Keep an operation identifier alongside usage records. Separate a reserved amount, a settled usage amount and a refund or released reservation in reports.

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.

POST /v1/chat/completions X-GoCux-Data-Classification: public Content-Type: application/json

{
  "model": "gocux-deep",
  "messages": [
    {
      "role": "user",
      "content": "Summarize these supplied public notes."
    }
  ],
  "stream": false,
  "max_completion_tokens": 512
}

Inspect 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

The documented work-order maxCost field is recorded but is not a general enforced spending guarantee. Use the actual product billing controls and bounded requests for operational planning.

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.

Bring this workflow into your workspace.

Set the scope. Review the evidence. Approve the steps that need it.

Open the workspace

Keep exploring