List verse-art images, optionally filtered by language and/or verse.
Returns a paginated collection of verse-art images. Each item is the full Image record, with the same shape that GET /v1/images/{image_id} returns. The CDN serves image bytes, not this endpoint. The system issues the id of each item for this response, and the image_url of the item carries that id.
passage_id filters to images that illustrate that passage. The passage is a single verse or a verse range within one chapter (for example JHN.3.16 or 1CO.13.4-7). The endpoint does not support chapter-level identifiers such as JHN.3. They return 400. language_ranges[] filters by the language of the art and tries ranges in the order given. If you combine both, the results match every filter.
A page with no images and no further pages returns 204 with no response body. A page with images or a next_page_token returns 200 with the collection envelope.
query Parameters
passage_idThe passage identifier: a single verse or a verse range, e.g. JHN.3.16 or 1CO.13.4-7. Each operation's description states which forms it accepts.
language_ranges[]An ordered list of language ranges using bracket notation. Use repeated parameters like language_ranges[]=en&language_ranges[]=es to supply multiple ranges, and use the wildcard * to match all languages. Ranges are tried in the order given. Optional; each operation's description states what is returned when it is omitted. A language range is much like a language tag but may contain wildcards. See RFC 4647 section 2 for the full definition: https://www.rfc-editor.org/rfc/rfc4647.html#section-2
Language ranges in this parameter may only be of the Basic Range format.
page_sizeThe number of results to return in the collection. Must be between 1 and 99.
page_tokenThe page token to retrieve results from.
List verse-art images, optionally filtered by language and/or verse. › Responses
Successful request
total_sizeTotal number of images matching the filter, across every page. Only known when passage_id is given; null for a language-only or unfiltered request, where an exact total is not available.
next_page_tokenToken to send to the server when retrieving the next page of results.
Resolve a verse-art image id to its full metadata.
Resolves a verse-art image id to its full metadata. The id comes from /v1/images, /v1/verse-of-the-days, /v1/search-images, or /v1/search-unified. The metadata has the Platform CDN image_url, passage_id, attribution, language tag, native dimensions, and aspect ratio.
Add a size=thumb|card|full query parameter to image_url to select a resized rendition. Omit it for the full-size image. The CDN serves image bytes, not this endpoint.
The system issues the id in the response for the caller. If you send a current id from another image-bearing response, the endpoint returns it unchanged. If you send an older id form, the endpoint replaces it with a newly issued id. image_url always carries the id of the response. The response is private and not shared-cacheable, so no shared cache holds an id for one caller.
path Parameters
image_idA verse-art image id, as returned by the image-bearing endpoints (an image listing, a verse of the day, or an image search result).
Resolve a verse-art image id to its full metadata. › Responses
Successful request
idAn opaque image id issued for this response. Pass it to GET /v1/images/{image_id} to resolve the image's full metadata. Ids are issued per response, so the same image can carry a different id in each response; do not use it as a stable key for the image.
image_urlPlatform CDN URL for the verse art. Its path carries this record's id, so load the URL as given rather than building it; it needs no app key. Add a size=thumb|card|full query parameter to select a resized rendition; omit it for the full-size image.
passage_idThe passage this image illustrates, as a passage identifier (a verse or verse range, e.g. JHN.3.16 or 1CO.13.4-5).
attributionAttribution/credit line for the image.
language_tagBCP-47 language tag of the art's text.
widthNative image width in pixels.
heightNative image height in pixels.
aspect_ratioNative width divided by height, rounded to 3 places, for layout before the image loads.