This is the Restful API docs for calling Indx through HTTP requests.
Version 3.3. See older versions below
<aside> ☁️ indxRestAPI runs on Azure servers in 🇳🇴 Norway East. The server runs on 🌱 100% renewable energy.
</aside>
<aside> 💻 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)
</aside>
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.
<aside> 🚘 Try indx before creating your own program
To try loading a dataset, go to https://load.indx.co
To search your dataset, go to https://search.indx.co
These projects and other resources can be found in Github on https://github.com/IndxSearch
</aside>
📡 Indx Rest API endpoint: **https://v33.indx.co/api/
Variables in use**
| ${API_URL} | the url to the endpoint (https://v33.indx.co/api/) |
|---|---|
| ${USER} | your username (e-mail) |
| ${PASSWORD} | your password |
| ${TOKEN} | your retrieved token string |
| ${CONFIG} | a config value, most often this should be 100 |
| ${DATASET} | a string value of you dataset, for example “myDataset” |
| ${DOCUMENT_KEY} | a foreign key for each record |