RESTful API

API Integration

Integrate On-Model directly into your workflow with our simple REST API. Process thousands of images programmatically.

Simple authentication, straightforward endpoints—get started in minutes.

example.py
import requests

headers = {"Authorization": "Bearer YOUR_TOKEN"}

# Create flat-lay to on-model job
resp = requests.post("https://v2.api.piktid.com/flat-2-model",
    headers=headers, json={
        "identity_code": "id_xyz",
        "project_id": "proj_123"})

print(f"Job ID: {resp.json()['job_id']}")

Integration in 4 Steps

01

Get API Token

Generate your API token from the dashboard.

02

Upload Assets

Upload images and model identities.

03

Submit Job

Call the processing endpoint.

04

Retrieve Results

Poll and download processed images.

Available Endpoints

Base URL: https://v2.api.piktid.com

POST
/flat-2-model

Transform flat-lay images into on-model photography

POST
/model-swap

Replace model identities in product images

POST
/identity/upload

Upload a new model identity

POST
/upload

Upload product images for processing

GET
/jobs/{job_id}/results

Retrieve processed images

POST
/download

Generate ZIP for bulk download

API Features

Bearer Authentication

Secure token-based auth with automatic refresh.

Parallel Processing

Submit multiple images in a single request.

Multiple Formats

JPG or PNG at 1K, 2K, or 4K resolution.

Reproducible Results

Use seed values for consistent outputs.

Webhooks

Get notified when jobs complete.

Bulk Download

Download results as a single ZIP file.

Ready to Integrate?

Get your API token and start building. Full documentation available.