latestOpenAPI 3.0.3MIT2026-08-04143307364.8 KB

6772e50cb58e

Document API - Extractor

Create an extractor

Create a custom extractor.

post/v3/extractors

Request body

namestring required

namePluralstring

baseExtractorstring

Uniquely identify an extractor.

organizationstring required

Uniquely identify an organization.

categorystring nullable

validatableboolean

Example request

{
  "baseExtractor": "resume",
  "organization": "mEFayXdO",
  "category": "Recruitment"
}

Response

Successfully created an extractor.

identifierstring required

Uniquely identify an extractor.

namestring required

namePluralstring required

categorystring nullable

validatableboolean required

isCustomboolean

createdDtstring date-time

lastTrainedDtstring date-time nullable

Example response

{
  "identifier": "resume",
  "baseExtractor": {
    "identifier": "resume"
  },
  "organization": {
    "identifier": "mEFayXdO",
    "name": "Grove Street King",
    "userRole": "admin",
    "avatar": "https://affinda-api.s3.amazonaws.com/media/org-avatar.png?AWSAccessKeyId=KEY&Signature=SIG",
    "resthookSignatureKey": "465c6598bd34c0558f0ce256c43209d49fa85b0ff3e4c18b24e408b7563143ad"
  },
  "category": "Recruitment"
}