POST
/
parsers
/
{id}
/
parse
{?charset.registered,creationDate,filename,limit,modificationDate,name,offset,readDate,size,type}
Parse document passed as binary data.
curl --request POST \
  --url https://{FUSION HOST}/api/parsers/{id}/parse{?charset.registered,creationDate,filename,limit,modificationDate,name,offset,readDate,size,type} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: <content-type>'
{
  "diagnostics": [
    {
      "cause": "<string>",
      "code": 123,
      "diagnosticId": "<string>",
      "filter": "<string>",
      "parserStageId": "<string>",
      "parserStageType": "<string>",
      "result": true
    }
  ],
  "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": [
    {
      "context": {},
      "message": "<string>"
    }
  ],
  "parsedStreams": 123,
  "totalDocuments": 123,
  "totalTimeMs": 123
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

Content-Type
string
default:application/octet-stream
required

MIME type

Path Parameters

id
string
required

(Deprecated) Id of the parser to be used. Use async-parser instead.

Query Parameters

charset.registered
boolean
creationDate
string<date-time>
filename
string
limit
integer
default:100

Maximum number of documents to parse

modificationDate
string<date-time>
name
string
offset
integer
default:0

The index of the first document that will actually be processed. Documents with ordinals from 0 to offset will be skipped.

readDate
string<date-time>
size
integer
type
string

Body

application/octet-stream · file

The body is of type file.

Response

200
application/json

OK

The response is of type object.