Skip to navigation
Get started

API Reference

Bibleit helps people read Scripture and present it together. Use its REST API to browse translations, read and search passages, manage Lives and connect apps to personal accounts or shared workspaces.

Base URL: https://bibleit.app/api/v1

How does Bibleit work?

  1. Authenticate with a personal API token, or use registered OAuth to act with someone’s consent.
  2. Read your identity to discover your personal account ID.
  3. Browse your library, then read a passage or search Scripture.
  4. Create a Live and control its display, playback and queue.
  5. Follow Live events to keep your app in sync with the current state.

Just getting started?

Follow the quickstart to make your first authenticated requests. It starts with your identity and the translation catalogue, without requiring an account ID.

Explore the API

ResourceWhat you can do
Personal accountsRead your identity, library and Scripture; manage your own Lives.
TranslationsDiscover editions, metadata and book coverage.
LivesRead and edit a Live, manage its queue and control playback and display.
Live eventsObserve snapshots and changes without joining the audience.
OrganizationsManage shared workspaces, memberships, service tokens, libraries, Studio settings and presentations.

Shared Live resources authorize access according to the credential’s owner. Organization-only resources and their guides live in the Organizations section.

Authentication and requests

Send Authorization: Bearer <token> with each authenticated request. Personal API tokens use bt_, delegated OAuth access tokens use oa_, and organization service tokens use svc_. Each operation lists its required scopes and ownership rules. See authentication for the complete flow.

Responses use HTTP status codes and JSON. Errors use Problem Details with a stable code and a request ID. Collections use bounded pagination, and shared writes use ETags. Read retries and concurrency before creating or editing resources. Run the HTTP examples from a backend or CLI.

OpenAPI contract

Download the OpenAPI JSON

This reference describes REST v1 alpha. API server rollout is separate from publishing this reference. The deployed REST release exposes the contract at https://bibleit.app/api/v1/openapi.json.