Glossary · API docs

Terms#

Term	Meaning
Church	An account. A church API key reaches exactly one.
Teaching	One recorded sermon or talk. Moves from `awaiting_upload` to `ready`.
Transcript	The words of a teaching, as time-coded segments.
Note	The written record of a teaching: a summary and sections. Reviewed before it is published.
Output	A devotional, blog post, newsletter or study guide written from a note.
Published	Approved and live. The only state a key can read.
Approval kind	`human` when a person read it, `automatic` when the church's automatic approval approved it.
Ask	Questions answered from the church's approved teaching, with citations.
Standing	Whether a teaching an answer drew on is current, superseded or retracted.
Scope	A capability on a key, such as `notes:read`.
Church key	A `folio_live_` or `folio_test_` key for one church.
Partner key	A key that manages customer churches and can act for them with `X-Folio-Church`.
Sandbox church	A free church for development, reached only with `folio_test_` keys.
Device key	A `folio_booth_` key for a booth machine.
Site key	The public credential of the widget, valid only from allowed origins.
Envelope	The `{status, message, data, meta}` shape of every response.
Idempotency key	A string you choose so a retried write happens once.
Cursor	An opaque token for the next page of a list.
Request id	The id of one request, in `meta.request_id`, `error.request_id` and `X-Request-Id`.
King James Version	The only scripture translation Folio carries.

Verified against API version 0.0.0-dev. Generated from the live OpenAPI document.