Skip to content

File ​

User-specific files and other files related functionality: Image processing, preview etc.

Salaxy API v03, Finland only. 6 operations. Interactive version: REST API reference. Machine-readable: OpenAPI document.

The reference wins

These pages are generated from the OpenAPI document. If a guide and this reference disagree about a field, follow the reference. Error responses are not in the document — see Errors.

GET /v03/api/files ​

Returns list of files for the current owner.

ParameterInTypeRequiredDescription
$searchquerystring
$filterquerystringSpecifies the logic to pull back a subset of records.
$orderbyquerystringSpecifies the values used to sort the collection of entries.
$selectquerystringThe $select system query option allows the clients to requests a limited set of properties for each entry.
$topquerynumberSpecifies the subset of entries by count.
$skipquerynumberSpecifies the count of entries to skip.
$countquerybooleanIndicates whether or not to include a total entry count.

Response: PageResultOfFileListItem

Try it: interactive reference

GET /v03/api/files/{id} ​

Gets a single object based on identier

ParameterInTypeRequiredDescription
idpathstringyesUnique identifier for the object

Response: BlobFile

Try it: interactive reference

GET /v03/api/files/{id}/content ​

Gets the content for a single file.

ParameterInTypeRequiredDescription
idpathstringyes

Response: string

Try it: interactive reference

GET /v03/api/files/type/{type} ​

Gets all the Files of specific type for this user.

ParameterInTypeRequiredDescription
typepathBlobFileTypeyes

Response: BlobFile[]

Try it: interactive reference

GET /v03/api/files/{id}/stream ​

Gets the file stream / blob for a single file

ParameterInTypeRequiredDescription
idpathstringyes

Response: string

Try it: interactive reference

GET /v03/api/files/{id}/preview ​

Gets the preview image (currently always PNG) for the file, if available.

ParameterInTypeRequiredDescription
idpathstringyesIdentifier of the file that potentially has preview

Response: string

Try it: interactive reference

Every page is also available as Markdown: add .md to its URL — a folder page such as white-label/ is white-label/index.md. Index for LLMs: llms.txt. Questions: Support.