> For the complete documentation index, see [llms.txt](https://joshyzou.gitbook.io/skinapi/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://joshyzou.gitbook.io/skinapi/master.md).

# Url requests

## Basic api request

<mark style="color:green;">`POST`</mark> `https://ai-skin-server.herokuapp.com/url`

This endpoint allows you to send an image url (that's on the web) and get a response.

#### Headers

| Name          | Type   | Description  |
| ------------- | ------ | ------------ |
| Authorization | string | Your api key |

#### Request Body

| Name | Type   | Description                                  |
| ---- | ------ | -------------------------------------------- |
| url  | string | Send an image url that is publicly available |

{% tabs %}
{% tab title="200 Successfully found the specified image and processed it" %}

```
{
  "status": "ok",
  "type": "vitiligo",
  "confidence": 0.9997703433036804
}
```

{% endtab %}

{% tab title="400 Could not find that image." %}

```
{
  "status": "failed",
  "type": "Couldn't find that image on the web! Make sure it's not private"
}
```

{% endtab %}
{% endtabs %}

## Raw api request

<mark style="color:green;">`POST`</mark> `https://ai-skin-server.herokuapp.com/v1/raw`

Returns all the values of the skin conditions

#### Headers

| Name          | Type   | Description  |
| ------------- | ------ | ------------ |
| Authorization | string | Your api key |

#### Request Body

| Name | Type   | Description                              |
| ---- | ------ | ---------------------------------------- |
| url  | string | Send an image that is publicly available |

{% tabs %}
{% tab title="200 " %}

```
{
  "status": "ok",
  "raw": {
    "vitiligo": 0.9997703433036804,
    "rosacea": 2.3592284119486104e-34,
    "ringworm": 4.94471153069222e-16,
    "psoriasis": 0.00022965249081607908,
    "normal": 2.319375709624629e-34,
    "melesma": 6.153275199487652e-24,
    "melanoma": 1.5619000884314893e-11,
    "measles": 7.129576934190558e-22,
    "lupus": 1.4820884225209564e-20,
    "Keratosis-pilaris": 4.028082500872617e-23,
    "Cold_sore": 4.820047897192353e-37,
    "Chickenpox": 1.2663368878067385e-16,
    "Cellulitis": 1.0321511423327934e-9,
    "Blister": 6.94588213251723e-20,
    "Basal Skin Cancer": 1.1606009178952223e-27,
    "Actinic Keratosis": 1.796371592669159e-15,
    "Acne": 1.7337670063727675e-14
  }
}
```

{% endtab %}
{% endtabs %}