Skip to main content
Browse docs

Files API

5 endpoints — authenticate with a workspace access token via Authorization: Bearer. See the API introduction for base URLs, pagination, and rate limits.

Create File

POST/api/files/

Initiate a file upload by requesting pre-signed URLs. **Scopes**: `files:write`

Returns 201 with FileUpload.

curl -X POST \
  https://api.rapidly.tech/api/files/ \
  -H "Authorization: Bearer $RAPIDLY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

List Files

GET/api/files/

List files. **Scopes**: `files:read` `files:write`

Query parameters

workspace_idstring | string[] | null

Filter by workspace ID.

idsstring | string[] | null

Filter by file ID.

pageinteger

Page number, defaults to 1.

limitinteger

Size of a page, defaults to 10. Maximum is 100.

Returns 200 with PaginatedList_FileRead_.

curl -X GET \
  https://api.rapidly.tech/api/files/ \
  -H "Authorization: Bearer $RAPIDLY_ACCESS_TOKEN"

Complete File Upload

POST/api/files/{id}/uploaded

Mark a file upload as completed. **Scopes**: `files:write`

Path parameters

idstringrequired

The file ID.

Request body FileUploadCompleted

idstringrequired

Id

pathstringrequired

Path

partsS3FileUploadCompletedPart[]required

Parts

Returns 200 with object.

curl -X POST \
  https://api.rapidly.tech/api/files/{id}/uploaded \
  -H "Authorization: Bearer $RAPIDLY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Update File

PATCH/api/files/{id}

Update a file. **Scopes**: `files:write`

Path parameters

idstringrequired

The file ID.

Request body FilePatch

namestring | null

Name

versionstring | null

Version

Returns 200 with object.

curl -X PATCH \
  https://api.rapidly.tech/api/files/{id} \
  -H "Authorization: Bearer $RAPIDLY_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Delete File

DELETE/api/files/{id}

Delete a file. **Scopes**: `files:write`

Path parameters

idstringrequired

Returns 204 with unknown.

curl -X DELETE \
  https://api.rapidly.tech/api/files/{id} \
  -H "Authorization: Bearer $RAPIDLY_ACCESS_TOKEN"