> For the complete documentation index, see [llms.txt](https://incubiq.gitbook.io/opensourceais/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://incubiq.gitbook.io/opensourceais/apis/ais/integration-test/ai_ping.md).

# ai\_ping

An authenticated client can post a request to Ping

Ping acts as an integration test AI. It does not cost anything to call, and acts like all other AIs would. Check backend integration with Ping before integrating other AIs

{% hint style="success" %}
This AI can run AI alongside a Daemon on CPU only, but we strongly recommend to run it on a GPU machine, as the name of the machine is the uid of its GPU.
{% endhint %}

## Post a request to AI Ping via OpenSourceAIs

<mark style="color:green;">`POST`</mark> `https://opensourceais.com/api/v1/private/client/ai/ping`

#### Request Body

| Name                                          | Type   | Description                                                                                                                                                                                                  |
| --------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| width<mark style="color:red;">\*</mark>       | Number | The width of the output image. Defaults to 512                                                                                                                                                               |
| height<mark style="color:red;">\*</mark>      | Number | The height of the output image. Defaults to 512                                                                                                                                                              |
| url\_upload<mark style="color:red;">\*</mark> | String | A well formed URI starting with https\://... and accessing a PNG or JPG image. Note that if the image is not of the width and height size passed in parameters, it will be automatically cropped or resized. |

{% tabs %}
{% tab title="201: Created Confirmation that the request was processed" %}

```
{
    "data": {
        "uid": 1678361974000,
        "created_at": "2023-03-09T11:39:44.000Z"
    }
}
```

{% endtab %}

{% tab title="400: Bad Request  This error should not happen unless authentication is tampered with" %}

```
{
     data: null,
     status: 400,
     statusText: "A client token is required"
}
```

{% endtab %}
{% endtabs %}