BIBLEIT / Documentation

Developers

Build with Bibleit using REST v1, a client library or the SSH command protocol.

REST API v1

Use REST v1 for new HTTP integrations. Explore accounts, Scripture, translations and Lives, with organization resources in their own section. The API reference documents scopes, request fields, responses and errors.

API reference OpenAPI 3.1 JSON

curl --header "Authorization: Bearer <token>" https://api.bibleit.app/v1/me

Replace the placeholder in the Authorization header with a finite personal API token or a delegated OAuth access token. Organization resources use scoped service tokens instead; service tokens cannot access personal account endpoints.

Language clients

Use a library to integrate Bibleit into your application. The Go and Lua SDKs are available under MIT; more language clients are planned below.

Available

Go SDK

Add Scripture readings, search, and Live controls to your Go application with typed results and a dependency-free client.

go get github.com/bibleit-labs/bibleit-go

Go quickstart Source on GitHub

Available

Lua

Lua SDK

REST resources, OAuth, browser authorization and SSH helpers for Lua 5.1–5.5 and LuaJIT 2.1. Installation requires OpenSSL development headers.

luarocks install bibleit

Go quickstart Source on GitHub

Command line

Use the standalone CLI to work directly in your terminal. Choose a language client above when you are building an application.

Available

Terminal · Go

Bibleit CLI

Read, search, and present from your terminal. Install with Homebrew on macOS or Linux, or use the Bash and Windows installers.

brew install bibleit-labs/tap/bibleit-cli

Install the CLI Source on GitHub

More languages, one protocol

These clients are on the roadmap. Packages and release dates will appear here when they are available. You can build an integration today using the open command protocol.

Planned

JavaScript

For browser tools and Node.js applications.

Planned

Python

For automation, scripts, and Python applications.

Planned

Ruby

For Ruby applications and scripting.

Planned

Rust

For typed integrations and native applications.

Planned

Erlang / Elixir

For Erlang and Elixir applications on the BEAM.

Planned

PHP

For PHP websites and backend applications.

OPEN COMMAND PROTOCOL

Build your own integration

Use the version 1 command protocol to build a client in your preferred language. Explore requests, responses, and permissions, then try commands in the Bibleit Shell.

Protocol reference Bibleit Shell