API Reference

The Slipstream HTTP API. Versioned, JSON in and out, token-authenticated.

Base URL

https://api.slipstreammusic.com

Authentication

Most endpoints accept a partner API key sent as a bearer token:

Authorization: Bearer <PARTNER_API_KEY>

Specific endpoints may require additional headers (for example, X-User-ID when the call is made on behalf of one of your end users). The reference page for each endpoint lists every required header.

Conventions

• All requests and responses are JSON unless otherwise noted.
• Successful responses use HTTP 200; resources created with POST may return 201.
• Errors return a JSON body with a success: false flag plus an error object containing code and message. Codes are stable; messages are not — match against code in your client.
• Timestamps are ISO 8601 in UTC.
• IDs are UUIDs unless otherwise noted.

Resources

Search

Search the catalog by text, by prompt with highlights, by reference URL, by track ID, by video, or list available filters.

• GET /api/v4/search/ai/by-text/ — Search by natural-language query
• GET /api/v4/search/ai/by-prompt/ — Same as by-text, but each result includes highlights: [{offset, duration}]
• GET /api/v4/search/ai/by-url/ — Find similar tracks from a YouTube/Spotify/etc. URL
• GET /api/v4/search/ai/by-id/ — Find similar tracks from a Slipstream track
• GET /api/v4/search/ai/by-video/ — Find tracks that match an uploaded video or YouTube URL
• GET /api/v4/search/ai/filters/ — List available genres, moods, BPM ranges, and other filter values

Tracks

Read individual tracks from the catalog by ID.

• GET /api/v4/{language}/tracks/{id}/ — Retrieve a single track with full metadata, lyrics, and rights data

Waveforms

Get raw waveform peaks for any audio asset (track, sound effect, or stem) to render in your own canvas/SVG.

• GET /api/v4/music/waveforms/{audio_type}/{audio_id}/ — Retrieve precomputed peaks data

Playlists

Manage user playlists. Owners and collaborators only.

• GET /api/v4/me/playlists/ — List playlists
• POST /api/v4/me/playlists/ — Create a playlist
• GET /api/v4/me/playlists/{slug}/ — Retrieve a playlist
• PATCH /api/v4/me/playlists/{slug}/ — Update a playlist
• DELETE /api/v4/me/playlists/{slug}/ — Delete a playlist
• POST /api/v4/me/playlists/{slug}/tracks/ — Add or remove items
• POST /api/v4/me/playlists/{slug}/tracks/reorder/ — Reorder items

Downloads

Get a presigned URL for any single audio asset. Subscription/enterprise plan required.

• POST /api/v4/download/audio/{id}/ — Download a track, sound effect, or stem (mp3 / wav, optional stems)
• GET /api/v4/download/audio/{id}/ — Browser-friendly variant that 302-redirects to the URL

Soundtrack a video

Score any video automatically. See the Soundtrack a video guide for the full flow.

• POST /api/v4/soundtrack/video/ — Upload a video or submit a YouTube URL
• GET /api/v4/soundtrack/video/{id}/ — Retrieve a video
• POST /api/v4/soundtrack/video/{id}/download/ — Render and download the video with a chosen track mixed in

AudioVerify™

Identify the music used in a video. Returns the recognized track, whether it is in the Slipstream catalog, and any registered label (for example Epidemic Sound). Submit-and-poll. See the AudioVerify overview for the full flow.

• POST /api/v4/video-recognition/: Submit a video (file upload or storage_key)
• POST /api/v4/video-recognition/upload-url/: Get a presigned S3 upload URL for large videos
• GET /api/v4/video-recognition/{job_id}/: Poll a job for its status and result

Licenses

Issue licenses for Slipstream tracks on behalf of your end users.

• POST /api/v1/licenses/generate — Generate a license

More resources will be documented here as they’re added.