Documentation

Developer Resources

Everything you need to integrate ImgNodus into your applications. From REST APIs to framework-specific SDKs.

Introduction

ImgNodus provides a powerful, nodal-based image processing engine accessible via REST. Our infrastructure is built for speed, global delivery (CDN), and automatic AI-powered optimization.

Authentication

Authenticate your requests by including your secret API key in the Authorization header.

API Key Header
Authorization: Bearer IR_KEY_xxxxxxxxxxxxxxxx
Security Warning: Never share your API key in client-side code. Use environment variables in your backend or Netlify functions.

Upload Image

POST /v1/upload

Upload a raw image file. The engine will automatically convert it to WebP and return a secure CDN URL.

Parameters

NameTypeDescription
fileBinaryThe image file (Max 5MB).
folderString(Optional) Target folder in your storage.
JavaScript Example
const formData = new FormData();
formData.append('image', fileInput.files[0]);

const res = await fetch('https://api.imgnodus.com/v1/upload', {
    method: 'POST',
    headers: { 'Authorization': 'Bearer YOUR_KEY' },
    body: formData
});

List Assets

GET /v1/images

Retrieve a list of all uploaded images and their metadata.

Browse Assets
const res = await fetch('https://api.imgnodus.com/v1/images', {
    headers: { 'Authorization': 'Bearer YOUR_KEY' }
});
const data = await res.json();

Delete Asset

DELETE /v1/images/{id}

Permanently remove an image from your storage and purge the CDN cache.

Delete Operation
await fetch('https://api.imgnodus.com/v1/images/img_98234', {
    method: 'DELETE',
    headers: { 'Authorization': 'Bearer YOUR_KEY' }
});
VIDEO VDN v1.0 ACTIVE

Video Infrastructure

The ImgNodus Video VDN (Video Delivery Network) is a specialized engine for high-bandwidth assets. Unlike the Image API, it uses the Appwrite NYC Storage cluster paired with Cloudflare Workers for global edge delivery.

Key Difference: Video endpoints are located on a separate high-bandwidth cluster in the US-East (New York) region to support streaming and 500MB+ files.

Video Upload

POST https://nyc.cloud.appwrite.io/.../files

Videos must be uploaded directly to the NYC storage bucket using your Appwrite Project ID and Secret API key from the dashboard.

Video Stream (cURL)
curl -X POST https://nyc.cloud.appwrite.io/v1/storage/buckets/69de2e01002d45c83374/files \
     -H "X-Appwrite-Project: [PROJECT_ID]" \
     -H "X-Appwrite-Key: [API_KEY]" \
     -F "file=@my-video.mp4"

Dynamic VDN Delivery

Always deliver video assets through our VDN proxy to benefit from aggressive edge caching and optimized peering.

Standard VDN Format:

https://video.imgnodus.com/v1/view/69de2e01002d45c83374/{asset_id}

Auto WebP Optimization

ImgNodus converts all uploads to WebP by default. To request a specific format on delivery, append the format parameter to the CDN URL.

WebP offers up to 80% reduction in file size without quality loss compared to JPEG/PNG.

https://cdn.imgnodus.com/image.webp?format=webp

On-the-fly Resizing

Dynamic resizing is handled via URL parameters. ImgNodus processes these on the edge for maximum performance.

  • w: Target width in pixels.
  • h: Target height in pixels.
  • crop: center, top, bottom.
Dynamic URL
https://cdn.imgnodus.com/asset.webp?w=400&h=300&crop=center

Node.js SDK

The official Node.js package simplifies image management with a promise-based client.

npm install @imgnodus/sdk

Example Usage

const ImgNodus = require('@imgnodus/sdk');
const client = new ImgNodus({ apiKey: 'YOUR_KEY' });

const result = await client.upload(fs.createReadStream('./img.png'));
console.log(result.url);

React SDK

Our React component provides an all-in-one UI for uploads with progress tracking.

npm install @imgnodus/react
React Component
import { ImgNodusUpload } from '@imgnodus/react';

function MyComponent() {
  return (
     console.log(url)} 
      folder="profile_pics" 
    />
  );
}

Netlify & Deployment

Deploying to Netlify? Store your API key in the Netlify dashboard under Site Settings > Build & Deploy.

Pro-tip: Use the IMGNODUS_API_KEY environment variable for seamless deployment.

Guided Tutorial

Follow our comprehensive guide to build a fully optimized image gallery using ImgNodus and React.

Start Tutorial