Search & Match

Index a new document

Create an indexed document for the search tool

post/v3/index/{name}/documents

Request

Base URL
https://api.affinda.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/affinda/apis/affinda-api-2/docs/v3/index/:name/documents/post.ts
A function with typed inputs. Its response is checked against the schema.

namestring required

Unique index name

Example:my-index

Index name

documentstring

{
  "document": "EhglqBoT"
}

Returns the created indexed document

documentstring

Unique identifier for the document.

{
  "document": "EhglqBoT"
}

Nov 20, 2025978cf99a2ac0 Revision changes
- info
  api tag Search & Match added
- info
  api tag Search & Match API - Indexing removed