Indexer work

Stage an external indexer's candidate batch

A remote indexer that read a stored document submits its reading here. With runId + claimToken the submission fulfils a claimed work item; without them it opens its own run (claimless flow). Candidates are grounded against the stored text; the Brain commits once every run for the document is settled. Max 200 items per kind. Throttled to 10 requests/min per credential. Part of the document pipeline — answers 503 feature_disabled until DOCUMENT_INGEST_ENABLED=1. Source: src/documents/external-candidates.controller.ts.

Required scope: indexer:write.

post/v1/documents/{id}/candidates

Request

  • Base URL: https://brain.inite.ai
  • URL: https://brain.inite.ai/v1/documents/{id}/candidates
  • Auth: HTTP bearer

Path parameters

idstring required

The document id.

Request body

claimTokenstring
indexerIdstring required

The pack id this indexer is registered as (mode 'external').

packVersionstring

Optional claim of the pack version; must match the installed one.

runIdstring

A claimed work item this submission fulfils. Provided together with claimToken or not at all (claimless flow opens its own run).

Response

Staged (and possibly committed).

packIdstring required
packVersionstring required
runIdstring required
ungroundedboolean required

true when the document has no stored content — spans unverifiable.

Changes

No recorded changes to this operation across all 1 revision of this API.