Skip to content

Files

Get File

Get a single file’s metadata by ID.

Requires membership in the organization.

Parameters

NameInTypeRequiredDescription
file_idpathstring (uuid)yes
org_idpathstring (uuid)yes

Responses

StatusDescriptionBody
200Successful ResponseFileDetailResponse
422Validation ErrorHTTPValidationError

GET /api/orgs/{org_id}/files/{file_id}/download

Section titled “GET /api/orgs/{org_id}/files/{file_id}/download”

Download File

Download a file (forces a native browser download).

Requires membership in the organization.

Parameters

NameInTypeRequiredDescription
file_idpathstring (uuid)yes
org_idpathstring (uuid)yes

Responses

StatusDescriptionBody
200Successful Responseobject
422Validation ErrorHTTPValidationError

GET /api/orgs/{org_id}/files/{file_id}/view

Section titled “GET /api/orgs/{org_id}/files/{file_id}/view”

View File

Serve a file inline so it renders in a browser tab / iframe / img.

Identical to /download but uses Content-Disposition: inline.

Requires membership in the organization.

Parameters

NameInTypeRequiredDescription
file_idpathstring (uuid)yes
org_idpathstring (uuid)yes

Responses

StatusDescriptionBody
200Successful Responseobject
422Validation ErrorHTTPValidationError