🦰Hairstyle Try-On API

This API employs precise facial landmarks to accurately and naturally try different hairstyles on an image.

Good to know: We only offer cloud APIs and our methods are kept up to date automatically with changes to the API.

Endpoints

GET /api/generatekey

Generates a new API key. This endpoint is rate-limited to 1 request per month for the free tier.

Response

A JSON object containing the generated API key.

{
  "roboKey": "your-api-key"
}

POST /api/hairswap

Applies the selected hairstyle to the image.

Parameters

x-api-key (header): Your API key.

file (form-data): The image file. Should be of type png, jpg, jpeg, or heic.

hair (form-data): The integer corresponding to the hairstyle.

Response

A JSON object containing the base64 string of the binary data of the processed image.

{
  "hairstyleImage": "base64-encoded-string"
}

GET /api/hairswap-health

Checks the health of the application, the AI model, and the database.

Response

A JSON object containing the following fields:

- `status`: A string that indicates the overall health of the API. It can be either "healthy" or "unhealthy".
- `details`: A dictionary that contains the status of each component. The keys are the names of the components ("app", "model", "database"), and the values are strings describing the status of the component.

Status Codes

- `200 OK`: The API is healthy.
- `503 Service Unavailable`: The API is unhealthy.

Example Response

{
    "status": "healthy",
    "details": {
        "app": "App is running",
        "model": "AI model is loaded",
        "database": "Database is connected"
    }
}

Good to know: The health check endpoint is useful for monitoring the health of the API and quickly identifying any issues with the application, the AI model, or the database.

---

Error Codes

• 403: Missing or invalid API key.

• 429: API key exceeded request limit.

• 400: No file part, selected file, or invalid file type.

• 415: Unsupported encoded image file.

Authentication

To authenticate your requests, include your API key in the x-api-key header.

Request Limit

The generatekey endpoint is rate-limited to 1 request per month for the free tier. The hairswap endpoint is rate-limited to 100 requests per month per API key for the free tier.

Acceptable Image Files

The hairswap endpoint accepts image files of type png, jpg, jpeg, and heic. The maximum file size is 5MB.