AFaffinda
Search & Match

Create a new index

Changed on

Create an index for the search tool

post/v3/index

Request

Request body

namestring required

Unique index name

docType'resumes' | 'job_descriptions'

Example request

{
  "name": "my-index"
}

Response

Returns the created index

namestring required

Unique index name

docType'resumes' | 'job_descriptions' required

Example response

{
  "name": "my-index",
  "user": {
    "id": 1,
    "name": "Carl Johnson",
    "email": "carljohnson@grove.street",
    "avatar": "https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY&Signature=SIG"
  }
}

Changes

  • 978cf99a2ac0Revision changes
    • info

      api tag Search & Match added

    • info

      api tag Search & Match API - Indexing removed

  • 0913ed9391cbRevision changes
    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the required property to the response with the status