Virtual Try-On API Documentation

Overview

Generate a realistic preview of a person wearing a specific garment from a product image - no physical samples required.

Primary Endpoint

POST/api/v1/virtualTryOn/start

Start a virtual try-on task with clothing images on person photos. ### Request - Send a valid bearer token. The server evaluates the operation in the authenticated caller's access context. - Send an `application/json` body. Required fields: `image_urls`. - API-token callers may include `webhook_url` and `webhook_token` for best-effort terminal-state notifications; ordinary JWT/cookie calls ignore these fields. ### Behavior - This is an asynchronous operation: a successful submission creates a task and returns before processing finishes. - Persist the returned task identifier and use the corresponding detail or list operation to observe progress. - Treat the detail endpoint as the source of truth even when webhook delivery is enabled. ### Response - A `200` response confirms task acceptance; it does not by itself mean media generation has completed. - Retain the returned identifier and wait for a documented terminal status before using output URLs. - JSON object responses, including error responses, normally carry a top-level `trace_id` string for this request; include it when contacting support. It is not a task identifier. - Do not infer undocumented fields or statuses; clients should tolerate additional response properties. ### Errors - `400` — Bad Request - Invalid parameters. - `401` — Unauthorized - Invalid or missing JWT token. ### Related Operations - `GET /api/v1/virtualTryOn/allRecords` — Get all virtual try-on records. - `GET /api/v1/virtualTryOn/{_id}` — Get virtual try-on task detail. - `DELETE /api/v1/virtualTryOn/{_id}` — Delete virtual try-on task. Authentication: set header Authorization: Bearer <token> (supports user JWT or sk_ API token).

Request Parameters

Name	Type	Required	Description
name	string	No	Name of the virtual try-on task; default: ""
image_urls	array<string>	Yes	Array of 2 image URLs - [0] person image, [1] clothing image; minItems: 2; maxItems: 4
timeout	number	No	Processing timeout in seconds; default: 120
minor_suspected_skip	boolean	No	Set to true when retrying after error code 1004 to confirm and bypass the suspected-minor soft block.; default: false
webhook_url	string	No	HTTPS URL to receive task.completed / task.failed notifications. Best-effort delivery, single attempt, no retries; clients should treat the detail API as the source of truth.; maxLength: 2048
webhook_token	string	No	Optional plaintext token returned in the X-A2e-Webhook-Token header so receivers can verify the request originated from a2e.; maxLength: 256

Request schema and conditional rules

{
  "allOf": [
    {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the virtual try-on task",
          "default": "",
          "example": "Summer Dress Try-On"
        },
        "image_urls": {
          "type": "array",
          "minItems": 2,
          "maxItems": 4,
          "items": {
            "type": "string",
            "format": "uri",
            "pattern": "^https?://.*"
          },
          "description": "Array of 2 image URLs - [0] person image, [1] clothing image",
          "example": [
            "https://example.com/person.jpg",
            "https://example.com/dress.jpg"
          ]
        },
        "timeout": {
          "type": "number",
          "default": 120,
          "description": "Processing timeout in seconds",
          "example": 120
        },
        "minor_suspected_skip": {
          "type": "boolean",
          "default": false,
          "description": "Set to true when retrying after error code 1004 to confirm and bypass the suspected-minor soft block."
        }
      },
      "required": [
        "image_urls"
      ]
    },
    {
      "$ref": "#/components/schemas/WebhookInput"
    }
  ]
}

Response Fields

code: integer
data: object
data._id: string: Task ID
data.name: string: Task name
data.image_urls: array<string>: Input image URLs
data.current_status: string: Current task status
data.coins: number: Coins required for the task
data.createdAt: string: Task creation timestamp
trace_id: string: Trace ID of this HTTP request. Include it when contacting support about this request. It is generated per request and is not a task identifier; use the returned task `_id` to query results.

Request Example

curl -X POST "https://headswap.app/api/v1/virtualTryOn/start" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Summer Dress Try-On",
  "image_urls": [
    "https://example.com/person.jpg",
    "https://example.com/dress.jpg"
  ],
  "timeout": 120
}'