Skip to main content

Getting Started Overview

Welcome to JsonCut! This guide will help you understand the basics of our API and get you processing media in minutes.

What is JsonCut?​

JsonCut is a comprehensive media processing API that allows you to:

  • Process Images: Create, edit, and transform images programmatically
  • Generate Videos: Convert images to videos, add effects and transitions
  • Manage Files: Upload, organize, and serve media assets
  • Track Jobs: Monitor processing status with real-time updates
  • Integrate Anywhere: Use API keys for seamless integration

API Architecture​

JsonCut follows RESTful principles with these core concepts:

🔐 Authentication​

All requests require an API key passed in the x-api-key header.

📁 Files​

Upload and manage your media assets (images, videos, audio).

🎯 Jobs​

Processing tasks that transform your media according to your specifications.

Processing Flow​

Here's how a typical workflow works:

JsonCut Processing Flow

  1. Upload your source files (images, videos, audio)
  2. Create a processing job with your configuration
  3. Monitor job status via API polling
  4. Download the processed result

Next Steps​

🔑 Authentication

Set up your API key and make your first authenticated request.

Learn about authentication →

⚡ Quick Start

Follow our step-by-step guide to process your first media file.

Start the tutorial →

⚡ Rate Limits & Tokens

Understand API limits, token usage, and pricing for production use.

View limits & tokens →

📖 API Reference

Explore all available endpoints and their parameters.

Browse API docs →

Common Questions​

What file formats are supported?​

  • Images: JPEG, PNG, WebP, GIF
  • Videos: MP4, MOV
  • Audio: MP3, WAV, M4A

How long do jobs take to process?​

Processing time varies based on complexity:

  • Simple images: 2-10 seconds
  • Complex images with multiple layers: 10-30 seconds
  • Short videos (< 30s): 30-90 seconds
  • Longer videos: 2-5 minutes per minute of output

Are there file size limits?​

Yes, current limits are:

  • Input files: 100MB maximum
  • Images: 4096x4096 pixels maximum
  • Videos: 4K resolution maximum, 5 minutes maximum duration

How do I handle errors?​

The API returns standard HTTP status codes:

  • 200: Success
  • 400: Bad request (check your parameters)
  • 401: Unauthorized (check your API key)
  • 429: Rate limited (slow down your requests)
  • 500: Server error (contact support)

All error responses include a JSON object with details:

{
  "error": "validation_error",
  "message": "Image width exceeds maximum limit of 4096 pixels"
}

Ready to get started? Let's set up your authentication! 🚀