Skip to content
GOCUX
Documentation
GOCUX / Documentationextract

Import and inspect document text

Create searchable project evidence from an authorized document.

Create searchable project evidence from an authorized document.

Practical procedure

  1. Choose a project and create a Knowledge source with a meaningful name. Start with a small plain-text file to verify the upload path before testing richer formats.
  2. Base64-encode the actual file bytes and provide a truthful filename, title and data classification. Submit the upload to the returned source identifier.
  3. Record the returned document identity, inspect the extraction and search for a phrase from the original. Keep extraction quality separate from successful HTTP transport.

Import evidence with its provenance

Create a Knowledge source for the selected project before adding documents. The upload endpoint accepts JSON with base64-encoded file bytes, a title, filename, classification and retention choice. GoCux extracts text and stores the text with a checksum; the original uploaded bytes are not the retained Knowledge document. Keep your authorized original separately when your workflow needs it.

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 /knowledge/sources/{source_id}/documents — example request body

{
  "title": "Renewal note",
  "filename": "renewal.txt",
  "contentBase64": "UmVuZXdhbCB0ZXJtczogMzAgZGF5cy4=",
  "dataClassification": "public"
}

Inspect the result

After a successful import, record the document identifier and review the resulting text. Search the project for a known phrase to check that useful content was extracted. Embeddings may be filled later, so immediate verification should include a lexical query. Preserve the source name and extraction context when referring to the document elsewhere.

What to keep explicit

The example contains public synthetic text. Set classification and retention according to your real document rather than copying those choices automatically.

Handle incomplete and refused work

Invalid base64, an unsupported classification, or extracted text above the configured cap is refused. The request bounds contentBase64 to 40,000,000 characters; this is not a promise that every file of that size or format can be meaningfully extracted. Rich document support depends on deployed extraction capabilities. Missing source and unavailable storage are separate errors.

Bring this workflow into your workspace.

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

Open the workspace

Keep exploring