This is the Restful API docs for calling Indx through HTTP requests.
Version 3.2.
indxRestAPI runs on Azure servers in š³š“Ā Norway East.
The server runs on š± 100% renewable energy.
Typical use case
š”Ā Connect to the endpoint, log in and receive a token
āĀ Insert with an array of documents
šŖĀ Create Index
š¢Ā Check ready status
šĀ Search
āĀ Insert one or more documents without re-indexing
š Delete one or more documents without re-indexing
šŖĀ (re-index if system status says it is required)
All of these functions can be run multiple times. For example to perform incremental loading.
All variations of this pattern can be run continuously over a long period of time to assure that the index and data is up to date.
How to use indx Rest API
š”Ā Indx Rest API endpoint: https://api.indx.co Variables in use
${API_URL} | the url to the endpoint |
${USER} | your username (e-mail) |
${PASSWORD} | your password |
${TOKEN} | your retrieved token string |
${CONFIG} | a config value, most often this should be 100 |
${HEAP_ID} | a integer value of your dataset, for example 0 or 1 |
${DOCUMENT_KEY} | a foreign key for each record |
ā£
ā£
ā£
ā£
ā£
ā£
ā£
ā£
ā£
ā£
ā£
ā£