The Indexing API allows for retrieving documents, creating documents, updating single documents and batches of documents, as well as deleting single documents and batches of documents
All the Indexing API endpoints require authentication. Visit our documentation about authentication for more information. Also see our article on getting started with the indexing API here.
Note! An API-based index is required to use the Indexing API. You can select the type of your index when creating a new account. Contact support to switch the base of existing index.
Both standard fields and custom fields can be used with the Indexing API. Standard fields correspond with the basic HTML structure of a page. AddSearch has built-in support for creating highlights from the main_content field. Custom fields can be employed for additional data like categories and images.
| Field | Description | Type | Notes |
|---|---|---|---|
| url | Document's URL | string | |
| language | Document's language | string | Two-letter language format, e.g. “en”, “de”, “es”. |
| title | Document's title | text | The document's title as defined in the HTML title tag. |
| main_content | text | The text content of the page. |
We’re always happy to help with code or other questions you might have. Search our documentation, contact support, or connect with our sales team.