Base path: /v1
Last generated: 2026-02-19 22:14:44 UTC
POST /v1/renderPermalink
Render scripture passage as HTML, plain text, and metadata.
Request content type: application/json
Request fields:
| Field | Type | Required | Default | Notes |
|---|---|---|---|---|
reference |
string |
yes | Bible reference (for example Romans 8:1-4). | |
translation |
string |
no | WEB |
Allowed: WEB, KJV. |
showVerseNumbers |
boolean |
no | true |
|
showReference |
boolean |
no | true |
|
stylePreset |
string |
no | minimal |
Render style preset. Allowed: native, minimal, modern, codex, newsprint, receipt, terminal, blueprint, neon, none. |
lineBreaks |
string |
no | verse |
Allowed: verse, paragraph. |
Response content type: application/json
Response fields:
| Field | Type | Required | Default | Notes |
|---|---|---|---|---|
html |
string |
yes | ||
text |
string |
yes | ||
metadata.reference |
string |
yes | ||
metadata.verseCount |
number |
yes | ||
metadata.translation.id |
string |
yes | ||
metadata.translation.name |
string |
yes |
GET /v1/embed/plugin.jsPermalink
JavaScript plugin for
Response content type: application/javascript
Response fields:
Not documented for this endpoint.
POST /v1/kit/renderPermalink
Render content block HTML for Kit editor and email output.
Request content type: application/json
Request fields:
| Field | Type | Required | Default | Notes |
|---|---|---|---|---|
settings |
object |
no | ||
styles |
object |
no |
Response content type: application/json
Response fields:
| Field | Type | Required | Default | Notes |
|---|---|---|---|---|
code |
integer |
yes | Allowed: 200. |
|
html |
string |
yes |