File Uploads & Downloads

Files are attached to an existing record. Upload with uploadFile(), keep the returned file id, and call getFileUrl() with that id whenever you need a download link.

requestFileUpload() is deprecated. The endpoint it called never existed, so it never succeeded; it now rejects with a HaspSDKError without sending a request. Use uploadFile().

uploadFile(entityKey, recordId, file, signal?)

Uploads a File (or Blob) and attaches it to the record. The SDK sends it to the Data API as multipart/form-data; the file is scanned for malware before it is stored.

const file = await sdk.uploadFile('expenses', recordId, input.files[0]);
// file.id                — pass to getFileUrl() to download it later
// file.originalFilename  — file name as uploaded
// file.mimeType          — MIME type detected by the server
// file.byteSize          — size in bytes
// file.created_at        — ISO 8601 upload timestamp

The record must already exist — create it first with createRecord(), then upload. Nothing links the file to a particular field, so store file.id on the record yourself if you need to find the file again:

async function attachReceipt(recordId, file) {
  const uploaded = await sdk.uploadFile('expenses', recordId, file);
  await sdk.updateRecord('expenses', recordId, { receipt_file_id: uploaded.id });
}

Upload errors

Code	When
`ErrorCode.AttachmentTooLarge`	The file exceeds your plan’s single-attachment limit
`ErrorCode.AttachmentStorageLimitExceeded`	The upload would exceed your organization’s attachment storage limit
`ErrorCode.MalwareDetected`	The file failed malware scanning and was not stored
`ErrorCode.ValidationFailed`	No file was sent, or it exceeds the 100 MB transport ceiling
`ErrorCode.NotFound`	The record does not exist

All are HTTP 422 except NOT_FOUND (404). See Error Handling.

getFileUrl(fileId, signal?)

Returns a presigned download URL for a file, plus the file’s metadata.

const file = await sdk.getFileUrl(record.receipt_file_id);
// file.id                — the file ID
// file.url               — presigned download URL (valid for one hour)
// file.originalFilename  — file name as uploaded
// file.mimeType          — MIME type detected by the server
// file.byteSize          — size in bytes
// file.expiresAt         — ISO 8601 timestamp when `url` expires

Opening the file in a new tab:

const file = await sdk.getFileUrl(record.receipt_file_id);
window.open(file.url, '_blank');

Triggering a download:

const file = await sdk.getFileUrl(record.receipt_file_id);
const a = document.createElement('a');
a.href = file.url;
a.download = file.originalFilename ?? 'download';
a.click();

The presigned URL is valid for one hour (expiresAt). Do not cache it long-term — call getFileUrl again if you need a fresh URL.

Limits

The maximum single-file size and total attachment storage depend on your plan — see Limits.

AI Studio

Platform

AI API

Data API

App Builder SDK

File Uploads & Downloads

uploadFile(entityKey, recordId, file, signal?)

Upload errors

getFileUrl(fileId, signal?)

Limits

​uploadFile(entityKey, recordId, file, signal?)

​Upload errors

​getFileUrl(fileId, signal?)

​Limits

uploadFile(entityKey, recordId, file, signal?)

Upload errors

getFileUrl(fileId, signal?)

Limits