Push and Follow Your Data by API - Data Ingestion Endpoints

Send records and files, follow every job

Push and follow your data

Send your own records, or the URLs of your files, straight into your index. Each document gets the same treatment as a page read by the crawl: meaning vector, language, sentiment, PDF pages and the text in scans. Then follow every job until it is in the index.

Every call here goes to https://api.opensolr.com and works on an index in a region with site search (What your index needs).

Push

ingest

Send documents in one call, as records or as URLs of files to read; they join the queue and come back searchable.

Reference
file_extract

Upload a file that has no public URL, in parts; its text is read, a PDF page by page, scans and pictures included, ready to push.

Reference
file_extract_status

The state and the text of the files you uploaded.

Reference

Follow your jobs

ingest_status

The state of one push: pending, processing, completed, paused, failed or stopped.

Reference
ingest_queue

The jobs of one index.

Reference
ingest_queue_list_cores

Your indexes that have jobs, with how many each.

Reference
ingest_queue_list_jobs

The jobs of an index, page by page, sorted and filtered.

Reference
ingest_queue_job_detail

One job, with the documents it sent.

Reference
ingest_queue_core_progress

How far the jobs of an index have got, for a progress bar.

Reference

Reading the state of your jobs never uses your per-minute and per-hour limits, so a page that watches the queue keeps working while you push.

Act on jobs

ingest_queue_action

Stop, pause, resume, retry or delete one job, or save a corrected copy of what it sent.

Reference
ingest_queue_retry_failed

Send every failed job of an index again, or only the partly failed ones.

Reference
ingest_run_now

Start work on your waiting jobs now: one job, one index, or all of yours.

Reference

The meaning vectors and the pictures read during a push count against the monthly AI allowance of the account that owns the index (API Quota). The same work in the Control Panel: Push your data and The Data Ingestion queue.

Site search API pages

Back to Enterprise Site Search