# gnani-ai/api-service architecture

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

- Interactive diagram: https://gitdiagram.com/gnani-ai/api-service
- Repository: https://github.com/gnani-ai/api-service

## Overview

This repository is a collection of multilingual client examples for Gnani’s speech-to-text API, not the API service itself. The main workflow is to configure credentials and language, provide supported audio, send it securely to Gnani, and display transcription results. gRPC examples stream audio and receive transcript chunks; REST examples upload audio, poll for processing status, and retrieve a result. The graph groups examples by transport and highlights sampled implementations; some listed client examples and generated protocol code are represented only as directory-level subsystems because their runtime details were not sampled.

Main entry points: [`grpc-codes/Java-Client/src/main/java/GrpcClient.java`](https://github.com/gnani-ai/api-service/blob/master/grpc-codes/Java-Client/src/main/java/GrpcClient.java) (Java client), [`rest-codes/Nodejs-Client/client.js`](https://github.com/gnani-ai/api-service/blob/master/rest-codes/Nodejs-Client/client.js) (Node.js REST client), [`grpc-codes/Python3-Client/client.py`](https://github.com/gnani-ai/api-service/blob/master/grpc-codes/Python3-Client/client.py) (Python client), [`grpc-codes/Cpp-Client/client.cc`](https://github.com/gnani-ai/api-service/blob/master/grpc-codes/Cpp-Client/client.cc) (C++ client)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_grpc["gRPC clients"]
  node_grpc_python["Python client<br/>[client.py]"]
  node_grpc_node["Node.js client<br/>[client.js]"]
  node_grpc_cpp["C++ client<br/>[client.cc]"]
  node_grpc_java["Java client<br/>[GrpcClient.java]"]
  node_grpc_csharp["C&#35; client<br/>[Client.cs]"]
end

subgraph group_rest["REST clients"]
  node_rest_node["Node.js REST client<br/>[client.js]"]
  node_rest_node_config["Node.js settings<br/>[config.js]"]
  node_rest_java["Java REST app<br/>[App.java]"]
  node_rest_java_request["HTTPS requests<br/>[HttpsRequest.java]"]
  node_rest_python["Python REST client<br/>[client.py]"]
end

subgraph group_protocol["gRPC protocol"]
  node_grpc_py_stub["Python gRPC stubs<br/>[stt_pb2_grpc.py]"]
  node_grpc_java_stub["Java gRPC stubs<br/>[ListenerGrpc.java]"]
  node_grpc_java_messages["Java messages<br/>[Stt.java]"]
  node_grpc_cpp_stub["C++ gRPC stubs<br/>[stt.grpc.pb.h]"]
  node_grpc_cpp_messages["C++ messages<br/>[stt.pb.cc]"]
end

node_user(("API user"))
node_audio["Audio input"]
node_gnani_grpc{{"Gnani gRPC API"}}
node_gnani_rest{{"Gnani REST API"}}
node_transcript["Transcript result"]

node_user -->|"provides audio"| node_audio
node_user -->|"runs client"| node_grpc_python
node_user -->|"runs client"| node_grpc_node
node_user -->|"runs client"| node_grpc_cpp
node_user -->|"runs client"| node_grpc_java
node_user -->|"runs client"| node_grpc_csharp
node_user -->|"runs client"| node_rest_node
node_user -->|"runs client"| node_rest_java
node_user -->|"runs client"| node_rest_python
node_grpc_python -->|"calls stub"| node_grpc_py_stub
node_grpc_java -->|"calls stub"| node_grpc_java_stub
node_grpc_java -->|"streams messages"| node_grpc_java_messages
node_grpc_cpp -->|"calls stub"| node_grpc_cpp_stub
node_grpc_cpp_stub -->|"uses messages"| node_grpc_cpp_messages
node_grpc_node -->|"streams audio"| node_gnani_grpc
node_grpc_python -->|"streams audio"| node_gnani_grpc
node_grpc_cpp -->|"streams audio"| node_gnani_grpc
node_grpc_java -->|"streams audio"| node_gnani_grpc
node_grpc_csharp -.->|"streams audio"| node_gnani_grpc
node_gnani_grpc -->|"returns chunks"| node_transcript
node_rest_node -->|"reads settings"| node_rest_node_config
node_rest_node -->|"uploads and polls"| node_gnani_rest
node_rest_java -->|"sends requests"| node_rest_java_request
node_rest_java_request -.->|"uploads audio"| node_gnani_rest
node_rest_python -.->|"sends requests"| node_gnani_rest
node_gnani_rest -->|"returns result"| node_transcript
node_audio -->|"streams input"| node_grpc_node
node_audio -->|"uploads input"| node_rest_node

click node_grpc_python "https://github.com/gnani-ai/api-service/blob/master/grpc-codes/Python3-Client/client.py"
click node_grpc_node "https://github.com/gnani-ai/api-service/blob/master/grpc-codes/Nodejs-Client/client.js"
click node_grpc_cpp "https://github.com/gnani-ai/api-service/blob/master/grpc-codes/Cpp-Client/client.cc"
click node_grpc_java "https://github.com/gnani-ai/api-service/blob/master/grpc-codes/Java-Client/src/main/java/GrpcClient.java"
click node_grpc_csharp "https://github.com/gnani-ai/api-service/blob/master/grpc-codes/C%23-Client/Client.cs"
click node_grpc_py_stub "https://github.com/gnani-ai/api-service/blob/master/grpc-codes/Python3-Client/proto/stt_pb2_grpc.py"
click node_grpc_java_stub "https://github.com/gnani-ai/api-service/blob/master/grpc-codes/Java-Client/src/main/java/SpeechToText/ListenerGrpc.java"
click node_grpc_java_messages "https://github.com/gnani-ai/api-service/blob/master/grpc-codes/Java-Client/src/main/java/SpeechToText/Stt.java"
click node_grpc_cpp_stub "https://github.com/gnani-ai/api-service/blob/master/grpc-codes/Cpp-Client/stt.grpc.pb.h"
click node_grpc_cpp_messages "https://github.com/gnani-ai/api-service/blob/master/grpc-codes/Cpp-Client/stt.pb.cc"
click node_rest_node "https://github.com/gnani-ai/api-service/blob/master/rest-codes/Nodejs-Client/client.js"
click node_rest_node_config "https://github.com/gnani-ai/api-service/blob/master/rest-codes/Nodejs-Client/config/config.js"
click node_rest_java "https://github.com/gnani-ai/api-service/blob/master/rest-codes/Java-Client/rest-app/src/main/java/com/gnani/httpclient/App.java"
click node_rest_java_request "https://github.com/gnani-ai/api-service/blob/master/rest-codes/Java-Client/rest-app/src/main/java/com/gnani/httpclient/HttpsRequest.java"
click node_rest_python "https://github.com/gnani-ai/api-service/blob/master/rest-codes/Python-Client/client.py"

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_grpc_python,node_grpc_node,node_grpc_cpp,node_grpc_java,node_grpc_csharp,node_user toneBlue
class node_rest_node,node_rest_node_config,node_rest_java,node_rest_java_request,node_rest_python toneAmber
class node_grpc_py_stub,node_grpc_java_stub,node_grpc_java_messages,node_grpc_cpp_stub,node_grpc_cpp_messages,node_gnani_grpc,node_gnani_rest toneMint
class node_audio,node_transcript toneIndigo
```

## Components

### gRPC clients

- [Python client](https://github.com/gnani-ai/api-service/blob/master/grpc-codes/Python3-Client/client.py): `grpc-codes/Python3-Client/client.py`
- [Node.js client](https://github.com/gnani-ai/api-service/blob/master/grpc-codes/Nodejs-Client/client.js): `grpc-codes/Nodejs-Client/client.js`
- [C++ client](https://github.com/gnani-ai/api-service/blob/master/grpc-codes/Cpp-Client/client.cc): `grpc-codes/Cpp-Client/client.cc`
- [Java client](https://github.com/gnani-ai/api-service/blob/master/grpc-codes/Java-Client/src/main/java/GrpcClient.java): `grpc-codes/Java-Client/src/main/java/GrpcClient.java`
- [C# client](https://github.com/gnani-ai/api-service/blob/master/grpc-codes/C%23-Client/Client.cs): `grpc-codes/C#-Client/Client.cs`

### REST clients

- [Node.js REST client](https://github.com/gnani-ai/api-service/blob/master/rest-codes/Nodejs-Client/client.js): `rest-codes/Nodejs-Client/client.js`
- [Node.js settings](https://github.com/gnani-ai/api-service/blob/master/rest-codes/Nodejs-Client/config/config.js): `rest-codes/Nodejs-Client/config/config.js`
- [Java REST app](https://github.com/gnani-ai/api-service/blob/master/rest-codes/Java-Client/rest-app/src/main/java/com/gnani/httpclient/App.java): `rest-codes/Java-Client/rest-app/src/main/java/com/gnani/httpclient/App.java`
- [HTTPS requests](https://github.com/gnani-ai/api-service/blob/master/rest-codes/Java-Client/rest-app/src/main/java/com/gnani/httpclient/HttpsRequest.java): `rest-codes/Java-Client/rest-app/src/main/java/com/gnani/httpclient/HttpsRequest.java`
- [Python REST client](https://github.com/gnani-ai/api-service/blob/master/rest-codes/Python-Client/client.py): `rest-codes/Python-Client/client.py`

### gRPC protocol

- [Python gRPC stubs](https://github.com/gnani-ai/api-service/blob/master/grpc-codes/Python3-Client/proto/stt_pb2_grpc.py): `grpc-codes/Python3-Client/proto/stt_pb2_grpc.py`
- [Java gRPC stubs](https://github.com/gnani-ai/api-service/blob/master/grpc-codes/Java-Client/src/main/java/SpeechToText/ListenerGrpc.java): `grpc-codes/Java-Client/src/main/java/SpeechToText/ListenerGrpc.java`
- [Java messages](https://github.com/gnani-ai/api-service/blob/master/grpc-codes/Java-Client/src/main/java/SpeechToText/Stt.java): `grpc-codes/Java-Client/src/main/java/SpeechToText/Stt.java`
- [C++ gRPC stubs](https://github.com/gnani-ai/api-service/blob/master/grpc-codes/Cpp-Client/stt.grpc.pb.h): `grpc-codes/Cpp-Client/stt.grpc.pb.h`
- [C++ messages](https://github.com/gnani-ai/api-service/blob/master/grpc-codes/Cpp-Client/stt.pb.cc): `grpc-codes/Cpp-Client/stt.pb.cc`

### Other components

- **API user**
- **Audio input**
- **Gnani gRPC API**
- **Gnani REST API**
- **Transcript result**

## Connections

- API user → Audio input: provides audio (evidence: `README.md`)
- API user → Python client: runs client (evidence: `README.md`)
- API user → Node.js client: runs client (evidence: `README.md`)
- API user → C++ client: runs client (evidence: `README.md`)
- API user → Java client: runs client (evidence: `README.md`)
- API user → C# client: runs client (evidence: `README.md`)
- API user → Node.js REST client: runs client (evidence: `README.md`)
- API user → Java REST app: runs client (evidence: `README.md`)
- API user → Python REST client: runs client (evidence: `README.md`)
- Python client → Python gRPC stubs: calls stub (evidence: `grpc-codes/Python3-Client/client.py`)
- Java client → Java gRPC stubs: calls stub (evidence: `grpc-codes/Java-Client/src/main/java/GrpcClient.java`)
- Java client → Java messages: streams messages (evidence: `grpc-codes/Java-Client/src/main/java/GrpcClient.java`)
- C++ client → C++ gRPC stubs: calls stub (evidence: `grpc-codes/Cpp-Client/client.cc`)
- C++ gRPC stubs → C++ messages: uses messages (evidence: `grpc-codes/Cpp-Client/stt.grpc.pb.h`)
- Node.js client → Gnani gRPC API: streams audio (evidence: `grpc-codes/Nodejs-Client/client.js`)
- Python client → Gnani gRPC API: streams audio (evidence: `grpc-codes/Python3-Client/client.py`)
- C++ client → Gnani gRPC API: streams audio (evidence: `grpc-codes/Cpp-Client/client.cc`)
- Java client → Gnani gRPC API: streams audio (evidence: `grpc-codes/Java-Client/src/main/java/GrpcClient.java`)
- C# client → Gnani gRPC API: streams audio (evidence: `README.md`)
- Gnani gRPC API → Transcript result: returns chunks (evidence: `README.md`)
- Node.js REST client → Node.js settings: reads settings (evidence: `rest-codes/Nodejs-Client/client.js`)
- Node.js REST client → Gnani REST API: uploads and polls (evidence: `rest-codes/Nodejs-Client/client.js`)
- Java REST app → HTTPS requests: sends requests (evidence: `rest-codes/Java-Client/rest-app/src/main/java/com/gnani/httpclient/App.java`)
- HTTPS requests → Gnani REST API: uploads audio
- Python REST client → Gnani REST API: sends requests
- Gnani REST API → Transcript result: returns result
- Audio input → Node.js client: streams input (evidence: `grpc-codes/Nodejs-Client/client.js`)
- Audio input → Node.js REST client: uploads input (evidence: `rest-codes/Nodejs-Client/client.js`)
