Skip to content
GOCUX
Documentation
GOCUX / Documentationgetting started

Choose a GoCux workflow

Match a client integration to the supported GoCux operation before writing the adapter.

Match a client integration to the supported GoCux operation before writing the adapter.

Practical procedure

  1. Choose /v1/chat/completions for a compatible conversational client that supplies message history. Discover the advertised route with /v1/models instead of hardcoding an upstream provider.
  2. Choose /knowledge/search for project documents and /research-plans for approved evidence gathering. Neither choice silently creates an internet crawler.
  3. Choose /work-orders for governed durable tasks, or Pulse monitor routes for repeated evidence comparisons. Keep unsupported legacy API shapes out of the request body.

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

A similar topic name is not a compatibility promise. Translate inputs and outputs explicitly, and record which state transitions your application now owns.

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