# Ingestion API API

> Ingestion API API on Apizie: 52 endpoints (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, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/search-tools:algolia-ingestion/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `search-tools:algolia-ingestion`
- Category: Search Tools
- Status: byok
- Source: https://algolia
- Page: https://apizie.tech/api/search-tools/algolia-ingestion
- OpenAPI: https://apizie.tech/api/search-tools/algolia-ingestion/openapi.json

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

## Endpoints

### Send requests to the Algolia REST API
`GET https://apizie.tech/v1/search-tools:algolia-ingestion/custom-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| path | string | yes | Path of the endpoint, for example `1/newFeature`. |
| parameters | object | no | Query parameters to apply to the current query. |

### Send requests to the Algolia REST API
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/custom-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| path | string | yes | Path of the endpoint, for example `1/newFeature`. |
| parameters | object | no | Query parameters to apply to the current query. |
| body | object | no | JSON request body |

### Send requests to the Algolia REST API
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/custom-put` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| path | string | yes | Path of the endpoint, for example `1/newFeature`. |
| parameters | object | no | Query parameters to apply to the current query. |
| body | object | no | JSON request body |

### Send requests to the Algolia REST API
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/custom-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| path | string | yes | Path of the endpoint, for example `1/newFeature`. |
| parameters | object | no | Query parameters to apply to the current query. |

### Push records by indexName
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/push` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| indexName | string | yes | Name of the index on which to perform the operation. |
| watch | boolean | no | When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding. |
| referenceIndexName | string | no | This is required when targeting an index that does not have a push connector setup (e.g. a tmp index), but you wish to attach another… |
| body | object | yes | JSON request body |

### List authentication resources
`GET https://apizie.tech/v1/search-tools:algolia-ingestion/list-authentications` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| itemsPerPage | integer | no | Number of items per page. |
| page | integer | no | Page number of the paginated API response. |
| type | array | no | Type of authentication resource to retrieve. |
| platform | array | no | Ecommerce platform for which to retrieve authentications. |
| sort | string | no | Property by which to sort the list of authentications. |
| order | string | no | Sort order of the response, ascending or descending. |

### Create an authentication resource
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/create-authentication` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| body | object | yes | JSON request body |

### Search for authentication resources
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/search-authentications` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| body | object | yes | JSON request body |

### Retrieve an authentication resource
`GET https://apizie.tech/v1/search-tools:algolia-ingestion/get-authentication` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| authenticationID | string | yes | Unique identifier of an authentication resource. |

### Update an authentication resource
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/update-authentication` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| authenticationID | string | yes | Unique identifier of an authentication resource. |
| body | object | yes | JSON request body |

### Delete an authentication resource
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/delete-authentication` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| authenticationID | string | yes | Unique identifier of an authentication resource. |

### List destinations
`GET https://apizie.tech/v1/search-tools:algolia-ingestion/list-destinations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| itemsPerPage | integer | no | Number of items per page. |
| page | integer | no | Page number of the paginated API response. |
| type | array | no | Destination type. |
| authenticationID | array | no | Authentication ID used by destinations. |
| transformationID | string | no | Get the list of destinations used by a transformation. |
| sort | string | no | Property by which to sort the destinations. |
| order | string | no | Sort order of the response, ascending or descending. |

### Create a destination
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/create-destination` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| body | object | yes | JSON request body |

### Search for destinations
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/search-destinations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| body | object | yes | JSON request body |

### Retrieve a destination
`GET https://apizie.tech/v1/search-tools:algolia-ingestion/get-destination` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| destinationID | string | yes | Unique identifier of a destination. |

### Update a destination
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/update-destination` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| destinationID | string | yes | Unique identifier of a destination. |
| body | object | yes | JSON request body |

### Delete a destination
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/delete-destination` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| destinationID | string | yes | Unique identifier of a destination. |

### List sources
`GET https://apizie.tech/v1/search-tools:algolia-ingestion/list-sources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| itemsPerPage | integer | no | Number of items per page. |
| page | integer | no | Page number of the paginated API response. |
| type | array | no | Source type. Some sources require authentication. |
| authenticationID | array | no | Authentication IDs of the sources to retrieve. 'none' returns sources that doesn't have an authentication. |
| sort | string | no | Property by which to sort the list of sources. |
| order | string | no | Sort order of the response, ascending or descending. |

### Create a source
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/create-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| body | object | yes | JSON request body |

### Validate a source payload
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/validate-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| body | object | no | JSON request body |

### Search for sources
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/search-sources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| body | object | yes | JSON request body |

### Retrieve a source
`GET https://apizie.tech/v1/search-tools:algolia-ingestion/get-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| sourceID | string | yes | Unique identifier of a source. |

### Update a source
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/update-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| sourceID | string | yes | Unique identifier of a source. |
| body | object | yes | JSON request body |

### Delete a source
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/delete-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| sourceID | string | yes | Unique identifier of a source. |

### Validate an update of a source payload
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/validate-source-before-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| sourceID | string | yes | Unique identifier of a source. |
| body | object | yes | JSON request body |

### Trigger a stream-listing request
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/trigger-docker-source-discover` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| sourceID | string | yes | Unique identifier of a source. |

### Run all tasks linked to a source
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/run-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| sourceID | string | yes | Unique identifier of a source. |
| body | object | no | JSON request body |

### List tasks
`GET https://apizie.tech/v1/search-tools:algolia-ingestion/list-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| itemsPerPage | integer | no | Number of items per page. |
| page | integer | no | Page number of the paginated API response. |
| action | array | no | Actions for filtering the list of tasks. |
| enabled | boolean | no | Whether to filter the list of tasks by the `enabled` status. |
| sourceID | array | no | Source IDs for filtering the list of tasks. |
| sourceType | array | no | Filters the tasks with the specified source type. |
| destinationID | array | no | Destination IDs for filtering the list of tasks. |
| triggerType | array | no | Type of task trigger for filtering the list of tasks. |
| withEmailNotifications | boolean | no | If specified, the response only includes tasks with notifications.email.enabled set to this value. |
| sort | string | no | Property by which to sort the list of tasks. |
| order | string | no | Sort order of the response, ascending or descending. |

### Create a task
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/create-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| body | object | yes | JSON request body |

### Search for tasks
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/search-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| body | object | yes | JSON request body |

### Retrieve a task
`GET https://apizie.tech/v1/search-tools:algolia-ingestion/get-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| taskID | string | yes | Unique identifier of a task. |

### Fully update a task
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/replace-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| taskID | string | yes | Unique identifier of a task. |
| body | object | yes | JSON request body |

### Partially update a task
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/update-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| taskID | string | yes | Unique identifier of a task. |
| body | object | yes | JSON request body |

### Delete a task
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/delete-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| taskID | string | yes | Unique identifier of a task. |

### Run a task
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/run-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| taskID | string | yes | Unique identifier of a task. |
| body | object | no | JSON request body |

### Push records by task ID
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/push-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| taskID | string | yes | Unique identifier of a task. |
| watch | boolean | no | When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding. |
| body | object | yes | JSON request body |

### Enable a task
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/enable-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| taskID | string | yes | Unique identifier of a task. |

### Disable a task
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/disable-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| taskID | string | yes | Unique identifier of a task. |

### List transformations
`GET https://apizie.tech/v1/search-tools:algolia-ingestion/list-transformations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| itemsPerPage | integer | no | Number of items per page. |
| page | integer | no | Page number of the paginated API response. |
| sort | string | no | Property by which to sort the list of transformations. |
| order | string | no | Sort order of the response, ascending or descending. |
| type | string | no | Whether to filter the list of transformations by the type of transformation. |

### Create a transformation
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/create-transformation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| body | object | yes | JSON request body |

### Try a transformation before creating it
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/try-transformation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| body | object | yes | JSON request body |

### Search for transformations
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/search-transformations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| body | object | yes | JSON request body |

### Retrieve a transformation
`GET https://apizie.tech/v1/search-tools:algolia-ingestion/get-transformation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| transformationID | string | yes | Unique identifier of a transformation. |

### Update a transformation
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/update-transformation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| transformationID | string | yes | Unique identifier of a transformation. |
| body | object | yes | JSON request body |

### Delete a transformation
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/delete-transformation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| transformationID | string | yes | Unique identifier of a transformation. |

### Try a transformation before updating it
`POST https://apizie.tech/v1/search-tools:algolia-ingestion/try-transformation-before-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| transformationID | string | yes | Unique identifier of a transformation. |
| body | object | yes | JSON request body |

### List task runs
`GET https://apizie.tech/v1/search-tools:algolia-ingestion/list-runs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| itemsPerPage | integer | no | Number of items per page. |
| page | integer | no | Page number of the paginated API response. |
| status | array | no | Run status for filtering the list of task runs. |
| type | array | no | Run type for filtering the list of task runs. |
| taskID | string | no | Task ID for filtering the list of task runs. |
| sort | string | no | Property by which to sort the list of task runs. |
| order | string | no | Sort order of the response, ascending or descending. |
| startDate | string | no | Date and time for the earliest run to retrieve, in RFC 3339 format. By default, the current day minus seven days is used. |
| endDate | string | no | Date and time for the latest run to retrieve, in RFC 3339 format. By default, the current day is used. |

### Retrieve a task run
`GET https://apizie.tech/v1/search-tools:algolia-ingestion/get-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| runID | string | yes | Unique identifier of a task run. |

### List task run events
`GET https://apizie.tech/v1/search-tools:algolia-ingestion/list-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| runID | string | yes | Unique identifier of a task run. |
| itemsPerPage | integer | no | Number of items per page. |
| page | integer | no | Page number of the paginated API response. |
| status | array | no | Event status for filtering the list of task runs. |
| type | array | no | Event type for filtering the list of task runs. |
| sort | string | no | Property by which to sort the list of task run events. |
| order | string | no | Sort order of the response, ascending or descending. |
| startDate | string | no | Date and time in RFC 3339 format for the earliest events to retrieve. By default, the current time minus three hours is used. |
| endDate | string | no | Date and time in RFC 3339 format for the latest events to retrieve. By default, the current time is used. |

### Retrieve a task run event
`GET https://apizie.tech/v1/search-tools:algolia-ingestion/get-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| runID | string | yes | Unique identifier of a task run. |
| eventID | string | yes | Unique identifier of an event. |

### Switch the API key used to authenticate requests
`GET https://apizie.tech/v1/search-tools:algolia-ingestion/set-client-api-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| apiKey | string | yes | API key to use for subsequent requests. |

### Replace all records in an index
`GET https://apizie.tech/v1/search-tools:algolia-ingestion/chunked-push` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| region | string | no | The region where your Algolia application is hosted. |
| indexName | string | yes | The `indexName` to replace `objects` in. |
| objects | array | yes | List of objects to replace the current objects with. |
| action | string | no | The `batch` `action` to perform on the given array of `objects`, defaults to `addObject`. |
| waitForTasks | boolean | no | Whether to wait until every `batch` task has been processed. This may take longer but is more reliable. |
| batchSize | integer | no | The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1,000. |

## Example
```
curl "https://apizie.tech/v1/search-tools:algolia-ingestion/custom-get" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Ingestion API API?
Create a free Apizie key, then send GET https://apizie.tech/v1/search-tools:algolia-ingestion/custom-get with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Ingestion API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Ingestion API itself also needs your own key from algolia.

### Can AI agents use the Ingestion API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key search-tools:algolia-ingestion.

### What is the status of the Ingestion API API?
Needs your own provider key (bring your own key)