Quick Start

Quick Start

Install

npm install overshoot

Get an API Key

Get your API key at platform.overshoot.ai/api-keys (opens in a new tab).

Basic Usage

import { RealtimeVision } from 'overshoot'
 
const vision = new RealtimeVision({
  apiKey: 'your-api-key',
  model: 'Qwen/Qwen3.5-9B',
  prompt: 'Read any visible text',
  source: { type: 'camera', cameraFacing: 'environment' },
  onResult: (result) => {
    console.log(result.result)
  }
})
 
await vision.start()   // starts the camera and begins processing
await vision.stop()    // stops everything

Using a Video File

const vision = new RealtimeVision({
  apiKey: 'your-api-key',
  model: 'Qwen/Qwen3.5-9B',
  prompt: 'Describe what you see',
  source: { type: 'video', file: videoFile },
  onResult: (result) => {
    console.log(result.result)
  }
})
 
await vision.start()

Results arrive continuously as the video plays.

Next Steps

IntroductionOverview