1---2name: quran-foundation-api-docs3description: Use when choosing Quran Foundation API families, authentication flows, endpoints, SDK runtime boundaries, Developer Console onboarding, font rendering, or official integration references.4metadata:5 source: https://skillmd.com/skills/quran/quran-foundation-api-docs6---78# Quran Foundation API Docs910## Use When1112- The task involves Quran Foundation APIs, api-docs.quran.foundation, Quran.com integrations, or quranreflect.com integrations.13- The user needs official endpoint selection, request or response details, auth guidance, scopes, quickstarts, or migration help.14- The user needs font rendering or Mushaf page-layout guidance.15- The user needs OAuth2 or OIDC setup guidance across web or mobile platforms.16- The user needs Developer Console onboarding details such as app creation, credentials, app type, redirect URIs, permissions, or existing-client import.17- The user wants to scaffold a Quran Foundation app, choose the official JavaScript or Python SDK path, or use a copyable implementation prompt.18- The task involves Quran Reflect or quranreflect.com features backed by Quran Foundation APIs.19- The user wants links to official documentation or OpenAPI specifications.2021## Do Not Use When2223- The task is unrelated to Quran Foundation APIs.24- The user needs live production data, account-specific secrets, or environment access that is not present in the docs.2526## Route The Request First27281. Identify the correct API family.29 - Content APIs v4: Quran text, translations, tafsir, audio, recitations, verses, chapters, pages, juz, hizb, ruku, manzil, and related content.30 - Search APIs v1: Quran search queries and search-related integration.31 - OAuth2 APIs v1 and OIDC docs: authentication, authorization, tokens, discovery, and login flows.32 - User-related APIs v1: bookmarks, collections, notes, profiles, reading sessions, rooms, posts, and related user features.33 - Font and page-layout tutorials: script rendering, Mushaf layouts, and page-based display guidance.34 - Quran Reflect integrations: posts, comments, feeds, likes, saves, room/page/community features, and related scopes.352. Prefer stable production docs by default.363. Only use pre-live user-related docs when the user explicitly asks for upcoming or unreleased behavior.3738## Canonical Sources3940- Docs home: `https://api-docs.quran.foundation/`41- Content OpenAPI: `https://api-docs.quran.foundation/openAPI/content/v4.json`42- Search OpenAPI: `https://api-docs.quran.foundation/openAPI/search/v1.json`43- OAuth2 OpenAPI: `https://api-docs.quran.foundation/openAPI/oauth2-apis/v1.json`44- User-related OpenAPI (production): `https://api-docs.quran.foundation/openAPI/user-related-apis/v1.json`45- User-related OpenAPI (pre-live): `https://api-docs.quran.foundation/openAPI/user-related-apis/pre-live/v1.json`46- Agent prompt registry: `https://api-docs.quran.foundation/.well-known/agent-prompts/index.json`47- Next.js starter prompt: `https://api-docs.quran.foundation/agent-prompts/qf-next-starter.md`48- SvelteKit starter prompt: `https://api-docs.quran.foundation/agent-prompts/qf-sveltekit-starter.md`49- JS SDK integration prompt: `https://api-docs.quran.foundation/agent-prompts/qf-js-sdk-integration.md`50- Python SDK integration prompt: `https://api-docs.quran.foundation/agent-prompts/qf-python-sdk-integration.md`51- OAuth/User APIs prompt: `https://api-docs.quran.foundation/agent-prompts/qf-oauth-user-apis.md`52- Review existing integration prompt: `https://api-docs.quran.foundation/agent-prompts/qf-review-existing-integration.md`53- AI Agent Prompts: `https://api-docs.quran.foundation/docs/ai-agents/`54- Developer Journey: `https://api-docs.quran.foundation/docs/developer-journey/`55- API Reference: `https://api-docs.quran.foundation/docs/api-reference/`56- JavaScript SDK: `https://api-docs.quran.foundation/docs/sdk/javascript/`57- Python SDK: `https://api-docs.quran.foundation/docs/sdk/python/`58- Starter With NPX: `https://api-docs.quran.foundation/docs/tutorials/oidc/starter-with-npx/`59- User APIs OIDC quickstart: `https://api-docs.quran.foundation/docs/tutorials/oidc/user-apis-quickstart/`60- OAuth2 getting started: `https://api-docs.quran.foundation/docs/tutorials/oidc/getting-started-with-oauth2/`61- OpenID Connect tutorial: `https://api-docs.quran.foundation/docs/tutorials/oidc/openid-connect/`62- OIDC client setup: `https://api-docs.quran.foundation/docs/tutorials/oidc/client-setup/`63- OAuth2 web integration example: `https://api-docs.quran.foundation/docs/tutorials/oidc/example-integration/`64- Mobile apps overview: `https://api-docs.quran.foundation/docs/tutorials/oidc/mobile-apps/`65- Android mobile OIDC guide: `https://api-docs.quran.foundation/docs/tutorials/oidc/mobile-apps/android/`66- iOS mobile OIDC guide: `https://api-docs.quran.foundation/docs/tutorials/oidc/mobile-apps/iOS/`67- React Native OIDC guide: `https://api-docs.quran.foundation/docs/tutorials/oidc/mobile-apps/react-native/`68- Content API quickstart: `https://api-docs.quran.foundation/docs/quickstart/`69- Font rendering tutorial: `https://api-docs.quran.foundation/docs/tutorials/fonts/font-rendering/`70- Page layout tutorial: `https://api-docs.quran.foundation/docs/tutorials/fonts/page-layout/`71- Developer Console: `https://dev-console.quran.foundation/`72- Developer Console onboarding bridge: `https://api-docs.quran.foundation/request-access/`73- FAQ: `https://api-docs.quran.foundation/docs/tutorials/faq/`74- API catalog: `https://api-docs.quran.foundation/.well-known/api-catalog`7576## Working Rules7778- Cite official Quran Foundation docs or OpenAPI specs when giving implementation guidance.79- Prefer the most specific doc page for the endpoint in question, not just the docs home page.80- Do not invent endpoints, scopes, parameters, headers, or response fields. Confirm them from the docs or OpenAPI.81- Distinguish documentation URLs from API base URLs.82- For auth questions, call out whether the answer belongs to OAuth2/OIDC or to an application API.83- For setup questions, send developers to Developer Console to create or open an app, select the exact **Frontend or mobile app** or **Backend/server app** type, manage credentials and redirect URIs, and request permissions. Treat `/request-access` as a bridge to Console, not as a provisioning form.84- For Quran font questions, choose between Unicode text rendering and page-based glyph rendering based on the user's display requirements.85- For Quran Reflect-related questions, check post, comment, feed, room, and scope docs before answering.86- If multiple endpoints could fit, explain the best match and mention the alternative only if it materially changes implementation.87- If the user asks for sample code, keep it aligned with documented auth and base URL expectations.88- For JavaScript or TypeScript apps, identify the app type selected in Developer Console before choosing the OAuth and SDK boundary.89 - A **Frontend or mobile app** is a public client with no client secret. Use `@quranjs/api/public` for PKCE authorization, code exchange, and refresh in the app; store user tokens with secure platform-appropriate storage and never log them.90 - A **Backend/server app** is a confidential client. Use `@quranjs/api/public` for browser/mobile-safe authorization initiation and `@quranjs/api/server` for secret-backed code exchange, refresh, server sessions, Content, Search, and proxied User API calls.91- For Python apps, scripts, jobs, notebooks, or AI workflows, prefer the official `quran-foundation-api` package and `QuranClient` from trusted server-side environments, keep credentials out of rendered output and logs, and choose app access tokens for Content/Search APIs versus user access tokens for signed-in User APIs explicitly.92- For new Next.js apps, route the user to the official scaffold and prompt before hand-writing OAuth2 plumbing.93- For SvelteKit apps, route the user to the official `--template sveltekit` scaffold and prompt before hand-writing OAuth2 plumbing.94- For response-shape questions, prefer exact endpoint schemas and documented status-code behavior to explain common success and error variations.9596## Fast Routing Hints9798- "Get verses, translations, tafsir, chapters, audio, or recitations" -> Content APIs v499- "Search the Quran" -> Search APIs v1100- "Login, tokens, discovery, issuer metadata, OAuth2, OIDC" -> OAuth2 APIs v1 plus OIDC docs101- "Bookmarks, collections, notes, reading sessions, profile, rooms, posts" -> User-related APIs v1102- "Create a Quran app, starter app, scaffold, copy prompt, AI prompt, build with agents" -> Starter With NPX plus QF_NPX_STARTER_PROMPT_V1103- "SvelteKit starter, SvelteKit scaffold" -> Starter With NPX plus QF_SVELTEKIT_STARTER_PROMPT_V1104- "Existing JS SDK integration, add @quranjs/api" -> JavaScript SDK docs plus QF_JS_SDK_INTEGRATION_PROMPT_V1105- "Python SDK, Python client, quran_foundation, quran-foundation-api, AI workflow in Python" -> Python SDK docs plus QF_PYTHON_SDK_INTEGRATION_PROMPT_V1106- "Review an integration, check mistakes, secret exposure, SDK boundary" -> QF_REVIEW_EXISTING_INTEGRATION_PROMPT_V1 plus exact endpoint schemas107- "Where should I start, what path should I follow, developer journey" -> Developer Journey108- "API reference, endpoint lookup, endpoint docs, all APIs" -> API Reference first, then the exact API family page109- "JavaScript SDK, TypeScript SDK, server/public imports, runtime split" -> JavaScript SDK docs110- "Python SDK, Python client, quran-foundation-api, scripts, notebooks, AI workflows" -> Python SDK docs111- "Web login flow, PKCE, callback, mobile auth, redirect URIs" -> OIDC tutorial pages plus OAuth2 APIs112- "Fonts, glyph codes, Mushaf pages, script rendering, Tajweed display" -> Font rendering and page-layout tutorials plus relevant content endpoints113- "Quran Reflect feed, post, comment, like, save, room, or community behavior" -> User-related posts and rooms docs, and content feed/read docs where applicable114- "Upcoming user API behavior" -> Pre-live user-related docs, and clearly label them as pre-live115116## Expected Output117118- Name the API family first.119- Link the exact doc page or OpenAPI spec used.120- State any auth requirement or prerequisite clearly.121- If relevant, mention whether the guidance is production or pre-live.