Installation Guide
Install the VerbalisAI SDK for your preferred programming language.
Python SDK
Requirements
- Python 3.7 or higher
- pip package manager
Install via pip
pip install verbalisai-sdk
Install from source
git clone https://github.com/verbalisai/python-sdk.git
cd python-sdk
pip install -e .
Verify Installation
import verbalisai
print(verbalisai.__version__)
JavaScript SDK
Requirements
- Node.js 14 or higher
- npm or yarn package manager
Install via npm
npm install @verbalisai/sdk
Install via yarn
Install from source
git clone https://github.com/verbalisai/js-sdk.git
cd js-sdk
npm install
npm run build
Verify Installation
const { VerbalisAI } = require('@verbalisai/sdk');
console.log('VerbalisAI SDK loaded successfully');
Environment Setup
API Key Configuration
Set your API key as an environment variable:
export VERBALISAI_API_KEY="your-api-key-here"
Or create a .env
file:
VERBALISAI_API_KEY=your-api-key-here
Configuration File
You can also create a configuration file:
Python - ~/.verbalisai/config.json
:
{
"api_key": "your-api-key-here",
"base_url": "https://api.verbalisai.com/api",
"timeout": 30
}
JavaScript - verbalisai.config.js
:
module.exports = {
apiKey: 'your-api-key-here',
baseUrl: 'https://api.verbalisai.com/api',
timeout: 30000
};
Framework-Specific Setup
Next.js
// pages/api/transcribe.js
import { VerbalisAI } from '@verbalisai/sdk';
const client = new VerbalisAI({
apiKey: process.env.VERBALISAI_API_KEY
});
export default async function handler(req, res) {
const transcription = await client.transcriptions.create(req.body);
res.json(transcription);
}
React
// hooks/useVerbalisAI.js
import { VerbalisAI } from '@verbalisai/sdk';
import { useState, useEffect } from 'react';
export function useVerbalisAI() {
const [client, setClient] = useState(null);
useEffect(() => {
const verbalisClient = new VerbalisAI({
apiKey: process.env.REACT_APP_VERBALISAI_API_KEY
});
setClient(verbalisClient);
}, []);
return client;
}
Django
# settings.py
import os
from verbalisai import VerbalisAI
VERBALISAI_CLIENT = VerbalisAI(
api_key=os.environ.get('VERBALISAI_API_KEY')
)
# views.py
from django.conf import settings
from django.http import JsonResponse
import json
async def transcribe_audio(request):
data = json.loads(request.body)
transcription = await settings.VERBALISAI_CLIENT.transcriptions.create(**data)
return JsonResponse(transcription.to_dict())
Flask
from flask import Flask, request, jsonify
from verbalisai import VerbalisAI
import os
app = Flask(__name__)
client = VerbalisAI(api_key=os.environ.get('VERBALISAI_API_KEY'))
@app.route('/transcribe', methods=['POST'])
async def transcribe():
data = request.get_json()
transcription = await client.transcriptions.create(**data)
return jsonify(transcription.to_dict())
Troubleshooting
Common Issues
Import Error (Python)
# Update pip and reinstall
pip install --upgrade pip
pip uninstall verbalisai-sdk
pip install verbalisai-sdk
Module Not Found (JavaScript)
# Clear npm cache and reinstall
npm cache clean --force
rm -rf node_modules package-lock.json
npm install
Authentication Errors
- Verify your API key is correct
- Check that the API key environment variable is set
- Ensure the API key has proper permissions
Getting Help
If you encounter installation issues:
- Check our GitHub Issues
- Email support: support@verbalisai.com
- Join our Slack community
Version Compatibility
SDK Version | API Version | Python | Node.js |
---|
3.x.x | v1 | 3.7+ | 14+ |
2.x.x | v1 | 3.6+ | 12+ |
1.x.x | v1 | 3.6+ | 10+ |
We recommend always using the latest SDK version for the best experience and latest features.
Responses are generated using AI and may contain mistakes.