Skip to main content
POST
/
index
/
{id}
{
  "docs": [
    {
      "id": "<string>",
      "fields": [
        {
          "name": "<string>",
          "value": {},
          "metadata": {},
          "annotations": [
            {
              "type": "<string>",
              "start": 123,
              "end": 123,
              "features": {},
              "label": "<string>",
              "featureCount": 123
            }
          ]
        }
      ],
      "metadata": {},
      "commands": [
        {
          "name": "<string>",
          "params": {}
        }
      ],
      "hints": {}
    }
  ],
  "stats": {}
}

Documentation Index

Fetch the complete documentation index at: https://doc.lucidworks.com/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

​
id
string
required

The ID of the index profile to use

Query Parameters

​
simulate
boolean
default:false

If true, documents are not sent to Solr for indexing; the solr-index stage will be skipped

​
echo
boolean
default:true

If true, return the list of documents indexed; otherwise no output is returned when the pipeline has finished

​
echoMaxCount
integer<int32>
default:100

The maximum number of documents to list in the output

​
stats
boolean
default:false
​
bufferDocsForSolr
boolean

Body

A PipelineDocument or Solr XML document

The body is of type any.

Response

200 - application/json; qs=1.0

successful operation

​
docs
object[]
read-only
​
stats
object
read-only