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

# Fashn v1.0

> Virtual clothing try-on powered by Fashn v1.0.

|             |               |
| ----------- | ------------- |
| **Credits** | 4 credits     |
| **Tool**    | `try-clothes` |

### Headers

| Name            | Type   | Required | Description        |
| --------------- | ------ | -------- | ------------------ |
| `Authorization` | string | Yes      | Your API key       |
| `Content-Type`  | string | Yes      | `application/json` |

### Body

| Parameter                   | Type   | Required | Description                                                                              |
| --------------------------- | ------ | -------- | ---------------------------------------------------------------------------------------- |
| `tool`                      | string | Yes      | `try-clothes`                                                                            |
| `input.model`               | string | Yes      | `fashn-v1-0`                                                                             |
| `input.person_image`        | string | Yes      | URL of the person photo                                                                  |
| `input.garment_image`       | string | Yes      | URL of the garment photo                                                                 |
| `input.garment_description` | string | No       | Description of the garment                                                               |
| `input.category`            | string | No       | Garment category. Options: `upper_body`, `lower_body`, `dresses` (default: `upper_body`) |

<RequestExample>
  ```bash bash theme={null}
  curl -X POST https://api.artificialstudio.ai/api/run \
    -H "Content-Type: application/json" \
    -H "Authorization: YOUR_API_KEY" \
    -d '{
      "tool": "try-clothes",
      "input": {
        "model": "fashn-v1-0",
        "person_image": "https://example.com/person.jpg",
        "garment_image": "https://example.com/garment.jpg"
      }
    }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch('https://api.artificialstudio.ai/api/run', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': 'YOUR_API_KEY'
    },
    body: JSON.stringify({
      tool: 'try-clothes',
      input: {
        model: 'fashn-v1-0',
        person_image: 'https://example.com/person.jpg',
        garment_image: 'https://example.com/garment.jpg'
      }
    })
  });

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      'https://api.artificialstudio.ai/api/run',
      headers={
          'Content-Type': 'application/json',
          'Authorization': 'YOUR_API_KEY'
      },
      json={
          'tool': 'try-clothes',
          'input': {
              'model': 'fashn-v1-0',
              'person_image': 'https://example.com/person.jpg',
              'garment_image': 'https://example.com/garment.jpg'
          }
      }
  )

  data = response.json()
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "id": "507f1f77bcf86cd799439011",
    "status": "processing",
    "tool": "try-clothes",
    "createdAt": "2024-01-15T10:30:00.000Z"
  }
  ```

  ```json 400 theme={null}
  {
    "message": "Missing or invalid parameters"
  }
  ```

  ```json 401 theme={null}
  {
    "message": "Invalid or missing API key"
  }
  ```

  ```json 402 theme={null}
  {
    "message": "You do not have enough credits to perform this action"
  }
  ```

  ```json 429 theme={null}
  {
    "message": "Too many API requests, please try again later"
  }
  ```
</ResponseExample>