Node.js / TypeScript

Upload files, manage folders, and call the full Autorender API from your Node.js or TypeScript server.

The @autorender/nodejs SDK is the official server-side client for Node.js and TypeScript. Use it to upload files, list and manage files and folders, run multipart uploads, and call the Autorender API from your backend.

Prerequisites

• An Autorender account with an API key — create one in the dashboard
• Node.js 18 or later

Guide

1. Install the package.

   npm

   npm install @autorender/nodejs
   

   yarn add @autorender/nodejs
   

   pnpm add @autorender/nodejs
   

   bun add @autorender/nodejs
   
2. Set your API key.

   Create an API key in the dashboard and set it as an environment variable:

   export AUTORENDER_API_KEY=your-api-key
   
3. Upload a file.

   Create a client and upload your first file. The client reads AUTORENDER_API_KEY from the environment — never hardcode the key.

   import Autorender from '@autorender/nodejs';
   import fs from 'fs';
   
   const client = new Autorender({
     apiKey: process.env.AUTORENDER_API_KEY,
   });
   
   const upload = await client.uploads.create({
     file: fs.createReadStream('products/chair.jpg'),
     file_name: 'chair.jpg',
   });
   
   console.log(upload.file_no); // e.g. "fi_abc123"
   console.log(upload.url);     // CDN URL
   

Examples

Upload from URL

const upload = await client.uploads.createFromURL({
  remote_url: 'https://acme-assets.s3.amazonaws.com/products/chair.jpg',
});

List files

const result = await client.files.list({ limit: 10 });

for (const file of result.files) {
  console.log(file.file_no, file.name, file.url);
}

Get file details

const file = await client.files.retrieve('fi_abc123');
console.log(file.data.url);

Rename a file

await client.files.rename('fi_abc123', { name: 'new-name' });

Delete a file

await client.files.delete('fi_abc123');

Folders

// List folders
const { folders } = await client.folders.list();

// Create a folder
const folder = await client.folders.create({ name: 'products' });

// Rename a folder
await client.folders.rename(folder.data.folder_no, { name: 'product-images' });

// Delete a folder
await client.folders.delete(folder.data.folder_no);

Multipart upload

For files larger than 100 MB, use a multipart upload to split the file into parts:

import fs from 'fs';

const fileBuffer = fs.readFileSync('large-video.mp4');

// Start session
const session = await client.multipartUploads.start({
  file_name: 'large-video.mp4',
  file_size: fileBuffer.length,
});

// Upload parts
const partRes = await fetch(session.parts[0].url, {
  method: 'PUT',
  body: fileBuffer,
});
const etag = partRes.headers.get('etag')!;

// Complete
const result = await client.multipartUploads.complete({
  upload_id: session.upload_id,
  parts: [{ part_number: 1, etag }],
});

Error handling

import Autorender from '@autorender/nodejs';

try {
  const file = await client.files.retrieve('fi_notexist');
} catch (err) {
  if (err instanceof Autorender.APIError) {
    console.log(err.status);  // 404
    console.log(err.message);
  }
}

Resources

• npm package
• GitHub
• API reference

Next steps

Direct upload API

The upload endpoint this SDK calls.

Create an API key

Generate the key the client reads from the environment.

Image transformations

Build delivery URLs from your uploaded files.

All SDKs

Server-side clients for every language.