Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.sdk.anghami.com/llms.txt

Use this file to discover all available pages before exploring further.

This changelog records changes to the public SDK. Internal infrastructure changes are not listed unless they affect the public surface.

​
Unreleased

  • Docs migrated to Mintlify. The previous Scalar viewer at docs/index.html has been replaced with a full Mintlify site, including MDX guides, agent-discovery, and an llms.txt briefing.
  • Single bundled OpenAPI. The 10 per-service .openapi.{json,yaml} files have been replaced with one bundled docs/api/anghami-sdk.openapi.yaml (and .json) generated via sebuf 0.11+ bundle=true. Postman, Insomnia, and codegen tools now import a single file.

​
v1 — current

The v1 surface comprises:
  • AuthService — OAuth + PKCE.
  • DeveloperService — API key lifecycle.
  • MusicCatalogService — songs, albums, artists, lyrics.
  • VideoCatalogService — shows, seasons, episodes, movies.
  • DiscoveryService — search and browse (featured, new releases, charts, genres).
  • SoundtrackService — bidirectional music ↔ video linking.
  • PlaylistService — read-only playlist access.
  • LibraryService — liked, saved, followed, history.
  • UserService — current user profile.
  • StreamingService — billable stream acquisition.
Shared types in sdk.shared.v1: pagination, errors, identifiers, content types, media, rate limit info.

​
Versioning policy

See Versioning for how breaking and non-breaking changes are handled. Breaking changes ship as v2 packages alongside v1 — never silently.

​
Reporting issues