> ## Documentation Index
> Fetch the complete documentation index at: https://algolia.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Run all tasks linked to a source

> Runs all tasks linked to a source, only available for Shopify, BigCommerce and commercetools sources.

Creates one run per task.

**Required ACL:** `addObject`, `deleteIndex`, `editSettings`


## OpenAPI

````yaml specs/ingestion.yml post /1/sources/{sourceID}/run
openapi: 3.1.0
info:
  title: Ingestion API
  summary: >-
    The Ingestion API lets you connect third-party services and platforms with
    Algolia and schedule tasks to ingest your data
  description: >
    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 URL that matches your [analytics
    region](https://dashboard.algolia.com/account/infrastructure/analytics).


    **All requests must use HTTPS.**


    ## Authentication


    Add these headers to authenticate requests:


    - `x-algolia-application-id`. Your Algolia application ID.

    - `x-algolia-api-key`. An API key with the necessary permissions to make the
    request.
      The required access control list (ACL) to make a request is listed in each endpoint's reference.

    You can find your application ID and API key in the [Algolia
    dashboard](https://dashboard.algolia.com/account/api-keys).


    ## Request format


    Request bodies must be JSON objects.


    ## Response status and errors


    Response bodies are JSON objects.


    Successful responses return `2xx` statuses. Client errors return `4xx`
    statuses. Server errors return `5xx` statuses.

    Error responses have a `message` property with more information.


    ## Version


    The current version of the Ingestion API is version 1, indicated by the
    `/1/` in each endpoint's URL.
  version: 1.0.0
servers:
  - url: https://data.{region}.algolia.com
    variables:
      region:
        description: The region where your Algolia application is hosted.
        enum:
          - eu
          - us
        default: us
security:
  - appId: []
    apiKey: []
tags:
  - name: authentications
    x-displayName: Authentications
    description: >-
      Authentication resources describe how to connect to a source or
      destination.
  - name: destinations
    x-displayName: Destinations
    description: >
      Destinations are Algolia products or features where your data should be
      used, such as a search index or events.

      Algolia destinations require authentication with the `algolia` type.

      You can reference authentications by their ID when creating destinations.
  - name: observability
    x-displayName: Observability
    description: >-
      Check the status and details of your task runs. A run is one instance of a
      configured task.
  - name: sources
    x-displayName: Sources
    description: >
      Sources are third-party platforms or services from where you want to
      ingest your data.

      Sources may require authentication. To interact with such sources, you can
      reference an authentication resource by its ID.
  - name: tasks
    x-displayName: Tasks
    description: >
      Tasks contain information how your data should be read from a source and
      stored in a destination.

      Tasks have _triggers_ which determine when the task should run.
  - name: transformations
    x-displayName: Transformations
    description: >
      Transformations let you transform a record before it gets indexed in
      Algolia.
paths:
  /1/sources/{sourceID}/run:
    post:
      tags:
        - sources
      summary: Run all tasks linked to a source
      description: >-
        Runs all tasks linked to a source, only available for Shopify,
        BigCommerce and commercetools sources. Creates one run per task.
      operationId: runSource
      parameters:
        - $ref: '#/components/parameters/pathSourceID'
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RunSourcePayload'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: runSourceResponse
                type: object
                properties:
                  createdAt:
                    $ref: '#/components/schemas/CreatedAt'
                  taskWithRunID:
                    type: object
                    description: >-
                      Map of taskID sent for reindex with the corresponding
                      runID.
                    additionalProperties:
                      type: string
                required:
                  - taskWithRunID
                  - createdAt
        '400':
          $ref: '#/components/responses/BadRequest'
      x-codeSamples:
        - lang: csharp
          label: C#
          source: |-
            // Initialize the client
            var client = new IngestionClient(
              new IngestionConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION")
            );

            // Call the API
            var response = await client.RunSourceAsync(
              "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
              new RunSourcePayload
              {
                IndexToInclude = new List<string> { "products_us", "products eu" },
                EntityIDs = new List<string> { "1234", "5678" },
                EntityType = Enum.Parse<EntityType>("Product"),
              }
            );

            // print the response
            Console.WriteLine(response);
        - lang: dart
          label: Dart
          source: |-
            // Initialize the client
            final client = IngestionClient(
                appId: 'ALGOLIA_APPLICATION_ID',
                apiKey: 'ALGOLIA_API_KEY',
                region: 'ALGOLIA_APPLICATION_REGION');

            // Call the API
            final response = await client.runSource(
              sourceID: "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
              runSourcePayload: RunSourcePayload(
                indexToInclude: [
                  "products_us",
                  "products eu",
                ],
                entityIDs: [
                  "1234",
                  "5678",
                ],
                entityType: EntityType.fromJson("product"),
              ),
            );

            // print the response
            print(response);
        - lang: go
          label: Go
          source: >-
            // Initialize the client with your application region, eg.
            ingestion.ALGOLIA_APPLICATION_REGION

            client, err := ingestion.NewClient("ALGOLIA_APPLICATION_ID",
            "ALGOLIA_API_KEY", ingestion.US)

            if err != nil {
              // The client can fail to initialize if you pass an invalid parameter.
              panic(err)
            }


            // Call the API

            response, err := client.RunSource(client.NewApiRunSourceRequest(
              "6c02aeb1-775e-418e-870b-1faccd4b2c0f").WithRunSourcePayload(
              ingestion.NewEmptyRunSourcePayload().SetIndexToInclude(
                []string{"products_us", "products eu"}).SetEntityIDs(
                []string{"1234", "5678"}).SetEntityType(ingestion.EntityType("product"))))
            if err != nil {
              // handle the eventual error
              panic(err)
            }



            // print the response

            print(response)
        - lang: java
          label: Java
          source: >-
            // Initialize the client

            IngestionClient client = new
            IngestionClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY",
            "ALGOLIA_APPLICATION_REGION");


            // Call the API

            RunSourceResponse response = client.runSource(
              "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
              new RunSourcePayload()
                .setIndexToInclude(Arrays.asList("products_us", "products eu"))
                .setEntityIDs(Arrays.asList("1234", "5678"))
                .setEntityType(EntityType.PRODUCT)
            );


            // print the response

            System.out.println(response);
        - lang: javascript
          label: JavaScript
          source: >-
            // Initialize the client

            // Replace 'us' with your Algolia Application Region

            const client = algoliasearch('ALGOLIA_APPLICATION_ID',
            'ALGOLIA_API_KEY').initIngestion({ region: 'us' });


            // Call the API

            const response = await client.runSource({
              sourceID: '6c02aeb1-775e-418e-870b-1faccd4b2c0f',
              runSourcePayload: {
                indexToInclude: ['products_us', 'products eu'],
                entityIDs: ['1234', '5678'],
                entityType: 'product',
              },
            });



            // print the response

            console.log(response);
        - lang: kotlin
          label: Kotlin
          source: |-
            // Initialize the client
            val client =
              IngestionClient(
                appId = "ALGOLIA_APPLICATION_ID",
                apiKey = "ALGOLIA_API_KEY",
                region = "ALGOLIA_APPLICATION_REGION",
              )

            // Call the API
            var response =
              client.runSource(
                sourceID = "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
                runSourcePayload =
                  RunSourcePayload(
                    indexToInclude = listOf("products_us", "products eu"),
                    entityIDs = listOf("1234", "5678"),
                    entityType = EntityType.entries.first { it.value == "product" },
                  ),
              )


            // print the response
            println(response)
        - lang: php
          label: PHP
          source: >-
            // Initialize the client

            $client = IngestionClient::create('ALGOLIA_APPLICATION_ID',
            'ALGOLIA_API_KEY', 'ALGOLIA_APPLICATION_REGION');


            // Call the API

            $response = $client->runSource(
                '6c02aeb1-775e-418e-870b-1faccd4b2c0f',
                ['indexToInclude' => [
                    'products_us',

                    'products eu',
                ],
                    'entityIDs' => [
                        '1234',

                        '5678',
                    ],
                    'entityType' => 'product',
                ],
            );



            // print the response

            var_dump($response);
        - lang: python
          label: Python
          source: >-
            # Initialize the client

            # In an asynchronous context, you can use IngestionClient instead,
            which exposes the exact same methods.

            client = IngestionClientSync(
                "ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION"
            )


            # Call the API

            response = client.run_source(
                source_id="6c02aeb1-775e-418e-870b-1faccd4b2c0f",
                run_source_payload={
                    "indexToInclude": [
                        "products_us",
                        "products eu",
                    ],
                    "entityIDs": [
                        "1234",
                        "5678",
                    ],
                    "entityType": "product",
                },
            )



            # print the response

            print(response)
        - lang: ruby
          label: Ruby
          source: >-
            # Initialize the client

            client = Algolia::IngestionClient.create("ALGOLIA_APPLICATION_ID",
            "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION")


            # Call the API

            response = client.run_source(
              "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
              Algolia::Ingestion::RunSourcePayload.new(
                index_to_include: ["products_us", "products eu"],
                entity_ids: ["1234", "5678"],
                entity_type: "product"
              )
            )



            # print the response

            puts(response)
        - lang: scala
          label: Scala
          source: |-
            // Initialize the client
            val client = IngestionClient(
              appId = "ALGOLIA_APPLICATION_ID",
              apiKey = "ALGOLIA_API_KEY",
              region = "ALGOLIA_APPLICATION_REGION"
            )

            // Call the API
            val response = Await.result(
              client.runSource(
                sourceID = "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
                runSourcePayload = Some(
                  RunSourcePayload(
                    indexToInclude = Some(Seq("products_us", "products eu")),
                    entityIDs = Some(Seq("1234", "5678")),
                    entityType = Some(EntityType.withName("product"))
                  )
                )
              ),
              Duration(100, "sec")
            )

            // print the response
            println(response)
        - lang: swift
          label: Swift
          source: >-
            // Initialize the client

            let client = try IngestionClient(appID: "ALGOLIA_APPLICATION_ID",
            apiKey: "ALGOLIA_API_KEY", region: .us)


            // Call the API

            let response = try await client.runSource(
                sourceID: "6c02aeb1-775e-418e-870b-1faccd4b2c0f",
                runSourcePayload: RunSourcePayload(
                    indexToInclude: ["products_us", "products eu"],
                    entityIDs: ["1234", "5678"],
                    entityType: EntityType.product
                )
            )


            // print the response

            print(response)
        - lang: cURL
          label: curl
          source: |-
            curl --request POST \
              --url https://data.us.algolia.com/1/sources/6c02aeb1-775e-418e-870b-1faccd4b2c0f/run \
              --header 'accept: application/json' \
              --header 'content-type: application/json' \
              --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
              --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' \
              --data '
            {
              "indexToInclude": [
                "lorem"
              ],
              "indexToExclude": [
                "lorem"
              ],
              "entityIDs": [
                "lorem"
              ],
              "entityType": "product",
              "runMetadata": {}
            }
            '
components:
  parameters:
    pathSourceID:
      name: sourceID
      in: path
      required: true
      description: Unique identifier of a source.
      schema:
        $ref: '#/components/schemas/sourceID'
  schemas:
    RunSourcePayload:
      type: object
      additionalProperties: false
      properties:
        entityIDs:
          type: array
          items:
            type: string
          description: List of entityIDs to update.
        entityType:
          $ref: '#/components/schemas/EntityType'
        indexToExclude:
          type: array
          description: List of index names to exclude in reindex/update.
          items:
            type: string
        indexToInclude:
          type: array
          description: List of index names to include in reindex/update.
          items:
            type: string
        runMetadata:
          type: object
          additionalProperties: true
          description: Additional information that will be passed to the created runs.
    CreatedAt:
      type: string
      description: Date and time when the resource was created, in RFC 3339 format.
    sourceID:
      type: string
      description: Universally uniqud identifier (UUID) of a source.
      example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f
    EntityType:
      type: string
      description: Type of entity to update.
      enum:
        - product
        - collection
    ErrorBase:
      description: Error.
      type: object
      x-keep-model: true
      additionalProperties: true
      properties:
        message:
          type: string
          example: Invalid Application-Id or API-Key
  responses:
    BadRequest:
      description: Bad request or request arguments.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBase'
  securitySchemes:
    appId:
      type: apiKey
      in: header
      name: x-algolia-application-id
      description: Your Algolia application ID.
    apiKey:
      type: apiKey
      in: header
      name: x-algolia-api-key
      description: >
        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.

````