Start a new job

Start a new model swap batch processing job for the authenticated user. A maximum of 10 images can be processed in a single batch.

Authorization

token_auth

AuthorizationBearer <token>

Token-based authentication using access tokens.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

identity_code*Identity Code

The original identity code to swap over the images.

project_id*Project Id

The project identifier where images are stored.

images*array<string>

List of image UUIDs to be processed.

Itemsitems <= 10

post_process?Post Process

Enables or disables post processing for all images in the batch.

Defaultfalse

swap_options?

Default{}

review_config?|

Optional review configuration. If provided, creates a review pipeline for this job. Fields: requires_review (bool), default_reviewer_type (str), default_retouch_method (str), auto_approve_threshold (float).

Defaultnull

Response Body

`application/json`

curl -X POST "https://v2.api.piktid.com/model-swap" \  -H "Content-Type: application/json" \  -d '{    "identity_code": "string",    "project_id": "string",    "images": [      "string"    ]  }'

{
  "job_id": "string",
  "status": "string",
  "message": "string"
}

{
  "error": "Invalid request",
  "detail": [
    {
      "field": null,
      "message": "string",
      "position": "query"
    }
  ]
}

Empty

Start a new job

Authorization

Request Body

Response Body

200application/json

400application/json

402

403

404

429

`application/json`

`application/json`