Files

Tags: files, storage

Endpoints

• GET - List
• POST - Create
• POST /upload-url - Upload Url
• GET /{file_id} - Get File Id
• PUT /{file_id} - Update File Id
• POST /{file_id}/convert - Convert

List

GET /api/v2/w/{workspace_uuid}/files

Description:

File upload and management

List all files for the authenticated user.

Authorization: Requires files:read scope

Parameters:

• folder_id (Integer)
• page (Integer)
• pageSize (Integer)
• sortBy (FileSortField)
• sortOrder (SortOrder)
• search (String)

Response: See PaginatedResponse[FileResponse]

---

Create

POST /api/v2/w/{workspace_uuid}/files

Description:

File upload and management

Create a new file.

Authorization: Requires files:write scope

Parameters:

• file (CreateFileRequest)

---

Upload Url

POST /api/v2/w/{workspace_uuid}/files/upload-url

Description:

File upload and management

Generate a presigned URL for uploading a file.

Authorization: Requires files:write scope

Parameters:

• file_request (FileUploadRequest)

Response: See FileUploadResponse

---

Get File Id

GET /api/v2/w/{workspace_uuid}/files/{file_id}

Description:

File upload and management

Get a specific file by ID.

Authorization: Requires files:read scope

Parameters:

• file_id (Integer)

---

Update File Id

PUT /api/v2/w/{workspace_uuid}/files/{file_id}

Description:

File upload and management

Update an existing file.

Authorization: Requires files:write scope

Parameters:

• file_id (Integer)
• file (UpdateFileRequest)

---

Convert

POST /api/v2/w/{workspace_uuid}/files/{file_id}/convert

Description:

File upload and management

Convert a file to various formats.

Returns: A ConvertedFileResponse containing the converted content and file metadata.

Authorization: Requires files:read scope

Parameters:

• file_id (Integer)
• format (Literal['text', 'markdown', 'pdf'])

Response: See ConvertedFileResponse

---