Sarvam One Documentation

Overview

Sarvam One is an OutSystems Forge component that provides integration with Sarvam AI services, including:

• Text To Speech (TTS)
• Speech To Text (STT)
• Chat Completion
• Document Intelligence

The component abstracts the Sarvam REST APIs and exposes simple OutSystems actions and structures for rapid development.

Prerequisites

Before using this component:

1. Create a Sarvam AI account.
2. Generate an API Subscription Key.
3. Ensure your OutSystems environment has internet access to call external APIs.

Installation

1. Install the Sarvam One Forge component from Forge.
2. Publish the application.
3. Add a dependency to the required actions and structures.

Configuration

API Key

Obtain your API key from Sarvam AI.

Example:

sk_xxxxxxxxxxxxxxxxxxxxx

Store the key securely using:

• Site Property (Recommended)
• Environment Configuration
• Secret Management Solution

Avoid hardcoding API keys in application logic.

Text To Speech (TTS)

Convert text into speech.

Action

TextToSpeech

Input

Example:

Model = bulbul:v3
Text = नमस्ते, आज मैं आपकी क्या मदद कर सकता हूँ?
TargetLanguageCode = hi-IN
Speaker = shubh

Output

The Audio field contains Base64 encoded audio.

Convert to Binary

BinaryDataFromBase64(Audio)

Speech To Text (STT)

Convert audio into text.

Action

SpeechToText

Input

Example:

Model = saaras:v3
Mode = transcribe

Output

Chat Completion

Generate AI responses.

Action

ChatCompletion

Input

ChatRequest

ChatMessage

Example:

Role = user
Content = What is the capital of India?

Output

ChatResponse

Document Intelligence

Digitize and process documents using Sarvam Vision.

Supported formats:

• PDF
• PNG
• JPG
• JPEG
• ZIP

Maximum 10 pages per document.

CreateDocumentJob

Creates a new document processing job.

Input

Example:

Language = hi-IN
OutputFormat = md

Output

GetDocumentJobStatus

Retrieves the current status of a document job.

Input

JobId

Output

Possible states:

Accepted
Pending
Running
Completed
PartiallyCompleted
Failed

WaitForDocumentCompletion

Waits until the processing job completes.

Input

Output

DocumentJobStatus

DownloadDocumentOutput

Downloads the generated output file.

Input

JobId

Output

Binary Data

Best Practices

• Store API keys securely.
• Use Site Properties for configuration.
• Validate file formats before upload.
• Handle API errors gracefully.
• Use timeout and retry logic for long-running document jobs.
• Monitor token usage for chat requests.

Support

For Sarvam AI service issues, refer to the official Sarvam AI documentation.

For Forge component issues, use the Forge support channel or project repository.