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.

Usage
algolia synonyms import <index> -F <file> [flags]

Examples

Import synonyms from the “synonyms.ndjson” file to the “MOVIES” index:
algolia synonyms import MOVIES -F synonyms.ndjson
Import synonyms from the standard input to the “MOVIES” index:
cat synonyms.ndjson | algolia synonyms import MOVIES -F -
Browse the synonyms in the “SERIES” index and import them to the “MOVIES” index:
algolia synonyms browse SERIES | algolia synonyms import MOVIES -F -
Import synonyms from the “synonyms.ndjson” file to the “MOVIES” index and replace existing synonyms:
algolia synonyms import MOVIES -F synonyms.ndjson -r
Import synonyms from the “synonyms.ndjson” file to the “MOVIES” index and don’t forward the synonyms to the index replicas:
algolia synonyms import MOVIES -F synonyms.ndjson -f=false

Flags

--dry-run
Validate and preview the import request without sending it
-F, --file
Import synonyms from a file (use ”-” to read from standard input)
-f, --forward-to-replicas
Whether to also add the synonyms to replicas
-r, --replace-existing-synonyms
Replace existing synonyms in the index
-w, --wait
wait for the operation to complete

Output formatting flags

--allow-missing-template-keys
If true, ignore errors in templates due to missing fields or map keys. This only applies to golang and jsonpath output formats.
-o, --output
Output format. One of: (json, jsonl, ndjson, jsonpath, jsonpath-as-json, jsonpath-file).
--template
Template string or path to a template file to use when —output=jsonpath, —output=jsonpath-file.
Last modified on May 12, 2026