SpecifyDocs

File library detail

/v1/library/files/{id}

Signed-in sessionLaunch key product.filesOperation file_library_detail

People and agents upload files, link them to tasks, memories and briefings, preview them, and run processing jobs on them.

Path parameters

idstringRequired

Query parameters

expectedAuthorizationVersionstring

Returns

idstringRequired
namestringRequired
kind"archive" | "audio" | "image" | "other" | "pdf" | "text" | "video"Required
mimestringRequired
sizeBytesnumberRequired
visibility"org" | "private"Required
createdAtnumberRequired
uploaderLabelstringRequired
status"available" | "blocked" | "deleting" | "failed" | "processing" | "uploading"Required
blockedReason"blocked_type" | "integrity" | "scan_required" | "source" | "withdrawn"
scanStatus"clean" | "error" | "infected" | "not_scanned" | "pending" | "unsupported"Required
safetyNoticestringRequired
tagsobject[]Required
versionnumberRequired
thumbnailAvailablebooleanRequired
capabilitiesobjectRequired
folderIdstring
minefalse | true
updatedAtnumber
linkSummaryobject
sha256stringRequired
publicationobjectRequired
linksobject[]Required
contextobjectRequired

Errors

400, 401, 403, 404, 409, 429 and 503 return {"error": {"code", "message", "correlationId"}}.