Skip to main content

User-related API environment

Pre-live user-related API docs

These pages describe the Pre-live user-related API stack.

Use pre-live OAuth credentials, pre-live API base URLs, and pre-live app URLs when following this documentation. Keep your OAuth flow, API requests, callback URLs, and manual testing within the pre-live environment.

Generate a Share Verse image​

Generates a square image for one ayah or an ascending, same-Surah range of two to seven ayahs. The endpoint is available without authentication and may reject otherwise valid ranges when the selected content cannot fit within readable image bounds.

Request Body required
    verseKey string required

    Possible values: Value must match regular expression ^(\d+):(\d+)$

    The ayah key to render, or the first ayah key of a range.

    endVerseKey string

    Possible values: Value must match regular expression ^(\d+):(\d+)$

    The inclusive final ayah key. It must follow verseKey in the same Surah and produce a range of two to seven ayahs. Omit it for a single-ayah image.

    locale string

    Possible values: [en, ar, bn, fa, fr, id, it, nl, pt, ru, sq, th, tr, ur, zh, ms, es, sw, vi]

    The Quran.com interface locale used for the Surah name, numerals, and direction. When omitted, the renderer uses its legacy default locale.

    translations integer[] required

    Possible values: >= 1

    Translation resource IDs to render, in display order. Use an empty array for Arabic only.

Responses

Request has been handled successfully.


Schema
    success boolean
    data object
    url string required

    The generated image URL.

Loading...