Skip to content
Documentation
GOCUX / Documentationapi reference

Migration reference: read research progress

Track the actual evidence operation behind a candidate collection.

Track the actual evidence operation behind a candidate collection.

Practical procedure

  1. Keep the GoCux plan identity created for the collection’s research step.
  2. Read its state before inspecting findings or declaring the review finished.
  3. Aggregate your candidate-review progress separately from the plan’s execution state.

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 /research-plans/{plan_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

An external collection state cannot be inferred from a GoCux plan name or number of findings. Keep candidate acceptance separate from research execution.

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