Algolia Ingestion API
Connector-based data ingestion that pulls records from databases, storage and ecommerce platforms into Algolia indices via managed sources, destinations, transformations and tasks. The largest connector surface at 61 operations, and the only Algolia API with real dry-run operations.
This API exposes 61 operations across 39 paths, and defines 173 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against a single base URL, https://data.{region}.algolia.com.
61 operations
39 paths
173 schemas
7 DELETE19 GET5 PATCH23 POST7 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Algolia Ingestion API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as x-algolia-application-id (appId).
An API key is passed in the header as x-algolia-api-key (apiKey).
By default, every request must be authenticated.
appId— Your Algolia application ID.apiKey— Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions.…
Paths & Operations 61
Across 39 paths, the API surfaces 61 operations — 7 DELETE, 19 GET, 5 PATCH, 23 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.
ingestion 61
GET
/{path}
Send requests to the Algolia REST API
POST
/{path}
Send requests to the Algolia REST API
PUT
/{path}
Send requests to the Algolia REST API
DELETE
/{path}
Send requests to the Algolia REST API
POST
/1/push/{indexName}
Push records by indexName
GET
/1/authentications
List authentication resources
POST
/1/authentications
Create an authentication resource
POST
/1/authentications/search
Search for authentication resources
GET
/1/authentications/{authenticationID}
Retrieve an authentication resource
PATCH
/1/authentications/{authenticationID}
Update an authentication resource
DELETE
/1/authentications/{authenticationID}
Delete an authentication resource
GET
/1/destinations
List destinations
POST
/1/destinations
Create a destination
POST
/1/destinations/search
Search for destinations
GET
/1/destinations/{destinationID}
Retrieve a destination
PATCH
/1/destinations/{destinationID}
Update a destination
DELETE
/1/destinations/{destinationID}
Delete a destination
GET
/1/sources
List sources
POST
/1/sources
Create a source
POST
/1/sources/validate
Validate a source payload
POST
/1/sources/search
Search for sources
GET
/1/sources/{sourceID}
Retrieve a source
PATCH
/1/sources/{sourceID}
Update a source
DELETE
/1/sources/{sourceID}
Delete a source
POST
/1/sources/{sourceID}/validate
Validate an update of a source payload
POST
/1/sources/{sourceID}/discover
Trigger a stream-listing request
POST
/1/sources/{sourceID}/run
Run all tasks linked to a source
GET
/2/tasks
List tasks
POST
/2/tasks
Create a task
POST
/2/tasks/search
Search for tasks
GET
/2/tasks/{taskID}
Retrieve a task
PUT
/2/tasks/{taskID}
Fully update a task
PATCH
/2/tasks/{taskID}
Partially update a task
DELETE
/2/tasks/{taskID}
Delete a task
POST
/2/tasks/{taskID}/run
Run a task
POST
/2/tasks/{taskID}/push
Push records by task ID
PUT
/2/tasks/{taskID}/enable
Enable a task
PUT
/2/tasks/{taskID}/disable
Disable a task
GET
/1/tasksdeprecated
List tasks V1
POST
/1/tasksdeprecated
Create a task V1
POST
/1/tasks/searchdeprecated
Search for tasks V1
GET
/1/tasks/{taskID}deprecated
Retrieve a task V1
PATCH
/1/tasks/{taskID}deprecated
Update a task V1
DELETE
/1/tasks/{taskID}deprecated
Delete a task
POST
/1/tasks/{taskID}/rundeprecated
Run a task V1
PUT
/1/tasks/{taskID}/enabledeprecated
Enable a task V1
PUT
/1/tasks/{taskID}/disabledeprecated
Disable a task V1
GET
/1/transformations
List transformations
POST
/1/transformations
Create a transformation
POST
/1/transformations/try
Try a transformation before creating it
POST
/1/transformations/search
Search for transformations
GET
/1/transformations/{transformationID}
Retrieve a transformation
PUT
/1/transformations/{transformationID}
Update a transformation
DELETE
/1/transformations/{transformationID}
Delete a transformation
POST
/1/transformations/{transformationID}/try
Try a transformation before updating it
GET
/1/runs
List task runs
GET
/1/runs/{runID}
Retrieve a task run
GET
/1/runs/{runID}/events
List task run events
GET
/1/runs/{runID}/events/{eventID}
Retrieve a task run event
GET
/setClientApiKey
Switch the API key used to authenticate requests
GET
/chunkedPush
Replace all records in an index
Schemas 173
The contract defines 173 schemas that model the data the API accepts and returns. The most detailed are Task (17 properties), TaskV1 (13 properties), Run (13 properties), TaskCreate (11 properties). Each schema is shown below with its type and property counts.
platformNone
string
Authentication resource not tied to any ecommerce platform, used for filtering.
Event
object
An event describe a step of the task execution flow.
7 properties
6 required
SourceUpdateShopify
object
Specific configuration attributes of a shopify source.
1 property
AuthAlgoliaInsights
object
Credentials for authenticating with the Algolia Insights API.
2 properties
2 required
startedAt
string
Date and time when the task started, in RFC 3339 format.
ShopifyMetafield
object
Represents a metafield in Shopify.
3 properties
3 required
TransformationInput
The input for the transformation, which can be either code or a no-code configuration.
TaskReplace
object
API request body for updating a task.
10 properties
2 required
AuthenticationIDs
array
The authentications associated with the current transformation.
MappingKitAction
object
Describes how a destination object should be resolved by means of applying a set of directives.
4 properties
3 required
ActionType
string
Action to perform on the Algolia index.
DestinationUpdateResponse
object
API response for updating a destination.
3 properties
3 required
TransformationUpdateResponse
object
API response for updating a transformation.
2 properties
2 required
TaskCreateTrigger
CreatedAt
string
Date and time when the resource was created, in RFC 3339 format.
sourceShopifyBase
object
1 property
1 required
NextRun
string
The next scheduled run of the task in RFC 3339 format.
DestinationUpdateInput
object
3 properties
transformationIDs
array
SourceCSV
object
Specific configuration attributes of a csv source.
5 properties
1 required
EventType
string
transformationID
string
Universally unique identifier (UUID) of a transformation.
RunStatus
string
Task run status.
LastRun
string
The last time the scheduled task ran in RFC 3339 format.
AuthInput
RunListResponse
object
3 properties
3 required
TransformationCreate
object
API request body for creating a transformation.
6 properties
1 required
TriggerType
string
Task trigger, describing when a task should run. - onDemand. Manually trigger the task with the /run endpoint. - schedule. Regularly trigger the task on a cron…
RunSourcePayload
object
5 properties
AuthenticationUpdateResponse
object
API response for a successful update of an authentication resource.
3 properties
3 required
taskSortKeys
string
Property by which to sort the list of tasks.
AuthSecrets
object
A key:value authentication for your transformations.
Cron
string
Cron expression for the task's schedule.
SourceShopify
PushTaskPayload
object
2 properties
2 required
taskID
string
Universally unique identifier (UUID) of a task.
Code
string
It is deprecated. Use the input field with proper type instead to specify the transformation code.
page
integer
Page of the API response to retrieve.
Name
string
The uniquely identified name of your transformation.
ErrorBase
object
Error.
1 property
EventStatus
SourceUpdateDocker
object
Specific configuration attributes of a docker source.
1 property
1 required
SourceGA4BigQueryExport
object
Specific configuration attributes of a ga4BigqueryExport source.
3 properties
3 required
SourceInput
DockerStreamsSyncMode
string
The strategy to use to fetch the data.
DockerStreams
object
3 properties
2 required
StreamingTrigger
object
Trigger input for continuously running tasks.
1 property
1 required
RunTaskPayload
object
1 property
AttributesToExclude
array
Attributes from your source to exclude from Algolia records. Not all your data attributes will be useful for searching. Keeping your Algolia records small incr…
PublishedAt
string
Date and time when the resource was published, in RFC 3339 format.
destinationID
string
Universally unique identifier (UUID) of a destination resource.
AuthBasic
object
Credentials for authenticating with user name and password.
2 properties
2 required
DestinationCreateResponse
object
API response for creating a new destination.
3 properties
3 required
WatchResponse
object
6 properties
1 required
Description
string
A descriptive name for your transformation of what it does.
TransformationSearch
object
1 property
1 required
DestinationUpdate
object
API request body for updating a destination.
4 properties
DestinationCreate
object
API request body for creating a new destination.
5 properties
3 required
Authentication
object
Resource representing the information required to authenticate with a source or a destination.
8 properties
6 required
updatedAt
string
Date and time when the resource was last updated, in RFC 3339 format.
MappingInput
object
Transformations to apply to the source, serialized as a JSON string.
2 properties
2 required
TaskCreateResponse
object
API response for creating a task.
2 properties
2 required
AuthAlgoliaPartial
object
Credentials for authenticating with Algolia.
2 properties
sourceSortKeys
string
Property by which to sort the list of sources.
Transformation
object
10 properties
5 required
MappingFormatSchema
string
Mapping format schema.
TaskInput
Configuration of the task, depending on its type.
AuthBasicPartial
object
Credentials for authenticating with user name and password.
2 properties
TaskCreateV1
object
API request body for creating a task using the V1 shape. Use methods and types that don't contain the V1 suffix.
8 properties
4 required
TaskSearch
object
1 property
1 required
Run
object
13 properties
6 required
TaskUpdate
object
API request body for partially updating a task.
8 properties
TaskCreate
object
API request body for creating a task.
11 properties
3 required
action
string
Which indexing operation to perform: - addObject: adds records to an index. Equivalent to the "Add a new record (with auto-generated object ID)" operation. - u…
transformationSortKeys
string
Property by which to sort the list of transformations.
AuthenticationType
string
Type of authentication. This determines the type of credentials required in the input object.
AuthenticationCreate
object
Request body for creating a new authentication resource.
4 properties
3 required
RunOutcome
string
Task run outcome.
Trigger
Trigger that runs the task.
TaskUpdateResponse
object
API response for updating a task.
2 properties
2 required
TransformationTry
object
5 properties
1 required
orderKeys
string
Ascending or descending sort order.
OnDemandTriggerType
string
Task is run manually, with the /run endpoint.
StreamingTriggerType
string
Task runs continuously.
ScheduleTriggerInput
object
Trigger input for scheduled tasks.
2 properties
2 required
OnDemandTriggerInput
object
Trigger information for manually-triggered tasks.
1 property
1 required
Window
object
Time window by which to filter the observability data.
2 properties
2 required
AuthenticationSearch
object
Request body for searching for authentication resources.
1 property
1 required
RunType
string
Task run type.
SourceDocker
object
Specific configuration attributes of a docker source.
2 properties
2 required
AuthGoogleServiceAccount
object
Credentials for authenticating with a Google service account, such as BigQuery.
2 properties
2 required
RecordType
string
Record type for ecommerce sources.
CommercetoolsCustomFields
object
Custom fields from commercetools to add to the records. For more information, see [Using Custom Types and Custom Fields](https://docs.commercetools.com/tutoria…
3 properties
SourceUpdateResponse
object
3 properties
3 required
finishedAt
string
Date and time when the task finished, in RFC 3339 format.
sourceID
string
Universally uniqud identifier (UUID) of a source.
platformWithNone
AuthAlgolia
object
Credentials for authenticating with Algolia.
2 properties
2 required
owner
RunID
string
Universally unique identifier (UUID) of a task run.
SourceUpdateCommercetools
object
Specific configuration attributes of a commercetools source.
7 properties
MappingFieldDirective
object
Describes how a field should be resolved by applying a set of directives.
2 properties
2 required
TransformationCreateResponse
object
API response for creating a transformation.
2 properties
2 required
EntityType
string
Type of entity to update.
destinationSortKeys
string
Property by which to sort the destinations.
MappingTypeCSV
string
AuthInputPartial
Enabled
boolean
Whether the task is enabled.
runSortKeys
string
Property by which to sort the list of task runs.
RunReasonCode
string
A code for the task run's outcome. A readable description of the code is included in the reason response property.
ScheduleTrigger
object
Trigger information for scheduled tasks.
4 properties
3 required
SourceCommercetools
object
Specific configuration attributes of a commercetools source.
8 properties
2 required
authenticationID
string
Universally unique identifier (UUID) of an authentication resource.
SourceUpdate
object
3 properties
AuthGoogleServiceAccountPartial
object
Credentials for authenticating with a Google service account, such as BigQuery.
2 properties
SourceType
string
Destination
object
Destinations are Algolia resources like indices or event streams.
9 properties
6 required
DockerStreamsInput
object
The selected streams of an airbyte connector.
1 property
1 required
BigQueryDataType
string
SubscriptionTriggerType
string
Task runs after receiving subscribed event.
AuthenticationCreateResponse
object
API response for the successful creation of an authentication resource.
3 properties
3 required
AuthAPIKeyPartial
object
Credentials for authenticating with an API key.
1 property
SourceUpdateInput
SubscriptionTrigger
object
Trigger input for subscription tasks.
1 property
1 required
TransformationNoCode
object
Input for a no-code transformation that contains a series of steps.
1 property
1 required
name
string
Descriptive name for the resource.
DestinationSearch
object
API request body for searching destinations.
1 property
1 required
RunResponse
object
API response for running a task.
2 properties
2 required
SourceBigCommerce
object
Specific configuration attributes of a bigcommerce source.
5 properties
1 required
AuthOAuth
object
Credentials for authenticating with OAuth 2.0.
5 properties
1 required
objectID
string
Unique record identifier.
AuthAlgoliaInsightsPartial
object
Credentials for authenticating with the Algolia Insights API.
2 properties
ScheduleTriggerType
string
Task runs on a schedule.
BigCommerceChannel
object
2 properties
1 required
SourceJSON
object
Specific configuration attributes of a json source.
3 properties
1 required
Pagination
object
Paginated API response.
4 properties
4 required
TransformationType
string
The type of transformation, which can be either 'code' or 'noCode'.
Task
object
17 properties
6 required
EventID
string
Universally unique identifier (UUID) of an event.
TaskV1
object
The V1 task object. Use methods and types that don't contain the V1 suffix.
13 properties
7 required
Source
object
8 properties
5 required
TaskUpdateV1
object
API request body for updating a task using the V1 shape. Use methods and types that don't contain the V1 suffix.
5 properties
MethodType
string
HTTP method to be used for retrieving your data.
failureThreshold
integer
Maximum accepted percentage of failures for a task run to finish successfully.
AuthenticationUpdate
object
Request body for updating an authentication resource.
2 properties
cursor
string
Date and time when the last cursor was created, in RFC 3339 format.
TransformationCode
object
Input for a transformation that contains the source code of the transformation.
1 property
1 required
itemsPerPage
integer
Number of items per page.
OnDemandTrigger
object
Trigger information for manually-triggered tasks.
2 properties
1 required
TransformationTryResponse
object
2 properties
1 required
AuthOAuthPartial
object
Credentials for authenticating with OAuth 2.0.
5 properties
StreamingInput
object
Input for a streaming task whose source is of type ga4BigqueryExport and for which extracted data is continuously streamed.
1 property
1 required
SourceUpdateAlgoliaIndex
object
Specific configuration attributes of an algoliaIndex source.
2 properties
authenticationSortKeys
string
Property by which to sort the list of authentications.
SourceAlgoliaIndex
object
Specific configuration attributes of an algoliaIndex source.
2 properties
1 required
ShopifyInput
object
Represents the required elements of the task input when using a shopify source.
2 properties
2 required
UniqueIDColumn
string
Name of a column that contains a unique ID which will be used as objectID in Algolia.
Notifications
object
Notifications settings for a task.
1 property
1 required
eventSortKeys
string
Property by which to sort the list of task run events.
ShopifyMarket
object
Represents a market in Shopify.
3 properties
3 required
Policies
object
Set of rules for a task.
1 property
Platform
SourceBigQuery
object
Specific configuration attributes of a bigquery source.
7 properties
2 required
SourceSearch
object
1 property
1 required
SourceCreate
object
4 properties
2 required
BigCommerceMetafield
object
2 properties
2 required
SourceCreateResponse
object
3 properties
3 required
DeleteResponse
object
1 property
1 required
TriggerUpdateInput
object
Trigger for a task update.
1 property
1 required
DestinationInput
object
3 properties
1 required
DestinationType
string
Destination type. - search. Data is stored in an Algolia index. - insights. Data is recorded as user events in the Insights API.
AuthAPIKey
object
Credentials for authenticating with an API key.
1 property
1 required
TransformationNoCodeStep
object
A step in a no-code transformation.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
#Ingestion#Connectors#REST
Where this information came from
This is an independent, third-party profile of Algolia Ingestion API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.