Cancel an ingest job
Best-effort cancellation: the job is marked `failed` with `error: "Canceled by request"` and the queue consumer skips it on its next pickup. A job that is already `processing` may still finish its current pass — a running Worker cannot be interrupted — in which case its own result stands. Jobs that are `ready` or `failed` cannot be canceled.
Full-key operation
Best-effort cancellation: the job is marked failed with error: "Canceled by request" and the queue consumer skips it on its next pickup. A job that is already processing may still finish its current pass — a running Worker cannot be interrupted — in which case its own result stands. Jobs that are ready or failed cannot be canceled.
Authorization
api_key_header Every request carries an organization API key. A key has one of two scopes. A full key reaches every operation in this document and belongs on your server. A search key is the one to ship in a browser widget or a storefront page: it reaches only the operations marked x-nova-key-scope: search — searching, federated search, recommendations, event ingestion, and the visitor-facing AI operations (semantic and image search, voice transcription and voice search, assistant chat, and the visitor's own conversation). It cannot write documents or read or change configuration; any other operation answers 403. AI operations are paid in credits from the organization's wallet whichever key calls them (402 when the balance runs out), and a search key needs X-NOVA-SESSION-ID on them: the session is what a conversation belongs to, and what the per-session allowance (429) is counted against. A key of either scope may additionally carry restrictions set in the console: an allowlist of collections (403 elsewhere), a forced filter_by per collection that is ANDed into every search (document-level access control), an allowlist of fields (include_fields is limited to it and a request naming any other field in query_by, facet_by, sort_by, filter_by or highlight_fields answers 400), an IP/CIDR allowlist and an Origin/Referer allowlist (403), and a per-key rate limit (429 with Retry-After).
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/ingest-jobs/string/cancel"{ "id": "string", "name": "string", "collection": "string", "source": "url", "status": "queued", "config": {}, "stats": { "fetched": 0, "imported": 0, "failed": 0, "cursor": 0, "passes": 0, "errors": [ { "id": "string", "error": "string" } ] }, "error": "string", "created_at": 0, "updated_at": 0, "finished_at": 0}Retry every failed ingest job POST
Re-queues every `failed` ingest job of the organization (newest first, up to 50) with its original config — the bulk form of `retryIngestJob`. Jobs that are `queued`, `processing` or `ready` are not touched. Returns how many were re-queued and the jobs themselves with `status: queued`.
Open a support thread POST
Starts a thread with its first message from the visitor. Sticky per `X-NOVA-SESSION-ID`, the same identity a conversation uses — a `search` key reads and posts only to threads opened by its own session; a `full` key (server-side use) is not session-restricted.