Reference

API Reference

UVAI exposes a small, REST-style surface for transcription, event extraction, pipeline execution, and search. All endpoints accept and return JSON unless noted. Streaming endpoints use Server-Sent Events.

Base URL

https://uvai.io

Want to run it yourself? UVAI is MIT-licensed. See the EventRelay repo for self-hosting.

Endpoints

  • GET
    /api

    Service descriptor (name, version, status).

  • POST
    /api/transcribe

    Fetch a transcript for a YouTube URL.

    { "url": "https://youtu.be/..." }
  • POST
    /api/extract-events

    Extract typed events from a transcript.

  • GET
    /api/pipeline

    Inspect available pipeline stages.

  • POST
    /api/pipeline

    Run the full intake to agents pipeline.

  • POST
    /api/pipeline/stream

    Streaming variant of /api/pipeline (SSE).

  • POST
    /api/chat

    Conversational query over an analyzed video.

  • GET
    /api/video

    List recently analyzed videos.

  • POST
    /api/video

    Register a new video for analysis.

  • GET
    /api/video/search

    Semantic search across stored videos.

  • GET
    /api/dashboard

    Dashboard aggregates and recent runs.

  • POST
    /api/dashboard

    Mutate dashboard state (pin, archive, etc.).

  • GET
    /api/training/status

    Current status of training/embedding jobs.

  • POST
    /api/training/trigger

    Trigger a training/embedding job.

Try it

The playground exercises these endpoints end-to-end against a real YouTube URL.