Skip to main content

Documentation Index

Fetch the complete documentation index at: https://algolia.com/llms.txt

Use this file to discover all available pages before exploring further.

  • Type: string
  • Required
If you don’t provide an API key yourself, the Crawler creates a new one when creating a configuration. The API key must have the following permissions:
  • addObject
  • browse
  • deleteIndex
  • deleteObject
  • editSettings
  • listIndexes
  • search
  • settings
The API key must also have access to all indices with the same indexPrefix. For example, if the prefix is crawler_, the API key must have access to crawler_*.
Don’t use your Admin API key.

​
Examples

JavaScript
{
  apiKey: "33758f9a4be7766e94bf8800aad345900",
}
Last modified on March 23, 2026