Aden
API

API Overview

The HTTP surface that powers Aden. REST, JSON, OpenAPI 3.1.

The Aden API is a versioned REST API mounted at https://www.aden.space/api/v1. Every endpoint the Aden web and mobile apps call is available to you too.

Base URL

https://www.aden.space/api/v1

Self-hosted deployments expose the API at the same /api/v1 prefix under your own domain. Point the SDK at it with baseUrl.

OpenAPI spec

The canonical source of truth lives at /api/v1/openapi. It's regenerated from the server on every deploy — the SDK types are derived from the same definitions, so the SDK and the OpenAPI spec can never drift.

See the Reference for per-endpoint details rendered from that spec.

Resources

TagWhat it covers
AuthSession info for logged-in users (auth.me)
TracksTracks, versions, final masters, covers
AlbumsAlbums and their tracks
TeamsTeam info, members, roles
ContactsCollaborators, contact groups
SessionsStudio sessions — shared workspaces
ChatThreads, messages, read receipts
CalendarMilestones, releases, posts, todos, sessions on a timeline
CampaignsRelease campaigns
ToursTour dates and venues
PlaylistsPlaylist placements and pitches
PostsSocial post planning
StatsStreaming and follower stats
TestimonialsPublic testimonials
UserThe authenticated user's profile, identities, notifications
HealthGET /health — public liveness check

Request format

  • Content type: application/json for bodies, multipart/form-data for uploads.
  • Query params for filters and pagination (limit, offset, teamId).
  • Path params for entity IDs (/tracks/:id).
  • Dates are ISO-8601 strings, IDs are integers unless noted.

Response format

Success bodies are the entity or array of entities directly — no wrapper. Error bodies are { "error": string }. See Errors for status code conventions.

CORS

The API sends permissive CORS headers. You can call it directly from a browser — but don't ship API keys to the browser. Use Supabase tokens for user-facing apps.

Next

On this page