The generated API clients are a work in progress, you can also find our stable clients on the Algolia documentation.

Skip to main content
API docs by Redocly

Ingestion API (1.0)

Download OpenAPI specification:Download

API powering the Data Ingestion feature of Algolia.

Authentications

Authentications describe the way we connect to Algolia, or any platform.

Get a list of authentications

Get a list of authentications.

Authorizations:
(appIdapiKey)
query Parameters
itemsPerPage
integer

The number of items per page to return.

page
integer

The page number to fetch, starting at 1.

Array of AuthenticationType (string) or AuthenticationNone (string) (authenticationTypeWithNone)
Example: type=basic,oauth,none

Which type the returned authentication should have. Can be a list of string separated with commas.

platform
Array of strings (Platform)
Items Enum: "bigcommerce" "commercetools"
Example: platform=commercetools,bigcommerce

Which platform the returned authentication should have. Can be a list of string separated with commas.

Responses

Response samples

Content type
application/json
{
  • "authentications": [
    ],
  • "pagination": {
    }
}

Create a authentication

Create a authentication.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
type
required
string (AuthenticationType)
Enum: "googleServiceAccount" "basic" "apiKey" "oauth" "algolia"
name
required
string
platform
string (Platform)
Enum: "bigcommerce" "commercetools"
required
AuthGoogleServiceAccount (object) or AuthBasic (object) or AuthAPIKey (object) or AuthOAuth (object) or AuthAlgolia (object) (AuthInput)

Responses

Request samples

Content type
application/json
{
  • "type": "googleServiceAccount",
  • "name": "string",
  • "platform": "bigcommerce",
  • "input": {
    }
}

Response samples

Content type
application/json
{
  • "authenticationID": "string",
  • "name": "string",
  • "createdAt": "string"
}

Get a authentication

Get a authentication.

Authorizations:
(appIdapiKey)
path Parameters
authenticationID
required
string
Example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f

The authentication uuid.

Responses

Response samples

Content type
application/json
{
  • "authenticationID": "string",
  • "type": "googleServiceAccount",
  • "name": "string",
  • "platform": "bigcommerce",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "input": {
    }
}

Update a authentication

Update a authentication.

Authorizations:
(appIdapiKey)
path Parameters
authenticationID
required
string
Example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f

The authentication uuid.

Request Body schema: application/json
type
string (AuthenticationType)
Enum: "googleServiceAccount" "basic" "apiKey" "oauth" "algolia"
name
string
platform
string (Platform)
Enum: "bigcommerce" "commercetools"
AuthGoogleServiceAccount (object) or AuthBasic (object) or AuthAPIKey (object) or AuthOAuth (object) or AuthAlgolia (object) (AuthInput)

Responses

Request samples

Content type
application/json
{
  • "type": "googleServiceAccount",
  • "name": "string",
  • "platform": "bigcommerce",
  • "input": {
    }
}

Response samples

Content type
application/json
{
  • "authenticationID": "string",
  • "name": "string",
  • "updatedAt": "string"
}

Delete a authentication

Soft delete a authentication.

Authorizations:
(appIdapiKey)
path Parameters
authenticationID
required
string
Example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f

The authentication uuid.

Responses

Response samples

Content type
application/json
{
  • "deletedAt": "string"
}

Destinations

Destinations refers to an Algolia product (Search, Insight, Recommend, ...).

Get a list of destinations

Get a list of destinations.

Authorizations:
(appIdapiKey)
query Parameters
itemsPerPage
integer

The number of items per page to return.

page
integer

The page number to fetch, starting at 1.

type
Array of strings (DestinationType)
Items Enum: "search" "insights" "flow" "predict"
Example: type=search,predict

Which type the returned destination should have. Can be a list of string separated with commas.

authenticationID
Array of strings

Which authenticationID the returned destination should have. Can be a list of string separated with commas.

Responses

Response samples

Content type
application/json
{
  • "destinations": [
    ],
  • "pagination": {
    }
}

Create a destination

Create a destination.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
type
required
string (DestinationType)
Enum: "search" "insights" "flow" "predict"
name
required
string
required
DestinationIndexPrefix (object) or DestinationIndexName (object) (DestinationInput)
authenticationID
required
string

Responses

Request samples

Content type
application/json
{
  • "type": "search",
  • "name": "string",
  • "input": {
    },
  • "authenticationID": "string"
}

Response samples

Content type
application/json
{
  • "destinationID": "string",
  • "name": "string",
  • "createdAt": "string"
}

Get a destination

Get a destination.

Authorizations:
(appIdapiKey)
path Parameters
destinationID
required
string
Example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f

The destination uuid.

Responses

Response samples

Content type
application/json
{
  • "destinationID": "string",
  • "type": "search",
  • "name": "string",
  • "input": {
    },
  • "createdAt": "string",
  • "updatedAt": "string",
  • "authenticationID": "string"
}

Update a destination

Update a destination.

Authorizations:
(appIdapiKey)
path Parameters
destinationID
required
string
Example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f

The destination uuid.

Request Body schema: application/json
type
string (DestinationType)
Enum: "search" "insights" "flow" "predict"
name
string
DestinationIndexPrefix (object) or DestinationIndexName (object) (DestinationInput)
authenticationID
string

Responses

Request samples

Content type
application/json
{
  • "type": "search",
  • "name": "string",
  • "input": {
    },
  • "authenticationID": "string"
}

Response samples

Content type
application/json
{
  • "destinationID": "string",
  • "name": "string",
  • "updatedAt": "string"
}

Delete a destination

Soft delete a destination.

Authorizations:
(appIdapiKey)
path Parameters
destinationID
required
string
Example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f

The destination uuid.

Responses

Response samples

Content type
application/json
{
  • "deletedAt": "string"
}

Observability

Observability api tracks each runs and events.

Get a list of runs

Get a list of runs.

Authorizations:
(appIdapiKey)
query Parameters
itemsPerPage
integer

The number of items per page to return.

page
integer

The page number to fetch, starting at 1.

Responses

Response samples

Content type
application/json
{
  • "runs": [
    ],
  • "pagination": {
    }
}

Get a run

Get a run.

Authorizations:
(appIdapiKey)
path Parameters
runID
required
string
Example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f

The run uuid.

Responses

Response samples

Content type
application/json
{
  • "runID": "string",
  • "appID": "string",
  • "taskID": "string",
  • "status": "created",
  • "progress": {
    },
  • "outcome": "success",
  • "type": "reindex",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "startedAt": "string",
  • "finishedAt": "string"
}

Get a list of events for a specific run

Get a list of events for a specific run.

Authorizations:
(appIdapiKey)
path Parameters
runID
required
string
Example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f

The run uuid.

query Parameters
itemsPerPage
integer

The number of items per page to return.

page
integer

The page number to fetch, starting at 1.

Responses

Response samples

Content type
application/json
{
  • "events": [
    ],
  • "pagination": {
    }
}

Get an event in a specific run

Get an event in a specific run.

Authorizations:
(appIdapiKey)
path Parameters
runID
required
string
Example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f

The run uuid.

eventID
required
string
Example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f

The event uuid.

Responses

Response samples

Content type
application/json
{
  • "eventID": "string",
  • "runID": "string",
  • "parentID": "string",
  • "status": "created",
  • "type": "fetch",
  • "data": { },
  • "publishedAt": "string"
}

Get a list of runs associated with a taskID

Get a list of runs associated with a taskID.

Authorizations:
(appIdapiKey)
path Parameters
taskID
required
string
Example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f

The task uuid.

query Parameters
itemsPerPage
integer

The number of items per page to return.

page
integer

The page number to fetch, starting at 1.

Responses

Response samples

Content type
application/json
{
  • "runs": [
    ],
  • "pagination": {
    }
}

Sources

Sources describe the platform informations.

Get a list of sources

Get a list of sources.

Authorizations:
(appIdapiKey)
query Parameters
itemsPerPage
integer

The number of items per page to return.

page
integer

The page number to fetch, starting at 1.

type
Array of strings (SourceType)
Items Enum: "bigcommerce" "commercetools" "json"
Example: type=commercetools,bigcommerce

Which type the returned source should have. Can be a list of string separated with commas.

authenticationID
Array of strings

Which authenticationID the returned source should have. Can be a list of string separated with commas.

Responses

Response samples

Content type
application/json
{
  • "sources": [
    ],
  • "pagination": {
    }
}

Create a source

Create a source.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
type
required
string (SourceType)
Enum: "bigcommerce" "commercetools" "json"
name
required
string
required
SourceCommercetools (object) or SourceBigCommerce (object) or SourceJson (object) (SourceInput)
authenticationID
required
string

Responses

Request samples

Content type
application/json
{
  • "type": "bigcommerce",
  • "name": "string",
  • "input": {
    },
  • "authenticationID": "string"
}

Response samples

Content type
application/json
{
  • "sourceID": "string",
  • "name": "string",
  • "createdAt": "string"
}

Get a source

Get a source.

Authorizations:
(appIdapiKey)
path Parameters
sourceID
required
string
Example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f

The source uuid.

Responses

Response samples

Content type
application/json
{
  • "sourceID": "string",
  • "type": "bigcommerce",
  • "name": "string",
  • "input": {
    },
  • "authenticationID": "string",
  • "createdAt": "string",
  • "updatedAt": "string"
}

Update a source

Update a source.

Authorizations:
(appIdapiKey)
path Parameters
sourceID
required
string
Example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f

The source uuid.

Request Body schema: application/json
type
string (SourceType)
Enum: "bigcommerce" "commercetools" "json"
name
string
SourceCommercetools (object) or SourceBigCommerce (object) or SourceJson (object) (SourceInput)
authenticationID
string

Responses

Request samples

Content type
application/json
{
  • "type": "bigcommerce",
  • "name": "string",
  • "input": {
    },
  • "authenticationID": "string"
}

Response samples

Content type
application/json
{
  • "sourceID": "string",
  • "name": "string",
  • "updatedAt": "string"
}

Delete a source

Soft delete a source.

Authorizations:
(appIdapiKey)
path Parameters
sourceID
required
string
Example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f

The source uuid.

Responses

Response samples

Content type
application/json
{
  • "deletedAt": "string"
}

Tasks

Tasks refers to all type of Ingestion we can do (Reindex, On demand update, ...).

Get a list of tasks

Get a list of tasks.

Authorizations:
(appIdapiKey)
query Parameters
itemsPerPage
integer

The number of items per page to return.

page
integer

The page number to fetch, starting at 1.

action
Array of strings (ActionType)
Items Enum: "replace" "save" "delete"
Example: action=save,replace

Which action the returned task should have. Can be a list of string separated with commas.

enabled
boolean

If the returned task should have its 'enabled' property set to true.

destinationID
Array of strings

Which destinationID the returned task should have. Can be a list of string separated with commas.

triggerType
Array of strings (TriggerType)
Items Enum: "on_demand" "schedule" "subscription"
Example: triggerType=on_demand,schedule

Which trigger type the returned task should have. Can be a list of string separated with commas.

Responses

Response samples

Content type
application/json
{
  • "tasks": [
    ],
  • "pagination": {
    }
}

Create a task

Create a task.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
sourceID
required
string
destinationID
required
string
required
object (TriggerInput)
action
required
string (ActionType)
Enum: "replace" "save" "delete"
enabled
boolean

Responses

Request samples

Content type
application/json
{
  • "sourceID": "string",
  • "destinationID": "string",
  • "trigger": {
    },
  • "action": "replace",
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "taskID": "string",
  • "createdAt": "string"
}

Get a task

Get a task.

Authorizations:
(appIdapiKey)
path Parameters
taskID
required
string
Example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f

The task uuid.

Responses

Response samples

Content type
application/json
{
  • "taskID": "string",
  • "sourceID": "string",
  • "destinationID": "string",
  • "trigger": {
    },
  • "enabled": true,
  • "action": "replace",
  • "createdAt": "string",
  • "updatedAt": "string"
}

Update a task

Update a task.

Authorizations:
(appIdapiKey)
path Parameters
taskID
required
string
Example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f

The task uuid.

Request Body schema: application/json
destinationID
string
object (TriggerInput)
enabled
boolean

Responses

Request samples

Content type
application/json
{
  • "destinationID": "string",
  • "trigger": {
    },
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "taskID": "string",
  • "updatedAt": "string"
}

Delete a task

Soft delete a task.

Authorizations:
(appIdapiKey)
path Parameters
taskID
required
string
Example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f

The task uuid.

Responses

Response samples

Content type
application/json
{
  • "deletedAt": "string"
}

Run a task

Run a task.

Authorizations:
(appIdapiKey)
path Parameters
taskID
required
string
Example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f

The task uuid.

Responses

Response samples

Content type
application/json
{
  • "runID": "string",
  • "createdAt": "string"
}

Enable a task

Enable a task.

Authorizations:
(appIdapiKey)
path Parameters
taskID
required
string
Example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f

The task uuid.

Responses

Response samples

Content type
application/json
{
  • "taskID": "string",
  • "updatedAt": "string"
}

Disable a task

Disable a task.

Authorizations:
(appIdapiKey)
path Parameters
taskID
required
string
Example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f

The task uuid.

Responses

Response samples

Content type
application/json
{
  • "taskID": "string",
  • "updatedAt": "string"
}