API ReferenceFiles

Get file metadata

Retrieve metadata for a specific file by its relative path ID, e.g. uploads/data.csv or outputs/result.png.

Path parameters

file_idstringRequired

Query parameters

scope_idstringRequired

Session / container identifier.

Response

Successful Response
idstring

Relative path of the file within the session, e.g. ‘uploads/data.csv’ or ‘outputs/result.png’. Use this value as file_id in subsequent requests.

created_atdatetime

ISO-8601 timestamp when the file was created or last modified.

filenamestring
Filename derived from the path.
mime_typestring
MIME type detected from the file content.
size_bytesinteger
File size in bytes.
downloadableboolean

True for sandbox output files; False for uploaded input files.

scopeobject
Session scope this file belongs to.
type"file"Defaults to file
Object type discriminator, always 'file'.

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
503
Service Unavailable Error