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://api.bibleit.app/v1
Use /v1 to pin your integration to REST v1. https://api.bibleit.app serves
whichever major version is current (v1 today); opt into that alias only if your
client can follow major-version changes. The existing
https://bibleit.app/api/v1 URL remains supported. Resource links returned by the
API host pin /v1, including requests made through the latest alias.
The reference lives at https://docs.bibleit.dev;
https://api.bibleit.app/docs redirects here. OAuth sign-in and consent continue
on https://bibleit.app.
How does Bibleit work?
- Authenticate with a personal API token, or use registered OAuth to act with someone’s consent.
- Read your identity to discover your personal account ID.
- Browse your library, then read a passage or search Scripture.
- Create a Live and control its display, playback and queue.
- 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
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 JSONThis reference describes REST v1 alpha. API server rollout is separate from
publishing this reference. The deployed REST release exposes the contract at
https://api.bibleit.app/v1/openapi.json.
