OpenViSTAI · Agents · Blockchain · Crypto
Submit a project
Menu
Infrastructure

Odysee API

Odysee API is a Go backend service used by Odysee to bridge its web application and the LBRY blockchain. Its public repository includes local development instructions using Docker Compose, SDK and PostgreSQL containers, plus a separately launched frontend.

Explore the practical guide ↓

Independent OpenViST project profile, based on linked sources.

Odysee API — OpenViST project profile in Infrastructure.
OpenViST project illustration. See the linked sources for product details.
Understand the project

Practical overview

When it fits

Use the repository when developing or maintaining Odysee’s API backend, or when setting up the documented local environment that connects a separate web UI to the API.

Who it is for

  • Developers working on Odysee’s backend or web-to-blockchain connection.
  • Contributors who want to run or modify the API in a local development environment.
  • Developers investigating a Go API service with documented SDK and PostgreSQL container setup.

Documented uses

  • Run the Odysee API alongside its documented supporting containers.
  • Connect a separately launched Odysee frontend to a local API instance.
  • Modify database schemas, apply migrations and regenerate sqlboiler models.
  • Prepare the documented container-based environment for tests.
Before you choose

Requirements & limits

The source repository is public and states that the project is MIT licensed.

  • The repository contains backend API code, not the Odysee UI; UI code is maintained separately.
  • The documented development paths require supporting containers, and the Docker path specifically launches SDK and PostgreSQL images.
  • The README flags possible port conflicts with a running LBRY desktop app or lbrynet instance.
  • The README documents Go 1.26 for building Docker images; this is a build instruction, not a general runtime requirement.

Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.

Source-based practical guide

Set up Odysee API from source

Launch the API and connect a separately launched Odysee frontend in a local development environment.

Before you start

  • Go and Docker Compose, as required by the repository setup.
  • Install sqlboiler and the sqlboiler PostgreSQL driver with the Go install commands in the README.
  • The odysee-frontend repository for the UI stage.

Steps

  1. Start the core environment containers with the command below.

    Documented command
    docker compose up -d

  2. On the first launch, set up the database schema with the command below.

    Documented command
    go run . db_migrate_up

  3. Generate the RSA key file with ssh-keygen -t rsa -f token_privkey.rsa -m pem.

  4. Start the API with the command below, then launch the frontend using SDK_API_URL=http://localhost:8080 yarn dev:web in the documented UI environment.

    Documented command
    go run .

Expected outcome

The README describes a source-based API development setup with a separately launched web UI pointed at the local API.

Guide limitations

  • A running LBRY desktop app or lbrynet instance may need to be stopped or have its ports changed.
  • The repository distinguishes the API server from the frontend; the UI launch is a separate step.
Documentation 1 ↗
Source-based practical guide

Launch the documented Docker Compose environment

Initialize the API’s SDK and PostgreSQL containers and point a separately launched UI at the local API.

Before you start

  • Recent enough Docker and Docker Compose.
  • The lbry-desktop repository for the documented UI stage.

Steps

  1. Initialize and launch containers with the command below.

    Documented command
    docker compose -f docker-compose.yml -f docker-compose.app.yml up -d

  2. Clone the lbry-desktop repository as shown in the README.

  3. In the lbry-desktop folder, launch the UI with LBRY_WEB_API=http://localhost:8080 yarn dev:web.

  4. Open http://localhost:9090/ in Chrome or Firefox, which the README identifies as the best experience.

Expected outcome

The documented Compose path starts the required SDK and PostgreSQL images and provides a local UI launch sequence.

Guide limitations

  • A running LBRY desktop app or lbrynet instance may need to be stopped or have its ports changed.
  • The instructions describe launching a separate UI; they do not make the API repository itself the frontend.
Documentation 1 ↗
Evidence and transparency

Sources & review

Official repository ↗
Source record details
Source availability
Active
Sources checked
10 October 2026
Original website title
OdyseeTeam/odysee-api · Official homepage title · retained in its source language
How we review sourcesSuggest a correction