Skip to main content
POST
/
v2
/
index
/
{name}
/
documents
Index a new document
curl --request POST \
  --url https://{region}.affinda.com/v2/index/{name}/documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "document": "EhglqBoT"
}
'
{
  "document": "EhglqBoT"
}

Authorizations

​
Authorization
string
header
required

Basic authentication using an API key, e.g. {Authorization: Bearer 75z0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.

Path Parameters

​
name
string
required

Index name Unique index name

Example:

"my-index"

Body

application/json

Document to index

​
document
string
Example:

"EhglqBoT"

Response

Returns the created indexed document

​
document
string

Unique identifier for the document.

Example:

"EhglqBoT"