{"name":"VetFlash API v3 — Realtime Scribe","description":"Open one WebSocket, stream microphone audio, receive live transcription, then a structured clinical note shaped by your typed prompt.","model":"vetflash-scribe","auth":{"login":{"method":"POST","path":"/v3/auth/session","body":{"email":"string","password":"string"}},"realtime":"Pass the returned sessionToken to the WS as ?sessionToken=... or Authorization: Bearer <token>."},"realtime":{"endpoint":"/v3/scribe/stream","transport":"websocket","query":{"sessionToken":"required","language":"optional, default en-GB"},"clientFrames":{"start":{"type":"start","prompt":"<template text>","language?":"en-GB","mimetype?":"audio/webm"},"audio":"binary — raw Opus/WebM or linear16 PCM, forwarded to the speech engine as-is","stop":{"type":"stop"},"cancel":{"type":"cancel"}},"serverFrames":{"ready":{"type":"ready","sessionId":"…","model":"vetflash-scribe","scribeCredits":0},"transcript":{"type":"transcript","text":"…","isFinal":true},"noteDelta":{"type":"note","delta":"…","done":false},"noteFinal":{"type":"note","text":"…","transcript":"…","done":true,"creditsCharged":0,"scribeCreditsRemaining":0},"error":{"type":"error","code":"…","message":"…"}}},"credits":{"model":"1 credit = 20 minutes of audio","cost":"ceil(seconds / 60 / 20), minimum 1","maxSessionSeconds":2700},"limits":{"maxPromptChars":8000,"maxAudioBytes":209715200}}