Skip to main content

Documentation

Home Getting Started User Guides API Reference Image Processing Integration Guides Best Practices Resources Support AI Integration Playground URL Builder

Developers Documentation

Getting Started
Welcome to VIUCraft Documentation

Welcome to the VIUCraft documentation portal. Find everything you need to get started with our platform.

Roadmap
Roadmap

Upcoming features and improvements

Development Tools
Development Tools

CLI, SDKs, and developer utilities

Image Optimization
Image Optimization

Format selection and compression

Performance
Performance

Caching strategies and CDN usage

Security
Security

Securing image assets

SEO
SEO

Image optimization for search engines

Accessibility
Accessibility

Making images accessible

FAQs
FAQs

Common questions and answers

Glossary
Glossary

Definition of technical terms

Changelogs
Changelogs

Platform updates and new features

Quick Start Guides
Quick Start Guides

Fast implementation paths for common use cases

Case Studies
Case Studies

Real-world implementation examples

Contact Options
Contact Options

How to reach support

Community Forums
Community Forums

User discussions

Troubleshooting
Troubleshooting

Common issues and resolutions

Feature Requests
Feature Requests

Suggesting new capabilities

AI Integration
AI Prompts for VIUCraft

Curated prompts you can copy and paste into any AI coding assistant.

Getting Started
Quickstart

Zero to a working transformed image in minutes — curl and SDK, with a real response body and a copy-paste agent recipe (whoami → upload → URL → delete).

CMS Integration
CMS Integration

WordPress, Drupal, etc.

Overview
Overview

Platform introduction and key concepts

Account Setup
Account Setup

Registration, plan selection, and initial configuration

Tutorials
Tutorials

Step-by-step guides for first-time users

Authentication
Authentication

API keys and security

Endpoints
Endpoints

Complete endpoint documentation

Error Codes
Error Codes

Explanation of error responses

Rate Limiting
Rate Limiting

Understanding usage limits

HTTP Status Codes
HTTP Status Codes

API response codes

Color Adjustments
Color Adjustments

Brightness, contrast, gamma, saturation, hue, colorize, tint, invert, grayscale, sepia, and auto-enhance

Effects
Effects

Blur, sharpen, edge detect, emboss, median filter, vignette, noise, and pixelate

Transform & Decoration
Transform & Decoration

Rotate, flip, border, text watermark, tiled watermark, and SVG overlay

Output Controls
Output Controls

Quality, metadata stripping, LQIP placeholder generation, and responsive srcset

URL Syntax
URL Syntax

Standard and short format URL instructions for all operations

Web Frameworks
Web Frameworks

Integration with popular frameworks

Mobile Platforms
Mobile Platforms

Android and iOS implementation

Resize & Crop
Resize & Crop

Resize, crop, thumbnail, and smart crop operations with dimension controls and crop strategies

E-commerce Platforms
E-commerce Platforms

Shopify, WooCommerce, etc.

Getting Started
Getting Started with AI

Get VIUCraft integrated in your project in under 5 minutes using your AI coding assistant.

API Reference
Tenancy & URL Bases

Every VIUCraft request uses your tenant subdomain. How paid and free-tier URL bases work, and how to discover your own.

API Reference
Upload Response Reference

Field-by-field reference for the upload 201 response: image_id is the permanent handle, filename is not, plus the duplicate (200) variant.

API Reference
Delivery & Transform URL Grammar

The complete delivery/transform URL grammar: mandatory extension, subdomain and free-tier shapes, long vs short operation forms, and worked examples.

API Reference
API Endpoint Map

The base-path split: upload and delivery at the root, management under /api/, CLI under /api/v1/cli/, agents at /mcp.

API Reference
Rate Limits & Retries

Rate-limit headers, the 429 response body, Retry-After semantics, and how the SDK retries automatically.

API Reference
Batch Jobs & Webhooks

Asynchronous batch processing with live SSE progress, and webhook subscriptions for image and batch events.

API Reference
API Versioning & Deprecation Policy

How the API is versioned (dated 2025-01), what counts as a breaking change, and the deprecation timeline.

Official SDK

Typed JavaScript/TypeScript client — zero dependencies:

npm install viucraft
Popular Topics