inkicaDOCS v2.0
Production Architecture • v2.0

Inkica API Documentation

Build production-ready apparel workflows with our unified REST API: extract 300 DPI master graphics, synthesize custom decaling, render real-time streaming multi-angle 7-shot catalog mockup decks, and automate prepress IP checks.

Basic Use Case: 3-Field API Call (Design + DNA + Prompt ➔ 7x Batch Photos)
POST /api/v1/external/batch-mockups

Here is the exact minimal payload to generate a photorealistic 7-shot commercial catalog deck by passing your Design Graphic, a Garment DNA Reference, and your Custom Strict Prompt:

1. graphicUrl (Design)

Your 300 DPI transparent PNG artwork to project onto the shirt.

2. dna1Url (Garment DNA)

Reference photo of desired garment silhouette & heavy cotton fabric drape.

3. prompt (Strict Prompt)

Custom photoshoot directive executed with exact colorways & lighting.

⭐ Image Ordering Convention: Which Image is DNA 1 vs DNA 2?

When developers provide 2 reference images (either via dna1Url / dna2Url or array dnaReferences: [img1, img2]), Inkica deterministically applies:

1st Image (Index 0) = DNA 1Garment Silhouette, fabric weight (240 GSM), collar ribbing & cloth folds.
2nd Image (Index 1) = DNA 2Lighting scheme, editorial background atmosphere & color grading.
Request Payload JSON
{
  "graphicUrl": "https://inkica.com/sample_art_300dpi.png",
  "dna1Url": "https://images.unsplash.com/photo-1521572267360-ee0c2909d518?w=800",
  "prompt": "Male model in Tokyo minimalist studio, 240 GSM heavy cotton oversized tee in Pitch Black (#18181B)",
  "productType": "oversized_tee",
  "count": 7,
  "stream": true
}
End-to-End Apparel Production Pipeline4-Step Automation
1Extract 4K Master Graphic

Send photoshoot photo to /extract to get clean 300 DPI transparent PNG with zero residual fabric dust.

2Auto Color & Palette

Call /auto-color (0 credits) to receive high-contrast harmonized garment fabric hex suggestions.

3Streaming 7-Shot Batch Deck

Call /batch-mockups with stream: true to receive images card-by-card in real time.

4IP Check & SEO Listing

Verify USPTO Class 025 trademark safety & generate Etsy tags, Amazon bullets, and TikTok copy in 1 click.

API Base URLhttps://ai-api.inkica.comProduction gateway with global CloudFront low-latency CDN routing.
Health & TelemetryGET /healthHeartbeat check for database, S3 storage, and GPU clusters.
Core Feature: Smart Mode vs. Raw Override Mode

All Inkica mockup endpoints support the smartEnhance parameter:

smartEnhance: true (Default)

Applies Inkica automated studio pipeline: authentic fabric displacement, micro-wrinkle shadows, natural highlight absorption, and curated commercial camera presets.

smartEnhance: false (Raw Override)

Strictly prioritizes client custom prompt, exact garmentColorHex, and custom scene specifications without AI template rewriting.

Quickstart Checklist3 Minutes Setup
1
Get API KeyCopy your key from Studio > Account Settings or use the test key below.
2
Pick EndpointSelect any function on the left sidebar to inspect parameters and run live test requests.
3
Streaming or Atomic JSONChoose between real-time SSE streaming (stream: true) or standard JSON response.
1-Click Streaming Batch Mockup Test
curl -N -X POST "https://ai-api.inkica.com/api/v1/external/batch-mockups" \
  -H "Content-Type: application/json" \
  -H "Accept: text/event-stream" \
  -H "X-API-Key: YOUR_API_KEY_HERE" \
  -d '{
                    "graphicUrl": "https://inkica.com/sample.png",
                    "count": 7,
                    "stream": true,
                    "productType": "oversized_tee"
                  }'