> ## Documentation Index > Fetch the complete documentation index at: https://algolia.com/llms.txt > Use this file to discover all available pages before exploring further. # Create a source > Creates a new source. **Required ACL:** `addObject`, `deleteIndex`, `editSettings` ## OpenAPI ````yaml specs/ingestion.yml post /1/sources 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: post: tags: - sources summary: Create a source description: Creates a new source. operationId: createSource requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/SourceCreate' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SourceCreateResponse' '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.CreateSourceAsync( new SourceCreate { Type = Enum.Parse("Commercetools"), Name = "sourceName", Input = new SourceInput( new SourceCommercetools { StoreKeys = new List { "myStore" }, Locales = new List { "de" }, Url = "http://commercetools.com", ProjectKey = "keyID", ProductQueryPredicate = "masterVariant(attributes(name=\"Brand\" and value=\"Algolia\"))", } ), AuthenticationID = "6c02aeb1-775e-418e-870b-1faccd4b2c0f", } ); // 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.createSource( sourceCreate: SourceCreate( type: SourceType.fromJson("commercetools"), name: "sourceName", input: SourceCommercetools( storeKeys: [ "myStore", ], locales: [ "de", ], url: "http://commercetools.com", projectKey: "keyID", productQueryPredicate: "masterVariant(attributes(name=\"Brand\" and value=\"Algolia\"))", ), authenticationID: "6c02aeb1-775e-418e-870b-1faccd4b2c0f", ), ); // 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.CreateSource(client.NewApiCreateSourceRequest( ingestion.NewEmptySourceCreate(). SetType(ingestion.SourceType("commercetools")). SetName("sourceName"). SetInput(ingestion.SourceCommercetoolsAsSourceInput( ingestion.NewEmptySourceCommercetools().SetStoreKeys( []string{"myStore"}).SetLocales( []string{ "de", }). SetUrl("http://commercetools.com"). SetProjectKey("keyID").SetProductQueryPredicate("masterVariant(attributes(name=\"Brand\" and value=\"Algolia\"))"))). SetAuthenticationID("6c02aeb1-775e-418e-870b-1faccd4b2c0f"), )) 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 SourceCreateResponse response = client.createSource( new SourceCreate() .setType(SourceType.COMMERCETOOLS) .setName("sourceName") .setInput( new SourceCommercetools() .setStoreKeys(Arrays.asList("myStore")) .setLocales(Arrays.asList("de")) .setUrl("http://commercetools.com") .setProjectKey("keyID") .setProductQueryPredicate("masterVariant(attributes(name=\"Brand\" and value=\"Algolia\"))") ) .setAuthenticationID("6c02aeb1-775e-418e-870b-1faccd4b2c0f") ); // 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.createSource({ type: 'commercetools', name: 'sourceName', input: { storeKeys: ['myStore'], locales: ['de'], url: 'http://commercetools.com', projectKey: 'keyID', productQueryPredicate: 'masterVariant(attributes(name="Brand" and value="Algolia"))', }, authenticationID: '6c02aeb1-775e-418e-870b-1faccd4b2c0f', }); // 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.createSource( sourceCreate = SourceCreate( type = SourceType.entries.first { it.value == "commercetools" }, name = "sourceName", input = SourceCommercetools( storeKeys = listOf("myStore"), locales = listOf("de"), url = "http://commercetools.com", projectKey = "keyID", productQueryPredicate = "masterVariant(attributes(name=\"Brand\" and value=\"Algolia\"))", ), authenticationID = "6c02aeb1-775e-418e-870b-1faccd4b2c0f", ) ) // 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->createSource( ['type' => 'commercetools', 'name' => 'sourceName', 'input' => ['storeKeys' => [ 'myStore', ], 'locales' => [ 'de', ], 'url' => 'http://commercetools.com', 'projectKey' => 'keyID', 'productQueryPredicate' => 'masterVariant(attributes(name="Brand" and value="Algolia"))', ], 'authenticationID' => '6c02aeb1-775e-418e-870b-1faccd4b2c0f', ], ); // 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.create_source( source_create={ "type": "commercetools", "name": "sourceName", "input": { "storeKeys": [ "myStore", ], "locales": [ "de", ], "url": "http://commercetools.com", "projectKey": "keyID", "productQueryPredicate": 'masterVariant(attributes(name="Brand" and value="Algolia"))', }, "authenticationID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f", }, ) # 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.create_source( Algolia::Ingestion::SourceCreate.new( type: "commercetools", name: "sourceName", input: Algolia::Ingestion::SourceCommercetools.new( store_keys: ["myStore"], locales: ["de"], url: "http://commercetools.com", project_key: "keyID", product_query_predicate: "masterVariant(attributes(name=\"Brand\" and value=\"Algolia\"))" ), authentication_id: "6c02aeb1-775e-418e-870b-1faccd4b2c0f" ) ) # 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.createSource( sourceCreate = SourceCreate( `type` = SourceType.withName("commercetools"), name = "sourceName", input = Some( SourceCommercetools( storeKeys = Some(Seq("myStore")), locales = Some(Seq("de")), url = "http://commercetools.com", projectKey = "keyID", productQueryPredicate = Some("masterVariant(attributes(name=\"Brand\" and value=\"Algolia\"))") ) ), authenticationID = Some("6c02aeb1-775e-418e-870b-1faccd4b2c0f") ) ), 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.createSource(sourceCreate: SourceCreate( type: SourceType.commercetools, name: "sourceName", input: SourceInput.sourceCommercetools(SourceCommercetools( storeKeys: ["myStore"], locales: ["de"], url: "http://commercetools.com", projectKey: "keyID", productQueryPredicate: "masterVariant(attributes(name=\"Brand\" and value=\"Algolia\"))" )), authenticationID: "6c02aeb1-775e-418e-870b-1faccd4b2c0f" )) // print the response print(response) - lang: cURL label: curl source: |- curl --request POST \ --url https://data.us.algolia.com/1/sources \ --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 ' { "type": "algoliaIndex", "name": "lorem", "input": { "storeKeys": [ "lorem" ], "locales": [ "fr-FR" ], "url": "lorem", "projectKey": "lorem", "fallbackIsInStockValue": true, "productQueryPredicate": "lorem", "useImagesObjects": true, "customFields": { "inventory": [ "lorem" ], "price": [ "lorem" ], "category": [ "lorem" ] } }, "authenticationID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f" } ' components: schemas: SourceCreate: type: object additionalProperties: false properties: name: type: string description: Descriptive name of the source. type: $ref: '#/components/schemas/SourceType' authenticationID: $ref: '#/components/schemas/authenticationID' input: $ref: '#/components/schemas/SourceInput' required: - type - name SourceCreateResponse: type: object additionalProperties: false properties: createdAt: $ref: '#/components/schemas/CreatedAt' name: type: string description: Descriptive name of the source. sourceID: $ref: '#/components/schemas/sourceID' required: - sourceID - name - createdAt SourceType: type: string enum: - algoliaIndex - bigcommerce - bigquery - commercetools - csv - docker - ga4BigqueryExport - json - shopify - push authenticationID: type: string description: Universally unique identifier (UUID) of an authentication resource. example: 6c02aeb1-775e-418e-870b-1faccd4b2c0f SourceInput: oneOf: - $ref: '#/components/schemas/SourceCommercetools' - $ref: '#/components/schemas/SourceBigCommerce' - $ref: '#/components/schemas/SourceJSON' - $ref: '#/components/schemas/SourceCSV' - $ref: '#/components/schemas/SourceBigQuery' - $ref: '#/components/schemas/SourceGA4BigQueryExport' - $ref: '#/components/schemas/SourceDocker' - $ref: '#/components/schemas/SourceShopify' - $ref: '#/components/schemas/SourceAlgoliaIndex' 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 ErrorBase: description: Error. type: object x-keep-model: true additionalProperties: true properties: message: type: string example: Invalid Application-Id or API-Key SourceCommercetools: type: object description: Specific configuration attributes of a `commercetools` source. additionalProperties: false properties: projectKey: type: string url: type: string customFields: $ref: '#/components/schemas/CommercetoolsCustomFields' fallbackIsInStockValue: type: boolean default: true description: > Whether a fallback value is stored in the Algolia record if there's no inventory information about the product. locales: type: array description: Locales for your commercetools stores. items: type: string pattern: ^[a-z]{2}(-[A-Z]{2})?$ description: >- Locale specified as combination of a two-letter language code and an optional two-letter country code. example: fr-FR productQueryPredicate: type: string description: > Predicate to filter out specific products when indexing. For more information, see [Query Predicate](https://docs.commercetools.com/api/predicates/query). storeKeys: type: array items: description: Unique and immutable key of the referenced store. type: string useImagesObjects: type: boolean description: > When set to true, the connector indexes objects with all images attributes instead of only the URLs. required: - url - projectKey x-discriminator-fields: - projectKey SourceBigCommerce: type: object description: Specific configuration attributes of a `bigcommerce` source. additionalProperties: false properties: storeHash: type: string description: Store hash identifying your BigCommerce store. channel: $ref: '#/components/schemas/BigCommerceChannel' customFields: type: array items: type: string productMetafields: type: array items: $ref: '#/components/schemas/BigCommerceMetafield' variantMetafields: type: array items: $ref: '#/components/schemas/BigCommerceMetafield' required: - storeHash x-discriminator-fields: - storeHash SourceJSON: type: object description: Specific configuration attributes of a `json` source. additionalProperties: false properties: url: type: string description: URL of the file. method: $ref: '#/components/schemas/MethodType' uniqueIDColumn: $ref: '#/components/schemas/UniqueIDColumn' required: - url SourceCSV: type: object description: Specific configuration attributes of a `csv` source. additionalProperties: false properties: url: type: string description: URL of the file. delimiter: type: string minLength: 1 maxLength: 1 default: ',' description: >- The character used to split the value on each line, default to a comma (\r, \n, 0xFFFD, and space are forbidden). mapping: type: object description: | Key-value pairs of column names and their expected types. x-additionalPropertyName: column name additionalProperties: $ref: '#/components/schemas/MappingTypeCSV' method: $ref: '#/components/schemas/MethodType' uniqueIDColumn: $ref: '#/components/schemas/UniqueIDColumn' required: - url SourceBigQuery: type: object description: Specific configuration attributes of a `bigquery` source. additionalProperties: false properties: datasetID: type: string description: Dataset ID of the BigQuery source. projectID: type: string description: Project ID of the BigQuery source. customSQLRequest: type: string description: Custom SQL request to extract data from the BigQuery table. dataType: $ref: '#/components/schemas/BigQueryDataType' table: type: string description: Table name for the BigQuery export. tablePrefix: type: string description: Table prefix for a Google Analytics 4 data export to BigQuery. uniqueIDColumn: $ref: '#/components/schemas/UniqueIDColumn' required: - projectID - datasetID x-discriminator-fields: - projectID SourceGA4BigQueryExport: type: object description: Specific configuration attributes of a `ga4BigqueryExport` source. additionalProperties: false properties: datasetID: type: string description: BigQuery dataset ID that the BigQuery export writes to. projectID: type: string description: GCP project ID that the BigQuery export writes to. tablePrefix: type: string description: Prefix of the tables that the BigQuery Export writes to. example: events_intraday_ required: - projectID - datasetID - tablePrefix x-discriminator-fields: - projectID - datasetID - tablePrefix SourceDocker: type: object description: Specific configuration attributes of a `docker` source. additionalProperties: false properties: configuration: type: object description: Configuration of the spec. image: type: string description: Name of the connector. example: zendesk required: - image - configuration x-discriminator-fields: - image - configuration SourceShopify: allOf: - $ref: '#/components/schemas/SourceUpdateShopify' - $ref: '#/components/schemas/sourceShopifyBase' SourceAlgoliaIndex: type: object description: Specific configuration attributes of an `algoliaIndex` source. additionalProperties: false properties: indexName: type: string description: Name of the Algolia index to read records from. filters: type: string description: > SQL-like filter expression applied while browsing the source index. See [filters](https://www.algolia.com/doc/api-reference/api-parameters/filters/). required: - indexName x-discriminator-fields: - indexName CommercetoolsCustomFields: type: object additionalProperties: false description: > Custom fields from commercetools to add to the records. For more information, see [Using Custom Types and Custom Fields](https://docs.commercetools.com/tutorials/custom-types). properties: category: oneOf: - type: array description: Category custom fields. items: type: string - type: 'null' inventory: oneOf: - type: array description: Inventory custom fields. items: type: string - type: 'null' price: oneOf: - type: array description: Price custom fields. items: type: string - type: 'null' BigCommerceChannel: type: object additionalProperties: false properties: id: type: integer description: ID of the BigCommerce channel. currencies: type: array description: Currencies for the given channel. example: - usd - eur items: type: string description: Three-letter code for the currency. example: usd required: - id BigCommerceMetafield: type: object additionalProperties: false properties: key: type: string description: Key identifier of the metafield. namespace: type: string description: Namespace of the metafield. required: - namespace - key MethodType: type: string description: HTTP method to be used for retrieving your data. enum: - GET - POST UniqueIDColumn: type: string description: >- Name of a column that contains a unique ID which will be used as `objectID` in Algolia. MappingTypeCSV: type: string enum: - string - integer - float - boolean - json BigQueryDataType: type: string enum: - ga4 - ga360 SourceUpdateShopify: type: object description: Specific configuration attributes of a `shopify` source. additionalProperties: false properties: featureFlags: type: object description: Feature flags for the Shopify source. additionalProperties: true sourceShopifyBase: type: object additionalProperties: false properties: shopURL: type: string description: URL of the Shopify store. required: - shopURL x-discriminator-fields: - shopURL 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. ````