Retrieve details for a single file.

GET

https://demo.azuracast.com/api/station/{station_id}/file/{id}

curl -X GET 'https://demo.azuracast.com/api/station/0/file/%7Bid%7D' \
  -H 'X-API-Key: YOUR_TOKEN'

const response = await fetch('https://demo.azuracast.com/api/station/0/file/%7Bid%7D', {
  method: 'GET',
  headers: {
    'X-API-Key': 'YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://demo.azuracast.com/api/station/0/file/%7Bid%7D',
    headers={
        'X-API-Key': 'YOUR_TOKEN',
    },
)
print(response.text)

{
  "text": "Chet Porter - Aluko River",
  "artist": "Chet Porter",
  "title": "Aluko River",
  "album": "Moving Castle",
  "genre": "Rock",
  "isrc": "US28E1600021",
  "lyrics": "",
  "links": {},
  "id": 1,
  "unique_id": "69b536afc7ebbf16457b8645",
  "song_id": "9f33bbc912c19603e51be8e0987d076b",
  "art": "https://picsum.photos/1200/1200",
  "path": "test.mp3",
  "mtime": 1609480800,
  "uploaded_at": 1609480800,
  "art_updated_at": 1609480800,
  "length": 240,
  "length_text": "4:00",
  "custom_fields": {},
  "extra_metadata": {},
  "playlists": [
    {
      "id": 1,
      "name": "string",
      "short_name": "string",
      "folder": "string",
      "count": 0
    }
  ]
}

{
  "code": 500,
  "type": "NotLoggedInException",
  "message": "Error description.",
  "formatted_message": "<b>Error description.</b><br>Detailed error text.",
  "extra_data": [],
  "success": false
}

{
  "code": 500,
  "type": "NotLoggedInException",
  "message": "Error description.",
  "formatted_message": "<b>Error description.</b><br>Detailed error text.",
  "extra_data": [],
  "success": false
}

{
  "code": 500,
  "type": "NotLoggedInException",
  "message": "Error description.",
  "formatted_message": "<b>Error description.</b><br>Detailed error text.",
  "extra_data": [],
  "success": false
}

Parameters

station_idinteger | stringrequiredpath

media_idinteger<int64>requiredpath

Media ID

Response

200OKApi_HasSongFields & HasLinks & object

Success

Response fields application/json

textstring

The song title, usually “Artist - Title”

Example

Chet Porter - Aluko River

artiststring | null

The song artist.

Example

Chet Porter

titlestring | null

The song title.

Example

Aluko River

albumstring | null

The song album.

Example

Moving Castle

genrestring | null

The song genre.

Example

Rock

isrcstring | null

The International Standard Recording Code (ISRC) of the file.

Example

US28E1600021

lyricsstring | null

Lyrics to the song.

Example

linksobjectread only

Show child attributes

[key: string]string

idinteger

The media’s identifier.

Example

unique_idstring

A unique identifier for this specific media item in the station’s library. Each entry in the media table has a unique ID, even if it refers to a song that exists elsewhere.

Example

69b536afc7ebbf16457b8645

song_idstring

The media file’s 32-character unique song identifier hash. This hash is based on track metadata, so the same song uploaded multiple times will have the same song_id.

Example

9f33bbc912c19603e51be8e0987d076b

artstring

URL to the album art.

Example

https://picsum.photos/1200/1200

pathstring

The relative path of the media file.

Example

test.mp3

mtimeinteger

The UNIX timestamp when the database was last modified.

Example

1609480800

uploaded_atinteger

The UNIX timestamp when the item was first imported into the database.

Example

1609480800

art_updated_atinteger

The latest time (UNIX timestamp) when album art was updated.

Example

1609480800

lengthnumber<float>

The song duration in seconds.

Example

length_textstring

The formatted song duration (in mm:ss format)

Example

4:00

custom_fieldsHashMap

A hash-map array represented as an object.

extra_metadataHashMap

A hash-map array represented as an object.

playlistsArray<Api_StationMediaPlaylist | integer>

Show child attributes

One of

idinteger

The playlist identifier.

Example

namestringread only

short_namestringread only

folderstring | nullread only

countintegerread only

integer

403ForbiddenApi_Error

Access denied.

Response fields application/json

codeintegerrequired

The numeric code of the error.

Example

typestringrequired

The programmatic class of error.

Example

NotLoggedInException

messagestringrequired

The text description of the error.

Example

Error description.

formatted_messagestring | nullrequired

The HTML-formatted text description of the error.

Example

<b>Error description.</b><br>Detailed error text.

extra_dataArray<any>required

Stack traces and other supplemental data.

successbooleanrequired

Used for API calls that expect an \Entity\Api\Status type response.

Example

false

404Not FoundApi_Error

Record not found.

Response fields application/json

codeintegerrequired

The numeric code of the error.

Example

typestringrequired

The programmatic class of error.

Example

NotLoggedInException

messagestringrequired

The text description of the error.

Example

Error description.

formatted_messagestring | nullrequired

The HTML-formatted text description of the error.

Example

<b>Error description.</b><br>Detailed error text.

extra_dataArray<any>required

Stack traces and other supplemental data.

successbooleanrequired

Used for API calls that expect an \Entity\Api\Status type response.

Example

false

500Internal Server ErrorApi_Error

A generic exception has occurred.

Response fields application/json

codeintegerrequired

The numeric code of the error.

Example

typestringrequired

The programmatic class of error.

Example

NotLoggedInException

messagestringrequired

The text description of the error.

Example

Error description.

formatted_messagestring | nullrequired

The HTML-formatted text description of the error.

Example

<b>Error description.</b><br>Detailed error text.

extra_dataArray<any>required

Stack traces and other supplemental data.

successbooleanrequired

Used for API calls that expect an \Entity\Api\Status type response.

Example

false

Authorization

ApiKeyapiKey in header

Docs by Sourcey