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

# AI Nail Art API

> AI Nail Art API applies prompt-based nail designs to real nail photos, creating realistic manicure previews for beauty apps.

## Request

* **URL**: `https://www.ailabapi.com/api/image/editing/ai-nail-art`
* **Method**: `POST`
* **Content-Type**: `multipart/form-data`

### Image requirements

* **Image format**: `JPEG` `JPG` `PNG` `WEBP`
* **Image size**: No more than 10 MB.
* **Image resolution**: Less than 4096x4096px.

### Headers

| Field              | Required | Type     | Description                                           |
| :----------------- | :------- | :------- | :---------------------------------------------------- |
| `ailabapi-api-key` | YES      | `string` | Application API KEY. [Get API KEY](/docs/get-api-key) |

### Body

| Field       | Required | Type     | Scope | Default | Description                                                                                                                               |
| :---------- | :------- | :------- | :---- | :------ | :---------------------------------------------------------------------------------------------------------------------------------------- |
| `image`     | YES      | `file`   |       |         | Original image.                                                                                                                           |
| `nail_name` | YES      | `string` |       |         | Nail name (English only). Max 500 characters; extra text will be automatically truncated. Use standard vocabulary to pass review.         |
| `nail_desc` | YES      | `string` |       |         | Nail description (English only). Max 1000 characters; extra text will be automatically truncated. Use standard vocabulary to pass review. |

## Response

<Warning>
  **Response Field Handling Flow**

  1. **Handle `Public Response Fields`**

     Parse and validate the `Public Response Fields`, checking the status code or response message to ensure the request is successful and error-free.

  2. **Handle `Business Response Fields`**

     If the `Public Response Fields` are valid and error-free, proceed with processing the business logic in the `Business Response Fields`.
</Warning>

### Public Response Fields

<a href="/docs/response-description" target="_blank">Viewing Public Response Fields and Error Codes</a>

### Business Response Fields

| Field       | Type     | Scope   | Description                                                                                                                                       |
| :---------- | :------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------ |
| `task_type` | `string` | `async` | Task Type. \`\`async`: Asynchronous tasks.`                                                                                                       |
| `task_id`   | `string` |         | Asynchronous task ID. <br />**Please use this field when calling the [Querying Async Task Results](/docs/ai-common/async-task-results/api) API.** |

### Response Example

```json theme={null}
{
  "request_id":     "",
  "log_id":         "",
  "error_code":     0,
  "error_code_str": "",
  "error_msg":      "",
  "error_detail":   {
    "status_code":  200,
    "code":         "",
    "code_message": "",
    "message":      ""
  },
  "task_type":      "async",
  "task_id":        ""
}
```

<Tip>
  This API is asynchronous, please keep `task_id` and call [`Querying Async Task Results`](ai-common/async-task-results/api) to get the final results.

  Asynchronous task results are valid for 24 hours. It is recommended that asynchronous task results be queried every 5 seconds.
</Tip>


## OpenAPI

````yaml POST /api/image/editing/ai-nail-art
openapi: 3.0.0
info:
  title: AILabAPI
  description: >-
    [<b>AILabTools</b>](https://www.ailabtools.com) is an advanced tool that
    offers a vast array of simple and flexible API endpoints to suit your
    specific needs. With just one [<b>API
    KEY</b>](https://www.ailabtools.com/doc/get-api-key), you can easily call
    any of the endpoints and integrate them quickly into your application or
    workflow, allowing for smooth and efficient operations. 
     
    [<b>AILabTools</b>](https://www.ailabtools.com) is continuously evolving,
    and you can anticipate even more API endpoints being added in the future,
    further enhancing its capabilities and usefulness for your artificial
    intelligence and machine learning requirements.
  version: 1.0.0
servers:
  - url: https://www.ailabapi.com
    description: Production server
security:
  - apiKeyAuth: []
tags:
  - name: AI IMAGE
  - name: AI IMAGE > Image Enhancement
  - name: AI IMAGE > Image Effects
  - name: AI IMAGE > Image Editing
  - name: AI IMAGE > Image Scoring
  - name: AI BACKGROUND REMOVAL
  - name: AI BACKGROUND REMOVAL > Portrait
  - name: AI BACKGROUND REMOVAL > General
  - name: AI PORTRAIT
  - name: AI PORTRAIT > Portrait Effects
  - name: AI PORTRAIT > Portrait Enhance
  - name: AI PORTRAIT > Portrait Editing
  - name: AI PORTRAIT > Portrait Analysis
  - name: AI COMMON
paths:
  /api/image/editing/ai-nail-art:
    post:
      tags:
        - AI IMAGE > Image Editing
      summary: AI Nail Art
      description: >-
        AI Nail Art API applies prompt-based nail designs to real nail photos,
        creating realistic manicure previews for beauty apps.
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              required:
                - image
                - nail_name
                - nail_desc
              properties:
                image:
                  type: string
                  format: binary
                  description: |-
                    Original image. 
                    - Image format: `JPEG` `JPG` `PNG` `WEBP` 
                    - Image size: No more than 10 MB. 
                    - Image resolution: Less than 4096x4096px.
                nail_name:
                  type: string
                  description: >-
                    Nail Name (English only). Max 500 characters; extra text
                    will be automatically truncated. Use standard vocabulary to
                    pass review.
                  maxLength: 500
                  example: Golden Butterfly Glow
                nail_desc:
                  type: string
                  description: >-
                    Nail Description (English only). Max 1000 characters; extra
                    text will be automatically truncated. Use standard
                    vocabulary to pass review.
                  maxLength: 1000
                  example: >-
                    Champagne nude shimmer with gold butterfly accents for a
                    soft, luxe finish.
      responses:
        '200':
          headers:
            Content-Type:
              schema:
                type: string
                example: application/json
          content:
            application/json:
              schema:
                type: object
              example:
                request_id: ''
                log_id: ''
                error_detail:
                  code: ''
                  code_message: ''
                  message: ''
                task_type: async
                task_id: ''
          description: Success
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: ailabapi-api-key
      description: API Key for authentication

````