UNPKG

sarvam-mcp

Version:

An MCP server exposing Sarvam AI tools and a documentation retriever.

376 lines (309 loc) 9.19 kB
--- title: Developer Quickstart description: Learn how to make your first API request with Sarvam AI icon: code --- <div style={{ background: "linear-gradient(135deg, rgba(0, 98, 255, 0.03) 0%, rgba(218, 98, 196, 0.03) 100%)", padding: "3rem", borderRadius: "16px", marginBottom: "3rem", border: "1px solid rgba(0, 98, 255, 0.08)", boxShadow: "0 4px 6px rgba(0, 0, 0, 0.1)", }} > <h1 style={{ fontSize: "2.75rem", marginBottom: "0rem", display: "flex", alignItems: "center", gap: "1.75rem", fontWeight: "500", lineHeight: "1", letterSpacing: "-0.02em", }} > Start Building In 5 Minutes.🚀 </h1> </div> <Steps> <Step title="Create an API Key" icon="key"> Visit the [Sarvam AI dashboard](https://dashboard.sarvam.ai) and create a new API key. Keep this key secure - you'll need it to authenticate your requests. </Step> <Step title="Set Up Your Environment" icon="gear"> Export your API key as an environment variable: <CodeGroup> <CodeBlock title="macOS / Linux" active> ```bash export SARVAM_API_KEY="your_api_key_here" ``` </CodeBlock> <CodeBlock title="Windows"> ```powershell $env:SARVAM_API_KEY="your_api_key_here" ``` </CodeBlock> </CodeGroup> </Step> <Step title="Install the SDK" icon="download"> Choose your preferred language and install our SDK: <CodeGroup> <CodeBlock title="Python" active> ```bash pip install sarvamai ``` </CodeBlock> <CodeBlock title="JavaScript"> ```bash npm install sarvamai ``` </CodeBlock> </CodeGroup> </Step> <Step title="Make Your First API Call" icon="rocket"> <CodeGroup> <CodeBlock title="Python" active> ```python from sarvamai import SarvamAI client = SarvamAI( api_subscription_key="YOUR_API_KEY", ) response = client.text.translate( input="Hi, My Name is Vinayak.", source_language_code="auto", target_language_code="gu-IN", speaker_gender="Male" ) print(response) ``` </CodeBlock> <CodeBlock title="JavaScript"> ```javascript import { SarvamAIClient } from "sarvamai"; const client = new SarvamAIClient({ apiSubscriptionKey: "YOUR_API_KEY" }); const response = await client.text.translate({ input: "Hi, My Name is Vinayak.", sourceLanguageCode: "auto", targetLanguageCode: "gu-IN", speakerGender: "Male" }); console.log(response); ``` </CodeBlock> <CodeBlock title="curl"> ```bash curl -X POST https://api.sarvam.ai/translate \ -H "api-subscription-key: <apiSubscriptionKey>" \ -H "Content-Type: application/json" \ -d '{ "input": "input", "source_language_code": "auto", "target_language_code": "gu-IN" }' ``` </CodeBlock> </CodeGroup> </Step> </Steps> <Note> **Quick Tips:** - Store your API key securely and never commit it to version control - Use environment variables or a secure configuration manager </Note> ## Sarvam AI APIs <Tabs> <Tab title="Speech to Text"> <Tabs> <Tab title="Python"> ```python from sarvamai import SarvamAI client = SarvamAI( api_subscription_key="YOUR_SARVAM_API_KEY", ) response = client.speech_to_text.transcribe( file=open("audio.wav", "rb"), model="saarika:v2", language_code="gu-IN" ) print(response) ``` </Tab> <Tab title="JavaScript"> ```javascript import { SarvamAIClient } from "sarvamai"; const fs = require('fs'); const client = new SarvamAIClient({ apiSubscriptionKey: "YOUR_SARVAM_API_KEY" }); const audioFile = fs.readFileSync('audio.wav'); const response = await client.speechToText.transcribe({ file: audioFile, model: "saarika:v2", languageCode: "gu-IN" }); console.log(response); ``` </Tab> <Tab title="curl"> ```bash curl -X POST https://api.sarvam.ai/speech-to-text \ -H "api-subscription-key: <YOUR_API_SUBSCRIPTION_KEY>" \ -H "Content-Type: multipart/form-data" \ -F model="saarika:v2" \ -F language_code="en-IN" \ -F file=@"file.wav;type=audio/wav" ``` </Tab> </Tabs> </Tab> <Tab title="Speech To Text Translate"> <Tabs> <Tab title="Python"> ```python from sarvamai import SarvamAI client = SarvamAI( api_subscription_key="YOUR_SARVAM_API_KEY", ) response = client.speech_to_text.translate( file=open("audio.wav", "rb"), model="saaras:v2" ) print(response) ``` </Tab> <Tab title="JavaScript"> ```javascript import { SarvamAIClient } from "sarvamai"; const fs = require('fs'); const client = new SarvamAIClient({ apiSubscriptionKey: "YOUR_SARVAM_API_KEY" }); const audioFile = fs.readFileSync('audio.wav'); const response = await client.speechToText.translate({ file: audioFile, model: "saaras:v2" }); console.log(response); ``` </Tab> <Tab title="curl"> ```bash curl -X POST https://api.sarvam.ai/speech-to-text-translate \ -H "api-subscription-key: <apiSubscriptionKey>" \ -H "Content-Type: multipart/form-data" \ -F file=@<file1> ``` </Tab> </Tabs> </Tab> <Tab title="Text to Speech"> <Tabs> <Tab title="Python"> ```python from sarvamai import SarvamAI client = SarvamAI( api_subscription_key="YOUR_SARVAM_API_KEY", ) response = client.text_to_speech.convert( text="Hello, how are you?", target_language_code="hi-IN", ) print(response) ``` </Tab> <Tab title="JavaScript"> ```javascript import { SarvamAIClient } from "sarvamai"; const client = new SarvamAIClient({ apiSubscriptionKey: "YOUR_SARVAM_API_KEY" }); const response = await client.textToSpeech.convert({ text: "Hello, how are you?", targetLanguageCode: "hi-IN", }); console.log(response); ``` </Tab> <Tab title="curl"> ```bash curl -X POST https://api.sarvam.ai/text-to-speech \ -H "api-subscription-key: <YOUR_API_SUBSCRIPTION_KEY>" \ -H "Content-Type: application/json" \ -d '{ "text": "Welcome to Sarvam AI!" , "target_language_code": "bn-IN", "speaker": "anushka" }' ``` </Tab> </Tabs> </Tab> <Tab title="Text Translation"> <Tabs> <Tab title="Python"> ```python from sarvamai import SarvamAI client = SarvamAI( api_subscription_key="YOUR_SARVAM_API_KEY", ) response = client.text.translate( input="Hello, how are you?", source_language_code="auto", target_language_code="hi-IN", speaker_gender="Male" ) print(response) ``` </Tab> <Tab title="JavaScript"> ```javascript import { SarvamAIClient } from "sarvamai"; const client = new SarvamAIClient({ apiSubscriptionKey: "YOUR_SARVAM_API_KEY" }); const response = await client.text.translate({ input: "Hello, how are you?", sourceLanguageCode: "auto", targetLanguageCode: "hi-IN", speakerGender: "Male" }); console.log(response); ``` </Tab> <Tab title="curl"> ```bash curl -X POST https://api.sarvam.ai/translate \ -H "api-subscription-key: <apiSubscriptionKey>" \ -H "Content-Type: application/json" \ -d '{ "input": "input", "source_language_code": "auto", "target_language_code": "en-IN" }' ``` </Tab> </Tabs> </Tab> </Tabs> ## Next Steps <Steps> <Step title="Explore Documentation" icon="book"> Check out our detailed [API Reference](/api-reference-docs/speech-to-text) for all available endpoints and options. </Step> {" "} <Step title="View Examples" icon="code"> Browse our [Cookbook](/api-reference-docs/cookbook/starter-notebooks/) for some inspiration </Step> <Step title="Get Support" icon="life-ring"> Join our [Discord community](https://discord.gg/5rAsykttcs) or [contact support](mailto:developer@sarvam.ai?subject=API%20Support%20Request&body=Hi%20Sarvam%20Team%2C%0A%0AI%20need%20some%20help%20with%20your%20APIs.%20Here%20are%20the%20details%3A%0A%0A-%20API%20Name%20or%20Endpoint%3A%20%0A-%20Issue%20or%20Question%3A%20%0A-%20Any%20Error%20Message%20or%20Code%20(if%20applicable)%3A%20%0A-%20Additional%20Details%3A%20%0A%0AThanks%2C%0A%5BYour%20Name%5D) for help. </Step> </Steps>