JS API clients handle uploads and file operations by wrapping Uploadcare Upload API and REST API. You can use it from within your Node.js app and in a browser.
Uploading (Upload API):
File management (REST API):
Image processing (URL API):
Node.js 16 or later.
To access the Upload Client High-Level API, you need to create an instance of UploadClient
providing the necessary settings. Specifying YOUR_PUBLIC_KEY is mandatory. It
points to the specific Uploadcare project:
Once the UploadClient instance is created, you can start using the wrapper to upload files from binary data:
Note: The
storeoption acceptstrue,false, or"auto". String values like"true"or"false"are not accepted.
To upload files securely, use the @uploadcare/signed-uploads package:
Use Queue to control concurrency when uploading multiple files:
For server-side usage, use UploadcareSimpleAuthSchema:
Note: Never use
UploadcareSimpleAuthSchemaon the client side — it exposes your secret key. For client-side usage, useUploadcareAuthSchemawith asignatureResolverthat delegates signing to your backend. For client-side usage:
Use the paginate helper to iterate through all pages of results:
Convert video and document files using the unified convert API:
Read the full documentation on JS API clients GitHub.