Sign in

v38

latestOpenAPI 3.0.3AGPL-3.0raw.githubusercontent.com2026-08-022461333.9 MB
Shares

Create a share

Create a public url that can be used by anyone to stream media. Takes the file id with optional description and expires parameters.

put/shares

Query parameters

filterstring

Object id

type'album' | 'artist' | 'playlist' | 'podcast' | 'podcast_episode' | 'song' | 'video'
descriptionstring

Filled in for you if empty

expiresinteger

Days to keep active

Request body

filterstring required

Object id

type'album' | 'artist' | 'playlist' | 'podcast' | 'podcast_episode' | 'song' | 'video' required
descriptionstring

Filled in for you if empty

expiresinteger

Days to keep active

Response

Share created

idstring required
namestring required
ownerstring required
allow_streamboolean required
allow_downloadboolean required
creation_dateinteger required
lastvisit_dateinteger required
object_typestring nullable required

The kind of object referenced, as a bare string. The set is intentionally open so a new media type is not a breaking change; values seen today include song, album, artist, playlist, podcast, podcast_episode and video.

object_idstring required
expire_daysinteger required
max_counterinteger required
counterinteger required
secretstring nullable required
public_urlstring nullable required
descriptionstring nullable required