FileUploadsAPI
Defined in: src/api/fileUploads.api.ts:35
FileUploads API client for uploading files to Notion.
Extends
Section titled “Extends”BaseAPI<NotionFileUpload,FileUpload>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new FileUploadsAPI(
client):FileUploadsAPI
Defined in: src/api/fileUploads.api.ts:41
Parameters
Section titled “Parameters”client
Section titled “client”NotionClient
Returns
Section titled “Returns”FileUploadsAPI
Overrides
Section titled “Overrides”BaseAPI<NotionFileUpload, FileUpload>.constructor
Methods
Section titled “Methods”complete()
Section titled “complete()”complete(
completeUrl):Promise<FileUpload>
Defined in: src/api/fileUploads.api.ts:118
Complete the file upload after uploading to the URL.
Parameters
Section titled “Parameters”completeUrl
Section titled “completeUrl”string
The complete URL from initiate()
Returns
Section titled “Returns”Promise<FileUpload>
The completed file upload object
https://developers.notion.com/reference/complete-a-file-upload
initiate()
Section titled “initiate()”initiate(
options):Promise<FileUpload>
Defined in: src/api/fileUploads.api.ts:53
Initiate a file upload and get the upload URL.
Parameters
Section titled “Parameters”options
Section titled “options”InitiateFileUploadOptions
File metadata (filename, content type, size)
Returns
Section titled “Returns”Promise<FileUpload>
The file upload object with upload URL
https://developers.notion.com/reference/create-a-file-upload
retrieve()
Section titled “retrieve()”retrieve(
fileUploadId):Promise<FileUpload>
Defined in: src/api/fileUploads.api.ts:193
Get the status of a file upload.
Parameters
Section titled “Parameters”fileUploadId
Section titled “fileUploadId”string
The ID of the file upload
Returns
Section titled “Returns”Promise<FileUpload>
The file upload object with current status
https://developers.notion.com/reference/retrieve-a-file-upload
upload()
Section titled “upload()”upload(
uploadUrl,fileData,contentType,partNumber?):Promise<void>
Defined in: src/api/fileUploads.api.ts:78
Upload file data to the upload URL from initiate(). Sends multipart/form-data
through the configured NotionClient.
Parameters
Section titled “Parameters”uploadUrl
Section titled “uploadUrl”string
The upload URL from initiate()
fileData
Section titled “fileData”FileData
The file data to upload
contentType
Section titled “contentType”string
The MIME type of the file
partNumber?
Section titled “partNumber?”number
The 1-based part number, for a multi-part upload of a file larger than 20 MB. Pass a positive integer.
Returns
Section titled “Returns”Promise<void>
Throws
Section titled “Throws”If partNumber is not a positive integer.
Throws
Section titled “Throws”If the upload endpoint returns an error response.
https://developers.notion.com/reference/upload-file
uploadFile()
Section titled “uploadFile()”uploadFile(
filename,fileData,contentType):Promise<FileUpload>
Defined in: src/api/fileUploads.api.ts:155
Helper method to upload a file in one call. This combines initiate, upload, and complete steps.
Parameters
Section titled “Parameters”filename
Section titled “filename”string
The filename
fileData
Section titled “fileData”FileData
The file data
contentType
Section titled “contentType”string
The MIME type
Returns
Section titled “Returns”Promise<FileUpload>
The completed file upload object