Skip to content

Quickstart

import { Steps } from ‘@astrojs/starlight/components’;

  1. Configure the CLI

    Set your API endpoint and authentication token. Get your token from the Veronese dashboard.

    Terminal window
    # Set the API URL
    veronese config set-url https://veronesebook.com
    # Set your API token
    veronese config set-token YOUR_API_TOKEN
    # Verify your configuration and account status
    veronese config show
    veronese status
  2. Create a series

    Organize your transcriptions into series — a series is a collection of related episodes (e.g. a podcast, a project, a notebook).

    Terminal window
    # Create a new series
    veronese series create --title "My Podcast"
    # List all your series (note the ID for the next step)
    veronese series list
  3. Add an episode

    Create an episode from any audio or video URL. YouTube, direct audio links, and more are supported.

    Terminal window
    # From a YouTube video
    veronese episode create --series <series-id> --url https://youtube.com/watch?v=dQw4w9WgXcQ
    # From any audio URL
    veronese episode create --series <series-id> --url https://example.com/podcast.mp3
  4. Wait for processing

    Transcription happens in the cloud. Poll the episode until it completes.

    Terminal window
    # Poll until ready (default 5-minute timeout)
    veronese episode poll <episode-id>
    # Set a custom timeout (seconds)
    veronese episode poll <episode-id> --max-wait 600

    Output:

    Polling episode 42...
    ingesting ✓
    transcribing ✓
    ready ✓ (1m 42s)
  5. Export your transcript

    Download the completed transcript in your preferred format.

    Terminal window
    # Export as Markdown
    veronese episode export <episode-id> --format md --out transcript.md
    # View episode details as JSON
    veronese episode show <episode-id> --json

Full command reference →