See Stacksync in action with a solution architect. Book a demo ↗
Files

Files

Get a file

GET
/v1/workspaces/{workspace_id}/files/{file_id}

A file's details. Its content is downloaded through the file proxy.

Authorization

Authorizationstringheaderrequired

Bearer <key>, where <key> is a workspace API key or a user API key. See Authentication.

Path Parameters

workspace_id*integer

The workspace. List the ones your key can reach with GET /v1/workspaces.

file_id*string

The file.

Formatuuid

Query Parameters

region*Regions

Region of the file: besg (Europe) or usnv (United States)

Value in"besg""usnv"

Response Body

OK

application/json
  1. response

A file stored in the workspace (a knowledge base document, a genie attachment, an upload)

file_id*File Id
name*Name
mime_type*string|null
size_bytes*integer|null
tags*array<string>
source*string|null
source_ref*|

Id of the resource the file belongs to, null when it belongs to none

created_at*string|null
region*Region
Get a file
curl -X GET 'https://api.stacksync.com/v1/workspaces/0/files/497f6eca-6276-4993-bfeb-53cbbbba6f08?region=besg'
{  "file_id": "<file_id>",  "name": "<name>",  "mime_type": "<mime_type>",  "size_bytes": 0,  "tags": [    "<tags>"  ],  "source": "<source>",  "source_ref": "<source_ref>",  "created_at": "<created_at>",  "region": "<region>"}