Overview Authentication Upload Endpoint Dynamic Variants Private Tickets Code SDKs Live Simulator FAQ

API Reference & Developer Guide

Everything you need to stream, optimize, and deliver digital media directly from your mobile apps, microservices, or frontend web frameworks.

Base API: https://assetdock.cybershoora.com/api/v1 Status: Operational 100% HTTP/2 · Edge CDN Caching · TLS 1.3

1. Quickstart & Architecture

AssetDock divides media management into two decoupled micro-operations: Storage Ingestion (deduplicating, checking quota, streaming binary) and Edge Transformation (stateless variant creation and immutable delivery).

Ingestion Endpoint

POST /api/v1/assets/upload

Accepts standard multipart form payloads. Returns asset metadata, unique UUID, SHA-256 checksum, and precomputed delivery URLs.

Delivery Endpoint

GET /media/{id}/variant/{preset}

Instant WebP/PNG streaming. Responses include Cache-Control: public, max-age=31536000, immutable and ETag validation.

2. Authentication

Authenticate all REST API requests by supplying your tenant API Key in the X-API-Key request header.

Example API Key (Public Sandbox) ad_live_00000000000000000000
HTTP Header Format
X-API-Key: ad_live_00000000000000000000
Accept: application/json
POST

/api/v1/assets/upload

Streams a binary asset into the tenant storage vault, verifies SHA-256 deduplication, and kicks off responsive variant generation.

Request Form Parameters

Field Type Required Description
file File (Binary) Yes Supported formats: JPEG, PNG, WEBP, GIF, SVG, PDF, MP4. Max 50 MB per request.
visibility String No public (default, cached on CDN) or private (requires signed download ticket).
tags String No Comma-separated indexing tags (e.g. profile,avatar,user_99).
folder String No Cloudinary-style folder routing (e.g. client_profiles, user_avatars). Automatically assigns or creates the project folder.
project_slug String No Assign asset to an existing workspace project (defaults to website-assets).

Sample JSON Response (201 Created)

application/json
{
  "success": true,
  "message": "Asset uploaded and processed successfully.",
  "data": {
    "id": "01a15e84-e08a-704d-bc84-5c6032ffd799",
    "display_name": "hero-banner",
    "original_name": "hero-banner.png",
    "url": "https://assetdock.cybershoora.com/media/01a15e84-e08a-704d-bc84-5c6032ffd799/hero-banner.png",
    "visibility": "public",
    "size_bytes": 102400,
    "formatted_size": "100 KB",
    "width": 1920,
    "height": 1080,
    "checksum_sha256": "c414cd0e204de974f73753c7e28d7638e7b3691bb8b1a2bab6b25bb7fed7ce77",
    "variants": {
      "avatar_128": "https://assetdock.cybershoora.com/media/01a15e84-e08a-704d-bc84-5c6032ffd799/variant/avatar_128",
      "thumb_320": "https://assetdock.cybershoora.com/media/01a15e84-e08a-704d-bc84-5c6032ffd799/variant/thumb_320",
      "medium_960": "https://assetdock.cybershoora.com/media/01a15e84-e08a-704d-bc84-5c6032ffd799/variant/medium_960"
    }
  }
}

4. Dynamic Transformations & Presets

No need to re-upload multiple sizes. Append the variant preset slug to any asset URL to get optimized WebP/PNG streaming.

1

profile_photo

400 × 400 px
/variant/profile_photo

1:1 square crop. Perfect for client profile photos, team rosters, and member avatars.

2

avatar_128

128 × 128 px
/variant/avatar_128

Square crop with focus preservation. Ideal for user profiles, navigation avatars, and list rows.

2

thumb_320

320 × 240 px
/variant/thumb_320

Aspect-ratio preserved thumbnail. Perfect for grid views, media pickers, and feed cards.

3

medium_960

960 × 640 px
/variant/medium_960

Retina-ready high definition. Engineered for product zooms, article hero headers, and modals.

4

Original Raw

Uncompressed
/media/{id}/{filename}

Direct master file streaming with bit-for-bit SHA-256 integrity.

POST

/media/download/ticket/{ticket}

For KYC records, PAN documents, invoices, and sensitive contracts. Private assets cannot be scraped or accessed directly without a cryptographically signed, time-limited ticket.

Generate Ticket via API
// 1. Request Download Ticket (valid for 15 minutes)
POST /assets/{asset_id}/ticket
Header: X-API-Key: ad_live_00000000000000000000

// 2. Response provides one-time temporary delivery URL
{
  "ticket": "tkt_live_99d8b12f6a7c41",
  "download_url": "https://assetdock.cybershoora.com/media/download/ticket/tkt_live_99d8b12f6a7c41",
  "expires_at": "2026-10-21T14:45:00Z"
}

6. Client Integration SDKs

Drop-in code snippets ready to copy and paste into your project codebase.

bash / terminal
curl -X POST "https://assetdock.cybershoora.com/api/v1/assets/upload" \
  -H "X-API-Key: ad_live_00000000000000000000" \
  -F "file=@/path/to/image.png" \
  -F "visibility=public" \
  -F "tags=avatar,profile"

7. Live Simulator Playground

Test your cURL syntax or upload a sample image right now to preview the real JSON payload and variant generation.

/ ASSETDOCK PIPELINE ARCHITECTURE

How Our API & Ingestion Model Works in Real-Time

Watch live bit-routing across our 5 architecture stages. Click any scenario button below or click on any node to see exact endpoints, controller actions, and database models.

1
Ingestion Gate POST /api/v1/assets/upload
2
SHA-256 Dedup AssetService::upload()
3
10 GB Quota Gate Tenant isolation lock
4
Variant Transcoder PHP 8.3 · WebP / PNG
5
Edge POP Delivery Immutable 31536000s
MODEL IDLE Ready. Select a scenario above or click 'Run API Request' to see our API model process media in real-time.
200 OK
1 cURL / Shell 2 Mobile SDK 3 Web Clients 4 REST API v1 5 Microservices 6 Playground 7 CDN Origin Raw Master SHA-256 0ms Dedup Link profile_photo 400x400 Face Crop Focus avatar_128 Square 1:1 Square Ratio avatar_64 Micro Nav Pill Icon thumb_320 WebP Responsive Feed thumb_480 Grid Masonry Tile medium_960 Retina Product Zoom medium_1200 Article Hero Header large_1600 Banner Desktop Canvas large_2048 2K Ultra HiDPI Retina lossless_png Master Alpha Channel optimized_webp 85% Compression progressive_jpeg Interlaced Pass avif_nextgen 10bit HDR Color Gamut download_ticket HMAC 15min Time-Bomb private_vault_token Signed Token edge_pop_sin1 Asia 12ms Edge Latency edge_pop_lhr1 Europe 18ms Edge Latency edge_pop_iad1 US East 22ms Edge Latency cache_immutable_1y 31536000s Immutable etag_verified_304 Byte-for-Byte SHA dedup_sha256_match Zero Re-upload pan_quota_isolated KYC PAN Gate cors_header_unlocked Cross-Origin OK AssetDock Vault Core

8. Frequently Asked Questions

Direct answers designed for software architects, engineering leads, and AI overview search models.

What makes AssetDock different from Cloudinary?

AssetDock is a self-hosted, private-first platform. You retain 100% data ownership of all raw and transformed assets, pay zero opaque egress bandwidth penalties, and benefit from KYC PAN enterprise tenant isolation.

How does edge CDN caching work?

All public media responses ship with Cache-Control: public, max-age=31536000, immutable and cryptographically strong ETags. Once an asset or variant is requested, global POP nodes cache it indefinitely until purged.

Can I upload from Flutter and React Native?

Yes. The REST upload API uses standard HTTP multipart requests. You can upload directly using standard HTTP clients or use our copyable Flutter and JavaScript code kits.

How is SHA-256 deduplication performed?

During upload reservation, AssetDock computes the SHA-256 digest of the incoming stream. If an identical file already exists in your workspace, AssetDock links the record instantly without wasting disk quota or CPU cycles.