# algolia/api-clients-automation architecture

> Architecture diagram of the GitHub repository algolia/api-clients-automation, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/algolia/api-clients-automation
- Repository: https://github.com/algolia/api-clients-automation

## Overview

This repository provides generated Algolia API clients in multiple languages, with API operations translated into HTTP requests and responses. A typical user calls a language-specific client method; the client builds and sends a request to Algolia and returns decoded data or HTTP metadata. The tree also shows search, analytics, recommendations, ingestion, and other service clients. Evidence is strongest for ingestion and Query Suggestions; several transport modules are identified by the source index but not excerpted, so their internal wiring is not expanded.

Main entry points: [`clients/algoliasearch-client-csharp/algoliasearch/Clients/IngestionClient.cs`](https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-csharp/algoliasearch/Clients/IngestionClient.cs) (C# ingestion), [`clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/api/IngestionClient.kt`](https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/api/IngestionClient.kt) (Kotlin ingestion), [`clients/algoliasearch-client-swift/Sources/Ingestion/IngestionClient.swift`](https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-swift/Sources/Ingestion/IngestionClient.swift) (Swift ingestion), [`clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/ApiClient.java`](https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/ApiClient.java) (Java API client)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_operations["API operations"]
  node_csharp_ingestion["C&#35; ingestion<br/>[IngestionClient.cs]"]
  node_csharp_services["C&#35; service clients"]
  node_chunked_push["Chunked push"]
  node_javascript_ingestion["JavaScript ingestion<br/>[ingestionClient.ts]"]
  node_java_ingestion["Java ingestion"]
  node_kotlin_ingestion["Kotlin ingestion<br/>[IngestionClient.kt]"]
  node_swift_ingestion["Swift ingestion"]
  node_swift_suggestions["Swift suggestions"]
  node_js_suggestions["JS suggestions"]
  node_php_suggestions["PHP suggestions"]
  node_php_ingestion["PHP ingestion"]
  node_scala_ingestion["Scala ingestion"]
end

subgraph group_transport["HTTP transport"]
  node_java_api_client["Java API client<br/>[ApiClient.java]"]
  node_java_requester["Java HTTP requester<br/>[HttpRequester.java]"]
  node_swift_transporter["Swift transporter<br/>[Transporter.swift]"]
end

subgraph group_shared["Shared request types"]
  node_csharp_options["C&#35; request options<br/>[RequestOptions.cs]"]
  node_kotlin_request_config["Kotlin request config<br/>[RequestConfig.kt]"]
  node_kotlin_method["Kotlin request method<br/>[RequestMethod.kt]"]
  node_swift_options["Swift request options"]
  node_query_loglevel["Query log level<br/>[LogLevel.cs]"]
end

subgraph group_swift["Swift client runtime"]
  node_swift_helper["Swift API helper<br/>[APIHelper.swift]"]
  node_swift_region["Swift regions<br/>[Region.swift]"]
  node_swift_config["Suggestions config"]
  node_swift_useragent["Swift user agent<br/>[UserAgent.swift]"]
end

node_developer(("Client user"))
node_algolia_api{{"Algolia API"}}

node_developer -->|"calls"| node_csharp_ingestion
node_developer -->|"calls"| node_javascript_ingestion
node_developer -->|"calls"| node_java_ingestion
node_developer -->|"calls"| node_swift_ingestion
node_developer -->|"calls"| node_swift_suggestions
node_developer -->|"calls"| node_js_suggestions
node_developer -->|"calls"| node_php_ingestion
node_developer -->|"calls"| node_php_suggestions
node_developer -->|"calls"| node_kotlin_ingestion
node_developer -->|"calls"| node_scala_ingestion
node_developer -.->|"uses"| node_developer
node_csharp_ingestion -.->|"sends requests"| node_algolia_api
node_javascript_ingestion -.->|"sends requests"| node_algolia_api
node_java_ingestion -->|"executes via"| node_java_api_client
node_java_api_client -.->|"delegates to"| node_java_requester
node_java_api_client -.->|"sends requests"| node_algolia_api
node_kotlin_ingestion -->|"builds config"| node_kotlin_request_config
node_kotlin_ingestion -.->|"sends requests"| node_algolia_api
node_swift_ingestion -->|"sends through"| node_swift_transporter
node_swift_ingestion -->|"sets options"| node_swift_options
node_swift_transporter -.->|"sends requests"| node_algolia_api
node_swift_suggestions -->|"sends through"| node_swift_transporter
node_swift_config -->|"selects region"| node_swift_region
node_swift_config -->|"registers agent"| node_swift_useragent
node_chunked_push -->|"calls push"| node_csharp_ingestion
node_csharp_ingestion -->|"accepts options"| node_csharp_options

click node_csharp_ingestion "https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-csharp/algoliasearch/Clients/IngestionClient.cs"
click node_csharp_services "https://github.com/algolia/api-clients-automation/tree/main/clients/algoliasearch-client-csharp/algoliasearch/Clients"
click node_chunked_push "https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-csharp/algoliasearch/Utils/IngestionClientExtensions.cs"
click node_javascript_ingestion "https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-javascript/packages/ingestion/src/ingestionClient.ts"
click node_java_ingestion "https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/api/IngestionClient.java"
click node_kotlin_ingestion "https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/api/IngestionClient.kt"
click node_swift_ingestion "https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-swift/Sources/Ingestion/IngestionClient.swift"
click node_swift_suggestions "https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-swift/Sources/QuerySuggestions/QuerySuggestionsClient.swift"
click node_js_suggestions "https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-javascript/packages/client-query-suggestions/src/querySuggestionsClient.ts"
click node_php_suggestions "https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-php/lib/Api/QuerySuggestionsClient.php"
click node_php_ingestion "https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-php/lib/Api/IngestionClient.php"
click node_scala_ingestion "https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/api/IngestionClient.scala"
click node_csharp_options "https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-csharp/algoliasearch/Http/RequestOptions.cs"
click node_java_api_client "https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/ApiClient.java"
click node_java_requester "https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/internal/HttpRequester.java"
click node_kotlin_request_config "https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/transport/RequestConfig.kt"
click node_kotlin_method "https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/transport/RequestMethod.kt"
click node_swift_transporter "https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-swift/Sources/Core/Networking/Transporter.swift"
click node_swift_options "https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-swift/Sources/Core/Common/RequestOptions.swift"
click node_swift_helper "https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-swift/Sources/Core/Helpers/APIHelper.swift"
click node_swift_region "https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-swift/Sources/Core/Common/Region.swift"
click node_swift_config "https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-swift/Sources/QuerySuggestions/QuerySuggestionsClientConfiguration.swift"
click node_query_loglevel "https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-csharp/algoliasearch/Models/QuerySuggestions/LogLevel.cs"
click node_swift_useragent "https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-swift/Sources/Core/Networking/UserAgent/UserAgent.swift"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_csharp_ingestion,node_csharp_services,node_chunked_push,node_javascript_ingestion,node_java_ingestion,node_kotlin_ingestion,node_swift_ingestion,node_swift_suggestions,node_js_suggestions,node_php_suggestions,node_php_ingestion,node_scala_ingestion,node_developer toneBlue
class node_java_api_client,node_java_requester,node_swift_transporter toneAmber
class node_csharp_options,node_kotlin_request_config,node_kotlin_method,node_swift_options,node_query_loglevel,node_algolia_api toneMint
class node_swift_helper,node_swift_region,node_swift_config,node_swift_useragent toneRose
```

## Components

### API operations

- [C# ingestion](https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-csharp/algoliasearch/Clients/IngestionClient.cs): `clients/algoliasearch-client-csharp/algoliasearch/Clients/IngestionClient.cs`
- [C# service clients](https://github.com/algolia/api-clients-automation/tree/main/clients/algoliasearch-client-csharp/algoliasearch/Clients): `clients/algoliasearch-client-csharp/algoliasearch/Clients`
- [Chunked push](https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-csharp/algoliasearch/Utils/IngestionClientExtensions.cs): `clients/algoliasearch-client-csharp/algoliasearch/Utils/IngestionClientExtensions.cs`
- [JavaScript ingestion](https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-javascript/packages/ingestion/src/ingestionClient.ts): `clients/algoliasearch-client-javascript/packages/ingestion/src/ingestionClient.ts`
- [Java ingestion](https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/api/IngestionClient.java): `clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/api/IngestionClient.java`
- [Kotlin ingestion](https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/api/IngestionClient.kt): `clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/api/IngestionClient.kt`
- [Swift ingestion](https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-swift/Sources/Ingestion/IngestionClient.swift): `clients/algoliasearch-client-swift/Sources/Ingestion/IngestionClient.swift`
- [Swift suggestions](https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-swift/Sources/QuerySuggestions/QuerySuggestionsClient.swift): `clients/algoliasearch-client-swift/Sources/QuerySuggestions/QuerySuggestionsClient.swift`
- [JS suggestions](https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-javascript/packages/client-query-suggestions/src/querySuggestionsClient.ts): `clients/algoliasearch-client-javascript/packages/client-query-suggestions/src/querySuggestionsClient.ts`
- [PHP suggestions](https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-php/lib/Api/QuerySuggestionsClient.php): `clients/algoliasearch-client-php/lib/Api/QuerySuggestionsClient.php`
- [PHP ingestion](https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-php/lib/Api/IngestionClient.php): `clients/algoliasearch-client-php/lib/Api/IngestionClient.php`
- [Scala ingestion](https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/api/IngestionClient.scala): `clients/algoliasearch-client-scala/src/main/scala/algoliasearch/api/IngestionClient.scala`

### HTTP transport

- [Java API client](https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/ApiClient.java): `clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/ApiClient.java`
- [Java HTTP requester](https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/internal/HttpRequester.java): `clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/internal/HttpRequester.java`
- [Swift transporter](https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-swift/Sources/Core/Networking/Transporter.swift): `clients/algoliasearch-client-swift/Sources/Core/Networking/Transporter.swift`

### Shared request types

- [C# request options](https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-csharp/algoliasearch/Http/RequestOptions.cs): `clients/algoliasearch-client-csharp/algoliasearch/Http/RequestOptions.cs`
- [Kotlin request config](https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/transport/RequestConfig.kt): `clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/transport/RequestConfig.kt`
- [Kotlin request method](https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/transport/RequestMethod.kt): `clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/transport/RequestMethod.kt`
- [Swift request options](https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-swift/Sources/Core/Common/RequestOptions.swift): `clients/algoliasearch-client-swift/Sources/Core/Common/RequestOptions.swift`
- [Query log level](https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-csharp/algoliasearch/Models/QuerySuggestions/LogLevel.cs): `clients/algoliasearch-client-csharp/algoliasearch/Models/QuerySuggestions/LogLevel.cs`

### Swift client runtime

- [Swift API helper](https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-swift/Sources/Core/Helpers/APIHelper.swift): `clients/algoliasearch-client-swift/Sources/Core/Helpers/APIHelper.swift`
- [Swift regions](https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-swift/Sources/Core/Common/Region.swift): `clients/algoliasearch-client-swift/Sources/Core/Common/Region.swift`
- [Suggestions config](https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-swift/Sources/QuerySuggestions/QuerySuggestionsClientConfiguration.swift): `clients/algoliasearch-client-swift/Sources/QuerySuggestions/QuerySuggestionsClientConfiguration.swift`
- [Swift user agent](https://github.com/algolia/api-clients-automation/blob/main/clients/algoliasearch-client-swift/Sources/Core/Networking/UserAgent/UserAgent.swift): `clients/algoliasearch-client-swift/Sources/Core/Networking/UserAgent/UserAgent.swift`

### Other components

- **Client user**
- **Algolia API**

## Connections

- Client user → C# ingestion: calls (evidence: `clients/algoliasearch-client-csharp/algoliasearch/Clients/IngestionClient.cs`)
- Client user → JavaScript ingestion: calls (evidence: `clients/algoliasearch-client-javascript/packages/ingestion/src/ingestionClient.ts`)
- Client user → Java ingestion: calls (evidence: `clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/api/IngestionClient.java`)
- Client user → Swift ingestion: calls (evidence: `clients/algoliasearch-client-swift/Sources/Ingestion/IngestionClient.swift`)
- Client user → Swift suggestions: calls (evidence: `clients/algoliasearch-client-swift/Sources/QuerySuggestions/QuerySuggestionsClient.swift`)
- Client user → JS suggestions: calls (evidence: `clients/algoliasearch-client-javascript/packages/client-query-suggestions/src/querySuggestionsClient.ts`)
- Client user → PHP ingestion: calls (evidence: `clients/algoliasearch-client-php/lib/Api/IngestionClient.php`)
- Client user → PHP suggestions: calls (evidence: `clients/algoliasearch-client-php/lib/Api/QuerySuggestionsClient.php`)
- Client user → Kotlin ingestion: calls (evidence: `clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/api/IngestionClient.kt`)
- Client user → Scala ingestion: calls (evidence: `clients/algoliasearch-client-scala/src/main/scala/algoliasearch/api/IngestionClient.scala`)
- Client user → Client user: uses
- C# ingestion → Algolia API: sends requests
- JavaScript ingestion → Algolia API: sends requests
- Java ingestion → Java API client: executes via (evidence: `clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/api/IngestionClient.java`)
- Java API client → Java HTTP requester: delegates to (evidence: `clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/ApiClient.java`)
- Java API client → Algolia API: sends requests
- Kotlin ingestion → Kotlin request config: builds config (evidence: `clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/api/IngestionClient.kt`)
- Kotlin ingestion → Algolia API: sends requests
- Swift ingestion → Swift transporter: sends through (evidence: `clients/algoliasearch-client-swift/Sources/Ingestion/IngestionClient.swift`)
- Swift ingestion → Swift request options: sets options (evidence: `clients/algoliasearch-client-swift/Sources/Ingestion/IngestionClient.swift`)
- Swift transporter → Algolia API: sends requests
- Swift suggestions → Swift transporter: sends through (evidence: `clients/algoliasearch-client-swift/Sources/QuerySuggestions/QuerySuggestionsClient.swift`)
- Suggestions config → Swift regions: selects region (evidence: `clients/algoliasearch-client-swift/Sources/QuerySuggestions/QuerySuggestionsClientConfiguration.swift`)
- Suggestions config → Swift user agent: registers agent (evidence: `clients/algoliasearch-client-swift/Sources/QuerySuggestions/QuerySuggestionsClientConfiguration.swift`)
- Chunked push → C# ingestion: calls push (evidence: `clients/algoliasearch-client-csharp/algoliasearch/Utils/IngestionClientExtensions.cs`)
- C# ingestion → C# request options: accepts options (evidence: `clients/algoliasearch-client-csharp/algoliasearch/Clients/IngestionClient.cs`)
