Skip to content
Documentation
GOCUX / Documentationgetting started

GoCux concepts and vocabulary

Use product terms consistently when connecting evidence, execution and identity.

Use product terms consistently when connecting evidence, execution and identity.

Practical procedure

  1. Treat a company as the authenticated tenant boundary and a project as an organizational scope inside it. A project identifier is not an additional credential.
  2. Distinguish a Knowledge source from its documents and chunks. A citation refers to supporting material; a finding is the claim or unanswered question derived from the reviewed evidence.
  3. Distinguish a plan from its execution, a monitor from its occurrences, and a memory proposal from its approved version. Use these names in your own logs and interface labels.

Build an approved evidence path

GoCux Research works with Knowledge sources in the selected project. A plan separates the question and ordered steps from the source allowlist. Creating the plan records a draft; it does not approve or execute the work. Review the actual source selection before approving, because an empty allowlist permits no source and an execution request cannot expand an approved plan.

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 /research-plans — example request body

{
  "projectId": "project-id",
  "title": "Review documented renewal conditions",
  "question": "What renewal conditions are supported by these documents?",
  "steps": [
    "Find the renewal terms and their effective dates"
  ],
  "allowedSourceIds": [
    "source-id"
  ]
}

Inspect the result

Read the saved plan before deciding. After approval and execution, retrieve its findings and inspect the cited source chunks. A finding supported by a quotation is different from a question for which no source was found. Keep that difference in the final report and in any downstream table.

What to keep explicit

The Gateway is the product routing boundary; the optional Cloud Worker performs durable server-side execution. The CLI owns local tools and permissions. These responsibilities should remain separate in architecture diagrams.

Handle incomplete and refused work

An unapproved plan cannot execute. A 409 can mean the state or expected version changed; reread before deciding again. A 503 means the research store is unavailable, not that research found no evidence. Access is scoped to the authenticated company; knowing an identifier does not grant another company access.

Bring this workflow into your workspace.

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

Open the workspace

Keep exploring