Skip to main content
GET
/
1
/
indexes
/
{indexName}
/
{model}
/
task
/
{taskID}
curl
curl --request GET \
  --url https://algolia_application_id.algolia.net/1/indexes/ALGOLIA_INDEX_NAME/related-products/task/1514562690001 \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'
{
  "status": "published"
}
Required ACL: editSettings

Authorizations

​
x-algolia-application-id
string
header
required

Your Algolia application ID.

​
x-algolia-api-key
string
header
required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Path Parameters

​
indexName
string
required

Name of the index on which to perform the operation.

Example:

"ALGOLIA_INDEX_NAME"

​
model
enum<string>
required

Recommend model.

Available options:
related-products,
bought-together,
trending-facets,
trending-items
​
taskID
integer
required

Unique task identifier.

Example:

1514562690001

Response

OK

​
status
enum<string>
required

Task status, published if the task is completed, notPublished otherwise.

Available options:
published,
notPublished
⌘I