Index Multiple Documents🔗︎

HTTP Verb	Path
POST	/v9/index/(indexId)/documents

Adds multiple documents to an index.

Info

You can try this endpoint out at our Swagger page ( US Data Center | EU Data Center | AU Data Center )
Skills Normalization must be included to index documents using V2 Skills Taxonomy. These algorithms ignore raw skills and only consider the normalized skill concepts for skills category scoring. This leads to improved scoring and ranking because normalization produces less false negatives than simple exact keyword matching.

Path Parameters🔗︎

Parameter	Data Type	Description
indexId	string	The id for the index where the documents should be added (case-insensitive).

Request Body🔗︎

DocumentId 🔗︎ string required

DocumentId🔗︎

The id of the current document. This is restricted to alphanumeric with dashes and underscores. All values will be converted to lower-case.

ParsedDocument 🔗︎ string required

ParsedDocument🔗︎

Parsed JSON from the Textkernel Resume or Job Parser.

CustomIds 🔗︎ string[]

CustomIds🔗︎

The custom ids you want the current document to have.

Sample JSON

[
  {
    "DocumentId": "",
    "ParsedDocument": "",
    "CustomIds": [
      ""
    ]
  }
]

Response Body🔗︎

Info 🔗︎ object

Info🔗︎

Information explaining the outcome of the transaction.

Info properties

Code 🔗︎ string

Code🔗︎

Code	Description
`Success`	Successful transaction
`SomeErrors`	Some items in the bulk request failed
`MissingParameter`	A required parameter wasn't provided
`InvalidParameter`	A parameter was incorrectly specified
`AuthenticationError`	An error occurred with the credentials provided
`Unauthorized`	Your account doesn't have permission to perform this operation
`DataNotFound`	Data with the specified name wasn't found
`ConstraintError`	Data in the request is not allowed with the specific action being requested.

Message 🔗︎ string

Message🔗︎

This message further describes the code providing additional detail.

Value 🔗︎ object[]

Value🔗︎

An array of objects representing the individual document add responses. This is used to determine which documents failed in the event of an error.

Value properties

DocumentId 🔗︎ string

DocumentId🔗︎

Id of the specific document represented in the response

Code 🔗︎ string

Code🔗︎

Code	Description
`Success`	Successful transaction
`Error`	The specified document had an error during indexing

SubCode 🔗︎ string

SubCode🔗︎

The following is a list of subcodes that can be returned by the service:

Success

– Successful transaction

InvalidParameter

A parameter was incorrectly specified

UnhandledException

Unexpected error occurred

Message 🔗︎ string

Message🔗︎

This message further describes the code/subcode providing additional detail.

Sample JSON

{
  "Info": {
    "Code": "",
    "Message": ""
  },
  "Value": [
    {
      "DocumentId": "",
      "Code": "",
      "SubCode": "",
      "Message": ""
    }
  ]
}