POST /2/tasks/{taskID}/push
Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the watch parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task.
If you want to leverage the pre-indexing data transformation, this is the recommended way of ingesting your records.
This method is similar to push, but requires a taskID instead of a indexName, which is useful when many destinations target the same indexName.
Servers
- https://data.{region}.algolia.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
taskID |
String | Yes |
Unique identifier of a task. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
watch |
Boolean | No |
When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
records[] |
Array | Yes | |
records[].objectID |
String | Yes |
Unique record identifier. |
action |
String | Yes |
Type of indexing operation. Possible values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.