Create an ingest job
Queues an asynchronous ingest. Returns immediately with `status: queued`. Poll `getIngestJob` until `ready` or `failed`. Sources: `url` (same-origin crawl), `sitemap`, `yml` (a Yandex Market feed by `url` — plain or gzip, any size, `windows-1251` or UTF-8 — or a small feed inline in `content`; the collection is created with a products schema when it does not exist), `youtube`, `documents` (inline JSON documents with `id`), or `markdown` / `csv` / `html` text in `content`. For a feed file use `uploadIngestFeed`.
Операция для полного ключа
Queues an asynchronous ingest. Returns immediately with status: queued. Poll getIngestJob until ready or failed. Sources: url (same-origin crawl), sitemap, yml (a Yandex Market feed by url — plain or gzip, any size, windows-1251 or UTF-8 — or a small feed inline in content; the collection is created with a products schema when it does not exist), youtube, documents (inline JSON documents with id), or markdown / csv / html text in content. For a feed file use uploadIngestFeed.
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
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/ingest-jobs" \ -H "Content-Type: application/json" \ -d '{ "collection": "string", "source": "url" }'{ "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}