Developer Documentation
BuildWithVSpeakX1.0

Comprehensive APIs and SDKs to integrate lip-reading and gesture recognition into your applications.

Get Started in 3 Steps

From signup to first API call in less than 5 minutes.

1

Get API Key

Sign up and generate your API key from the dashboard in under 60 seconds.

VS_KEY_abc123xyz789
2

Install SDK

Add our SDK to your project with your preferred package manager.

npm install VSpeakX 1.0
3

Start Inference

Call our APIs with just a few lines of code.

const result = await vs.lipRead(videoFrame);
Developer workspace

API Reference

Our REST and WebSocket APIs deliver real-time AI inference at scale.

API architecture

Lip Reading

Analyze lip movements and generate transcriptions from video input.

POST
/api/v1/lip-read

Parameters:

video_streamlanguageconfidence_threshold

Gesture Recognition

Detect and classify hand/body gestures from video or depth data.

POST
/api/v1/gestures

Parameters:

video_streamgesture_setreturn_coordinates

Real-time Stream

Continuous gesture and lip-reading detection from live video streams.

WebSocket
/api/v1/stream

Parameters:

video_streammodelsinference_speed

Code Examples

Ready-to-use examples in your favorite languages.

Python
import VSpeakX 1.0 as vs

client = vs.Client(api_key="VS_KEY_...")

# Lip-reading from video
with open("video.mp4", "rb") as f:
    result = client.lip_read(
        video=f,
        language="en",
        confidence=0.85
    )
    print(result.transcription)

# Gesture recognition
gestures = client.recognize_gestures(
    video=f,
    gesture_set="hand_commands"
)
for gesture in gestures:
    print(f"{gesture.name} - {gesture.confidence}")
JavaScript
import VSpeakX 1.0 from 'VSpeakX 1.0';

const client = new VSpeakX 1.0({
  apiKey: process.env.VS_API_KEY
});

// Real-time gesture detection
const stream = await client.createStream();
stream.on('gesture', (gesture) => {
  console.log(
    `Detected: ${gesture.name} (${gesture.confidence})`
  );
});

// Start video stream
const video = document.getElementById('video');
stream.setInput(video);
cURL
curl -X POST https://api.VSpeakX 1.0.com/v1/lip-read \
  -H "Authorization: Bearer VS_KEY_..." \
  -H "Content-Type: application/octet-stream" \
  --data-binary @video.mp4

# Response
{
  "transcription": "Hello, this is a test",
  "confidence": 0.97,
  "language": "en",
  "duration_ms": 2450,
  "tokens": 6
}

Developer Resources

Everything you need to build and deploy with VSpeakX 1.0.

Official SDKs

Download our official SDKs with built-in support for NVIDIA acceleration.

Python

v1.2.0

50K+ weekly downloads

Coming soon

JavaScript/TypeScript

v1.2.0

35K+ weekly downloads

Coming soon

Go

v1.1.5

12K+ weekly downloads

Coming soon

C++

v1.0.8

8K+ weekly downloads

Coming soon

Java

v1.1.2

6K+ weekly downloads

Coming soon

Rust

v0.9.5

3K+ weekly downloads

Coming soon

Need Help?

Our developer community and support team are here to help you succeed.