Indexing API Overview
Use the AddSearch Indexing API to retrieve, create, update, and delete documents individually or in batches within your search index.
Authentication
All Indexing API endpoints require authentication. Refer to the Authentication documentation for details on credential usage.
Get started quickly with the Indexing API by following our Getting Started guide.
Important: To use the Indexing API, your index must be API-based. You select the index type when creating a new account.
If you need to switch an existing index to be API-based, contact AddSearch Support for assistance.
Standard fields
The Indexing API supports both standard and custom fields. Standard fields correspond to common HTML page elements and enable features like text highlighting from the main content.
| Field | Description | Type | Notes |
|---|---|---|---|
id | Document identifier | string | Unique ID for the document, e.g., "1234". If not provided, the ID is generated by URL encoding combined with an MD5 hash. Must be 32 characters or less. |
url | Document URL | string | Complete URL of the document, e.g., "https://www.example.com". |
language | Document language | string | Two-letter ISO language code, e.g., "en", "de", "es". |
title | Document title | string | The content of the HTML <title> tag for the page. |
main_content | Document main content | string | The main text content of the page, used for indexing and search highlights. |
thumbnail_external_src | Document thumbnail URL | string | URL of an image to be used as the document's thumbnail by default. |
doc_date | Document date | string | Date of the document. Accepted formats include ISO date (e.g., "2023-12-31"), date and time (e.g., "2023-12-31T12:10:30Z"), and epoch time in milliseconds (e.g., "1704004677000"). |
Custom fields
Add up to 200 custom fields per index to include additional metadata like categories, prices, or images.
Custom field naming rules
- Maximum length: 256 characters
- Allowed characters: uppercase and lowercase letters (
A-Z,a-z), digits (0-9), underscore (_), and hyphen (-)
Supported data types
textintegerdouble
For more information on configuring and using custom fields, see Using Custom Fields.