CvdsIngestCandidate

One candidate to ingest.

external_idstringrequired

Your own candidate id. Unique within a corpus — re-ingesting the same external_id upserts the existing candidate.

Possible values: non-empty

Example: cand-001

parsed_cv objectrequired

The parsed CV as a JSON object (or array). This is the content that gets embedded for semantic search. It is PII and is never returned by the read endpoints — you keep your own copy.

oneOf

• object
• undefined[]

object

corpus_idstring

Per-candidate corpus, overriding the top-level corpus_id. Required if no top-level corpus_id is set.

Example: acme-eng-pool

tagsstring[]

Optional free-form tags stored with the candidate for your own correlation.

Example: ["batch-2026-q2"]

upload_idstring

Optional opaque id of the upload/source batch, stored for your traceability.

Example: upl_abc123

CvdsIngestCandidate

{
  "external_id": "cand-001",
  "parsed_cv": {
    "name": "Jane Doe",
    "skills": [
      "Node.js",
      "PostgreSQL"
    ],
    "experience": []
  },
  "corpus_id": "acme-eng-pool",
  "tags": [
    "batch-2026-q2"
  ],
  "upload_id": "upl_abc123"
}