Skip to content
Documentation
GOCUX / Documentationapi reference

Migration reference: define a collection schema

Make required record fields and evidence obligations explicit.

Make required record fields and evidence obligations explicit.

Practical procedure

  1. Write each output field’s meaning and whether it is required for inclusion.
  2. For a durable task requiring machine-readable output, use its supported structuredResult envelope and validate against the actual accepted schema profile.
  3. Inspect the saved structured-result state before consuming the output.

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.

Operation reference for this workflow

GET /work-orders/{work_order_id}/structured-result

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 supported task envelope uses profile gocux.schema/v1, name and schema. It is not a FindAll schema-discovery endpoint.

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