Index a Document

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

Adds a single document 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.

Request Body

ParsedDocument 🔗︎ string required

ParsedDocument

Parsed JSON from the Textkernel Resume or Job Parser.

CustomIds 🔗︎ string[]

CustomIds

The custom ids you want the document to have.

Sample JSON

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

Response Body

Info 🔗︎ object

Info

Information explaining the outcome of the transaction.

---

Info properties

Code 🔗︎ string

Code

Code	Description
Success	Successful transaction
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 empty object.

Sample JSON

{
  "Info": {
    "Code": "",
    "Message": ""
  },
  "Value": {}
}