Home Original page

Files | Activeloop

Files

Upload a file with optional metadata.

AuthorizationstringRequired

Enter your bearer token in the format 'your-token' (without quotes or 'Bearer' prefix)

filestring · binary[]Optional
purposestring · enumOptionalDefault: user_dataPossible values:
metadataany ofOptional

JSON string with file metadata

instructionsany ofOptional

Instructions used to process the file

workspacestringOptionalDefault: default

Returns a list of files, filtered by the organization.

AuthorizationstringRequired

Enter your bearer token in the format 'your-token' (without quotes or 'Bearer' prefix)

workspacestringOptionalDefault: default
limitinteger · min: 1 · max: 10000Optional

Limit the number of returned files

Default: 10000
orderstringOptional

Sort order by creation timestamp

Default: desc
string · enumOptionalPossible values:
or
objectstringOptionalDefault: list

Returns information about a specific file, verifying organization access.

AuthorizationstringRequired

Enter your bearer token in the format 'your-token' (without quotes or 'Bearer' prefix)

workspacestringOptionalDefault: default
objectstringOptionalDefault: file
created_atintegerRequired
purposeany ofOptionalDefault: user_data
string · enumOptionalPossible values:
or
statusstring · enumOptionalDefault: uploadedPossible values:
status_detailsany ofOptional
workspace_idstringOptionalDefault: default

Delete a file, verifying organization access.

AuthorizationstringRequired

Enter your bearer token in the format 'your-token' (without quotes or 'Bearer' prefix)

workspacestringOptional

Delete file from workspace

Default: default
objectstringOptionalDefault: file
deletedbooleanOptionalDefault: true

Returns the contents of the specified file, verifying organization access.

AuthorizationstringRequired

Enter your bearer token in the format 'your-token' (without quotes or 'Bearer' prefix)

workspacestringOptional

The workspace id to get file content from

Default: default

/files/{file_id}/metadata

Update metadata for a specific file, verifying organization access.

AuthorizationstringRequired

Enter your bearer token in the format 'your-token' (without quotes or 'Bearer' prefix)

workspacestringOptional

The workspace id to update th file in

Default: default

The metadata to update. instructions key is considered as an instruction to update metadata by AI.

Other propertiesanyOptional
/files/{file_id}/metadata

Last updated