Algolia Ingestion

Algolia Ingestion

The Ingestion API powers the no-code data connectors.

Base URLs

Base URLs for the Ingestion API:

Use the URL that matches your analytics region.

All requests must use HTTPS.

Authentication

Add these headers to authenticate requests:

You can find your application ID and API key in the Algolia dashboard.

Request format

Request bodies must be JSON objects.

Response status and errors

Response bodies are JSON objects.

Successful responses return 2xx statuses. Client errors return 4xx statuses. Server errors return 5xx statuses. Error responses have a message property with more information.

Version

The current version of the Ingestion API is version 1, indicated by the /1/ in each endpoint's URL.

Operations

Delete an authentication resource
Retrieve an authentication resource
Update an authentication resource
List authentication resources
Create an authentication resource
Search for authentication resources
Retrieve a destination
List destinations
Create a destination
Search for destinations
Push records by indexName
List task runs
Retrieve a task run event
List task run events
Retrieve a task run
List sources
Create a source
Search for sources
Trigger a stream-listing request
Retrieve a source
Update a source
Run all tasks linked to a source
Validate an update of a source payload
Validate a source payload
List transformations
Create a transformation
Search for transformations
Retrieve a transformation
Try a transformation before updating it
Try a transformation before creating it
List tasks
Create a task
Search for tasks
Delete a task
Retrieve a task
Partially update a task
Push records by task ID
Fully update a task
Replace all records in an index
Send requests to the Algolia REST API
Send requests to the Algolia REST API
Send requests to the Algolia REST API
Send requests to the Algolia REST API
Switch the API key used to authenticate requests