Algolia

Algolia Ingestion API

The Ingestion API powers the no-code [data connectors](https://dashboard.algolia.com/connectors). Base URLs Base URLs for the Ingestion API:…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Ingestion API powers the no-code data connectors.

Base URLs

Base URLs for the Ingestion API:

  • https://data.us.algolia.com
  • https://data.eu.algolia.com

Use the URL that matches your analytics region.

All requests must use HTTPS.

Authentication

Add these headers to authenticate requests:

  • x-algolia-application-id. Your Algolia application ID.
  • x-algolia-api-key. An API key with the necessary permissions to make the request.

The required access control list (ACL) to make a request is listed in each endpoint's reference.

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.

Endpoints 61

ingestion

  • GETSend requests to the Algolia REST API/:pathThis method lets you send requests to the Algolia REST API.
  • PUTSend requests to the Algolia REST API/:pathThis method lets you send requests to the Algolia REST API.
  • POSTSend requests to the Algolia REST API/:pathThis method lets you send requests to the Algolia REST API.
  • DELETESend requests to the Algolia REST API/:pathThis method lets you send requests to the Algolia REST API.
  • POSTPush records by indexName/1/push/:indexNamePushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the watch parameter, for asynchronous calls, you can…
  • GETList authentication resources/1/authenticationsRetrieves a list of all authentication resources.
  • POSTCreate an authentication resource/1/authenticationsCreates a new authentication resource.
  • POSTSearch for authentication resources/1/authentications/searchSearches for authentication resources.
  • GETRetrieve an authentication resource/1/authentications/:authenticationIDRetrieves an authentication resource by its ID.
  • DELETEDelete an authentication resource/1/authentications/:authenticationIDDeletes an authentication resource. You can't delete authentication resources that are used by a source or a destination.
  • PATCHUpdate an authentication resource/1/authentications/:authenticationIDUpdates an authentication resource.
  • GETList destinations/1/destinationsRetrieves a list of destinations.
  • POSTCreate a destination/1/destinationsCreates a new destination.
  • POSTSearch for destinations/1/destinations/searchSearches for destinations.
  • GETRetrieve a destination/1/destinations/:destinationIDRetrieves a destination by its ID.
  • DELETEDelete a destination/1/destinations/:destinationIDDeletes a destination by its ID. You can't delete destinations that are referenced in tasks.
  • PATCHUpdate a destination/1/destinations/:destinationIDUpdates the destination by its ID.
  • GETList sources/1/sourcesRetrieves a list of sources.
  • POSTCreate a source/1/sourcesCreates a new source.
  • POSTValidate a source payload/1/sources/validateValidates a source payload to ensure it can be created and that the data source can be reached by Algolia.
  • POSTSearch for sources/1/sources/searchSearches for sources.
  • GETRetrieve a source/1/sources/:sourceIDRetrieve a source by its ID.
  • DELETEDelete a source/1/sources/:sourceIDDeletes a source by its ID. You can't delete sources that are referenced in tasks.
  • PATCHUpdate a source/1/sources/:sourceIDUpdates a source by its ID.
  • POSTValidate an update of a source payload/1/sources/:sourceID/validateValidates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.
  • POSTTrigger a stream-listing request/1/sources/:sourceID/discoverTriggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with type: docker and imageType: airbyte.
  • POSTRun all tasks linked to a source/1/sources/:sourceID/runRuns all tasks linked to a source, only available for Shopify, BigCommerce and commercetools sources. Creates one run per task.
  • GETList tasks/2/tasksRetrieves a list of tasks.
  • POSTCreate a task/2/tasksCreates a new task.
  • POSTSearch for tasks/2/tasks/searchSearches for tasks.
  • GETRetrieve a task/2/tasks/:taskIDRetrieves a task by its ID.
  • PUTFully update a task/2/tasks/:taskIDFully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
  • DELETEDelete a task/2/tasks/:taskIDDeletes a task by its ID.
  • PATCHPartially update a task/2/tasks/:taskIDPartially updates a task by its ID.
  • POSTRun a task/2/tasks/:taskID/runRuns a task. You can check the status of task runs with the observability endpoints.
  • POSTPush records by task ID/2/tasks/:taskID/pushPushes records through the pipeline, directly to an index. You can make the call synchronous by providing the watch parameter, for asynchronous calls, you can…
  • PUTEnable a task/2/tasks/:taskID/enableEnables a task.
  • PUTDisable a task/2/tasks/:taskID/disableDisables a task.
  • GETList tasks V1/1/tasksDeprecated. Retrieves a list of tasks using the v1 endpoint. Use getTasks instead.
  • POSTCreate a task V1/1/tasksDeprecated. Creates a new task using the v1 endpoint. Use createTask instead.
  • POSTSearch for tasks V1/1/tasks/searchDeprecated. Searches for tasks using the v1 endpoint. Use searchTasks instead.
  • GETRetrieve a task V1/1/tasks/:taskIDDeprecated. Retrieves a task by its ID using the v1 endpoint. Use getTask instead.
  • DELETEDelete a task/1/tasks/:taskIDDeprecated. Deletes a task by its ID using the v1 endpoint. Use deleteTask instead.
  • PATCHUpdate a task V1/1/tasks/:taskIDDeprecated. Updates a task by its ID using the v1 endpoint. Use updateTask instead.
  • POSTRun a task V1/1/tasks/:taskID/runDeprecated. Runs a task using the v1 endpoint. Use runTask instead. You can check the status of task runs with the observability endpoints.
  • PUTEnable a task V1/1/tasks/:taskID/enableDeprecated. Enables a task using the v1 endpoint. Use enableTask instead.
  • PUTDisable a task V1/1/tasks/:taskID/disableDeprecated. Disables a task using the v1 endpoint. Use disableTask instead.
  • GETList transformations/1/transformationsRetrieves a list of transformations.
  • POSTCreate a transformation/1/transformationsCreates a new transformation.
  • POSTTry a transformation before creating it/1/transformations/tryTry a transformation before creating it.
  • POSTSearch for transformations/1/transformations/searchSearches for transformations.
  • GETRetrieve a transformation/1/transformations/:transformationIDRetrieves a transformation by its ID.
  • PUTUpdate a transformation/1/transformations/:transformationIDUpdates a transformation by its ID.
  • DELETEDelete a transformation/1/transformations/:transformationIDDeletes a transformation by its ID.
  • POSTTry a transformation before updating it/1/transformations/:transformationID/tryTry a transformation before updating it.
  • GETList task runs/1/runsRetrieve a list of task runs.
  • GETRetrieve a task run/1/runs/:runIDRetrieve a single task run by its ID.
  • GETList task run events/1/runs/:runID/eventsRetrieves a list of events for a task run, identified by its ID.
  • GETRetrieve a task run event/1/runs/:runID/events/:eventIDRetrieves a single task run event by its ID.
  • GETSwitch the API key used to authenticate requests/setClientApiKey?apiKey=stringSwitch the API key used to authenticate requests.
  • GETReplace all records in an index/chunkedPush?indexName=string&objects={}Helper: Chunks the given objects list in subset of 1000 elements max in order to make it fit in push requests by leveraging the Transformation pipeline setup…

API details

Base URL
https://data.{region}.algolia.com
Authentication
An API key in the x-algolia-application-id header
An API key in the x-algolia-api-key header
Operations
61 operations on 39 pathsPOST 23GET 19PUT 7DELETE 7PATCH 5
9 marked deprecated
Main resources
ingestion 61
Response formats
application/json
Description format
OpenAPI 3.0.2, API version 1.0.0

How to test the Algolia Ingestion API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Algolia Ingestion API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the x-algolia-application-id header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Send requests to the Algolia REST API” (GET /:path), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Algolia Ingestion API?

The Ingestion API powers the no-code [data connectors](https://dashboard.algolia.com/connectors). Base URLs Base URLs for the Ingestion API:… It is listed under Developer tools and has 61 endpoints.

Who publishes the Algolia Ingestion API?

It is listed from Algolia's public API description (an OpenAPI document), not published by Algolia on Swastik Codes. Anyone who controls algolia.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Algolia Ingestion API?

Requests go to https://data.{region}.algolia.com. Endpoint paths are added to this base URL.

How do I authenticate with the Algolia Ingestion API?

It accepts 2 methods: an API key in the x-algolia-application-id header; an API key in the x-algolia-api-key header.

How many endpoints does the Algolia Ingestion API have?

61 operations on 39 paths (23 POST, 19 GET, 7 PUT, 7 DELETE, 5 PATCH). The largest groups are ingestion.

Is forking the Algolia Ingestion API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.