Indexing

🛡️ Get files from your index.

Get one or more files from your index. Depending on the filetype, addtional information will be returned about the entities that were extracted from the file.

<br /><hr /><h3>🛡️ Requires Capabilities: <code>Indexing.Operate</code></h3>

get/api/v1/index/file

Query parameters

idsstring[]

librarystring

Response

fileIdstring required

absolutePathstring required

relativePathstring required

mimeTypestring

extensionstring required

appstring required

mediaTypestring required

sizenumber required

mtimestring date-time

lastSeenstring date-time required

idnumber required

createdAtstring date-time required

updatedAtstring date-time required

deletedAtstring date-time required

Changes

Changed in 10 of the 176 revisions of this API.289

Aug 1, 2026d2689383f1721See the full diff
- ▲
  the items/musicTrack/items/history/items/queueItem/queue/seedMediaType response's property type/format changed from string/ to object/ for status 200
  response-property-type-changed
Jul 23, 2026ae7d637d180311See the full diff
- ●
  added the new generate_waveforms enum value to the items/jobTasks/items/job/type response property for the response status 200
  response-property-enum-value-added
- ○
  removed the generate_waveform enum value from the items/jobTasks/items/job/type response property for the response status 200
  response-property-enum-value-removed
Jul 23, 20265265ec620aa112See the full diff
- ▲
  the items/musicTrack/items/history/items/queueItem/queue/dynamicType response's property type/format changed from string/ to object/ for status 200
  response-property-type-changed
- ○
  added the optional property items/musicTrack/items/history/items/queueItem/queue/seedMediaId to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/musicTrack/items/history/items/queueItem/queue/seedMediaType to the response with the 200 status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 22, 2026404b6308c09a21See the full diff
- ●
  added the new generate_track_waveform enum value to the items/jobTasks/items/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new generate_waveform enum value to the items/jobTasks/items/job/type response property for the response status 200
  response-property-enum-value-added
- ○
  added the optional property items/musicTrack/items/waveform to the response with the 200 status
  response-optional-property-added
Apr 18, 2026b2c32b0b84d62See the full diff
- ○
  added the optional property items/musicTrack/items/artists/items/releases/items/releaseType to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property items/musicTrack/items/release/releaseType to the response with the 200 status
  response-optional-property-added
Apr 13, 202671bda9bfce4c1See the full diff
- ●
  removed the optional property items/musicTrack/items/ratings from the response with the 200 status
  response-optional-property-removed
Apr 12, 202643cbfa2e8b431See the full diff
- ○
  added the optional property items/musicTrack/items/ratings to the response with the 200 status
  response-optional-property-added
Mar 27, 2026eaf62ef2fb771See the full diff
- ○
  added the optional property items/mtime to the response with the 200 status
  response-optional-property-added
Mar 21, 202653ab8410d0eb1See the full diff
- ○
  added the optional property items/musicTrack/items/history/items/queueItem to the response with the 200 status
  response-optional-property-added
Mar 10, 20261ec5a2e9d0394See the full diff
- ●
  removed the optional property items/mtime from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/musicTrack/items/artists/items/releases/items/releaseType from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/musicTrack/items/history/items/queueItem from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property items/musicTrack/items/release/releaseType from the response with the 200 status
  response-optional-property-removed
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history