> 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

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 %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://incubiq.gitbook.io/opensourceais/apis/ais/integration-test/ai_ping.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.