Skip to main content
POST
/
parsers
/
{id}
/
parse
Error
A valid request URL is required to generate request examples
{
  "totalTimeMs": 123,
  "parsedStreams": 123,
  "totalDocuments": 123,
  "documents": [
    {
      "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": {}
    }
  ],
  "errors": [
    {
      "message": "<string>",
      "context": {}
    }
  ],
  "diagnostics": [
    {
      "diagnosticId": "<string>",
      "parserStageId": "<string>",
      "parserStageType": "<string>",
      "filter": "<string>",
      "result": false,
      "cause": "<string>",
      "code": 123
    }
  ]
}

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.

Headers

​
Content-Type
string
default:application/octet-stream
​
Content-Disposition
string

A presentation tag for the entity body

Path Parameters

​
id
string
required

The parser configuration ID

Query Parameters

​
limit
integer<int32>
default:100

An integer value to capture the first N documents, similar to SQL 'limit'

​
offset
integer<int32>
default:0

The offset in the complete result set where the set of returned documents should begin, used for pagination, similar to SQL 'offset'

Body

*/*

The data to parse

The body is of type object.

Response

200 - application/json

successful operation

​
totalTimeMs
integer<int32>
​
parsedStreams
integer<int32>
​
totalDocuments
integer<int32>
​
documents
object[]
​
errors
object[]
​
diagnostics
object[]