> ## Documentation Index
> Fetch the complete documentation index at: https://developer.whilter.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Virtual Tryon Request

> Create Virtual Tryon Request



## OpenAPI

````yaml POST /vton/request
openapi: 3.0.1
info:
  title: Charp.ai API
  description: >-
    API ecosystem for vendor management, authentication, campaign management,
    and tools for enhancing campaign execution including realtime media
    generation
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://whilter-api-host
security:
  - bearerAuth: []
tags:
  - name: Authentication
    description: Operations related to API authentication
  - name: Realtime Media
    description: Operations for generating personalized videos in real-time
  - name: Webhooks
    description: Webhook endpoints for receiving notifications
  - name: Virtual Try-On
    description: Operations related to virtual try-on functionality
  - name: Tasks
    description: Operations related to task management
paths:
  /vton/request:
    post:
      tags:
        - Virtual Try-On
      description: Create Virtual Tryon Request
      requestBody:
        description: Virtual Tryon request parameters
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VirtualTryonRequest'
        required: true
      responses:
        '200':
          description: Virtual Tryon request created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VirtualRequestResponse'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    VirtualTryonRequest:
      type: object
      properties:
        user-id:
          type: string
          description: User phone number or ID
        client-id:
          type: string
          description: Client ID provided during vendor onboarding
        usecase-id:
          type: string
          description: Usecase ID provided during vendor onboarding
        model-image:
          type: string
          format: uri
          description: URL of the model image
        garment-image:
          type: array
          format: uri
          description: URL of the garment image
        category:
          type: string
          description: Category of garments
          enum:
            - auto
            - tops
            - bottoms
            - one-pieces
          default: auto
        mode:
          type: string
          description: Speed vs quality preset
          enum:
            - balanced
            - performance
            - quality
          default: balanced
        moderation_level:
          type: string
          description: Content safety filter
          enum:
            - conservative
            - permissive
            - none
          default: permissive
        segmentation_free:
          type: boolean
          description: Skip clothing removal
        output_format:
          type: string
          description: Image encoding for output
          enum:
            - png
            - jpeg
          default: png
      required:
        - user-id
        - client-id
        - usecase-id
        - model-image
        - garment-image
        - category
    VirtualRequestResponse:
      type: object
      properties:
        request-id:
          type: string
          description: Unique identifier of the generation task
      required:
        - request-id
    ErrorResponse:
      type: object
      properties:
        error:
          type: boolean
          description: Indicates an error occurred
          example: true
        message:
          type: string
          description: Error message
          example: Invalid authentication token
        code:
          type: string
          description: Error code
          example: UNAUTHORIZED
        timestamp:
          type: string
          format: date-time
          description: Timestamp when the error occurred
          example: '2025-01-27T10:30:46Z'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````