API reference
Generated from the OpenAPI contract.
- List all collections
- Create a new collection
- Retrieve a single collection
- Update a collection
- Delete a collection
- List all aliases
- Retrieve an alias
- Delete an alias
- Create or update a collection alias
- Start a full reindex of a collection
- Index a document
- Update documents with conditional query
- Delete a bunch of documents
- Search for documents in a collection
- Export all documents in a collection
- Import documents into a collection
- Retrieve a document
- Update a document
- Delete a document
- send multiple search requests in a single HTTP request
- List all synonym sets
- Retrieve a synonym set
- Delete a synonym set
- Create or update a synonym set
- List items in a synonym set
- Retrieve a synonym set item
- Delete a synonym set item
- Create or update a synonym set item
- Export a synonym set as CSV
- Import synonyms from CSV
- List all curation sets
- Retrieve a curation set
- Delete a curation set
- Create or update a curation set
- List items in a curation set
- Retrieve a curation set item
- Delete a curation set item
- Create or update a curation set item
- List all conversation models
- Create a conversation model
- Retrieve a conversation model
- Delete a conversation model
- Update a conversation model
- Mint a short-lived search key for a browser
- Checks if AACSearch node is ready to accept requests.
- Retrieve analytics events
- Create an analytics event
- Retrieve analytics rules
- Create analytics rule(s)
- Retrieves an analytics rule
- Delete an analytics rule
- Upserts an analytics rule
- Popular queries with search/CTR/conversion/revenue metrics
- Zero-result query share
- Search-to-purchase funnel
- Last-search revenue attribution
- Ingest a batch of storefront search events
- Retrieves all stopwords sets.
- Retrieves a stopwords set.
- Delete a stopwords set.
- Upserts a stopwords set.
- Retrieves all presets.
- Retrieves a preset.
- Delete a preset.
- Upserts a preset.
- List all stemming dictionaries
- Retrieve a stemming dictionary
- Import a stemming dictionary
- List all NL search models
- Create a NL search model
- Retrieve a NL search model
- Delete a NL search model
- Update a NL search model
- Ingest behavioural events
- Plan, expiry and what is left
- List recommendation models
- Retrieve a recommendation model
- Delete a recommendation model
- Create or update a recommendation model
- Get recommendations
- Typeahead suggestions
- Pre-search prompts
- Transcribe an audio clip
- Search a collection by voice
- List assistants
- Create an assistant
- Retrieve an assistant
- Delete an assistant
- Update an assistant
- Ask the assistant
- Ask the assistant (streaming)
- Retrieve a conversation
- Delete a conversation
- List CMS installations
- Create an installation and return its key once
- Publish configuration using optimistic revision control
- Revoke an installation key without deleting its audit state
- Read the configuration of this installation
- Read subscription and quota state for this installation
- Report discovery and acknowledge an applied configuration
- Read the collection schema for an installation source
- Search an installation source with facets
- Enqueue source changes
- Record source behavioral events
- Recommend from the configured source model
- List the last 100 commands for an installation
- Queue an idempotent CMS action
- Cancel a queued or running CMS action
- Lease the next CMS action for 120 seconds
- Renew a command lease or acknowledge its result
- List connectors
- Create a connector
- Negotiate connector capabilities
- Retrieve a connector
- Delete a connector
- Update a connector
- Ingest connector events
- List connector jobs
- List journaled connector documents
- Read the confirmed dataset profile
- Confirm dataset roles and proposed configuration
- Preview a dataset and proposed search configuration
- List ingest jobs
- Create an ingest job
- Get ingest job status
- Delete an ingest job record
- Upload a YML feed file
- Retry a failed ingest job
- Retry every failed ingest job
- Cancel an ingest job
- Open a support thread
- Retrieve a support thread
- Send a support message
- Upload an image
- Retrieve an image's metadata
- Delete an image
- Download an image
- Stream the bytes of a large upload
- Embed text
- Search a collection by meaning
- Search a collection by image
- Start a large upload
- Create a signed download URL
- List synonym suggestions
- Generate synonym suggestions for zero-hit queries
- Delete a synonym suggestion
- Accept a synonym suggestion
- Reject a synonym suggestion
- List extracted entities
- Extract entities and relations from documents
- Delete an extracted entity
- List community reports
- Group entities into community reports
- Answer a broad question via community reports (map-reduce)
- Answer a question via a Global Search primer plus Local Search follow-ups (DRIFT)
- Delete a community report
- List extracted claims
- Delete an extracted claim
- List search rules
- Get a collection's search rules
- Delete a collection's search rules
- Replace a collection's search rules
- List a collection's search profiles
- Create a search profile
- Get a search profile
- Delete a search profile
- Replace a search profile
- Read what a storefront may show for a profile
- List immutable profile releases
- Publish the profile draft
- Activate a previous profile release
- List experiments
- Create an experiment
- Retrieve an experiment
- Delete an experiment
- Update an experiment
- Start an experiment
- Stop an experiment
- Promote a winning variant
- Restore the configuration before promotion
- Experiment report
- List SEO rules
- Create an SEO rule
- Get an SEO rule
- Delete an SEO rule
- Update an SEO rule
- List generated SEO pages
- Bulk-generate SEO pages for a collection
- Audit generated SEO pages
- Export a sitemap of the generated SEO pages