API reference

Attachments

3 operations, generated from the OpenAPI document.

Announce a file for an attachment field and get a presigned PUT for it

POST /api/tables/{tableId}/attachments

Access: attachment:create on the table (see ACTIONS for the minimum role); personal access tokens need data.records:write.

Parameters

NameInTypeRequired
tableIdpathstringyes

Request body

  • fieldId string (uuid)
  • viewId string (uuid)
  • filename string required
  • type string | ""
  • size integer required

Responses

  • 201 Success
    • attachment object required
      • id string required
      • filename string required
      • size integer required
      • type string required
      • width integer
      • height integer
    • upload object required
      • method "PUT" required
      • url string (uri) required
      • headers object required
      • expiresAt string (date-time) required
  • 401 Not signed in
  • 403 Signed in, but the role is too low
  • 404 No such resource, or no access to it
  • 422 The request failed validation
  • 429 Too many requests: a rate limit was reached (see Retry-After)

Confirm an upload: the stored object must match the announced size

POST /api/tables/{tableId}/attachments/{attachmentId}/confirm

Access: attachment:create on the table (see ACTIONS for the minimum role); personal access tokens need data.records:write.

Parameters

NameInTypeRequired
tableIdpathstringyes
attachmentIdpathstring (uuid)yes

Responses

  • 200 Success
    • id string required
    • filename string required
    • size integer required
    • type string required
    • width integer
    • height integer
  • 401 Not signed in
  • 403 Signed in, but the role is too low
  • 404 No such resource, or no access to it
  • 429 Too many requests: a rate limit was reached (see Retry-After)

The workspace's stored files and bytes

GET /api/workspaces/{workspaceId}/storage

Access: workspace:read on the workspace (see ACTIONS for the minimum role); personal access tokens need schema.bases:read.

Parameters

NameInTypeRequired
workspaceIdpathstringyes

Responses

  • 200 Success
    • workspaceId string (uuid) required
    • files integer required
    • bytes integer required
  • 401 Not signed in
  • 403 Signed in, but the role is too low
  • 404 No such resource, or no access to it
  • 429 Too many requests: a rate limit was reached (see Retry-After)