> For the complete documentation index, see [llms.txt](https://developer.gerosense.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.gerosense.ai/gerosense-api-proxy-reference/checking-api-status.md).

# Checking API Status

While we strive to keep our API without downtime, we might need a short maintenance window in some extremely rare cases. Additionally, we might deprecate some of the old API versions with time while some of your users still might be on the old version of your app. To help you handle these scenarios, we have `/status` endpoint. This is how to use it:

* On your client application side, before sending any data to the API, request the `/status` endpoint.
* Check if the status is `Ok`. If it's `Maintenance`, don't send any data to the API until it becomes `Ok` again. 
* In your client application, specify which API version it supports. If it's lower than `minimal_api_version`, ask your users to upgrade the app.

<mark style="color:blue;">`GET`</mark> `/api/status`

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

{% endtab %}
{% endtabs %}

{% code title="REQUEST (EXAMPLE)" %}

```bash
curl 'https://<api-proxy-hostname>/api/status'
```

{% endcode %}

{% code title="200 – OK RESPONSE (EXAMPLE)" %}

```json
{
  "status": "Ok",
  "minimal_api_version":"v1.0"
}
```

{% endcode %}

{% code title="200 – MAINTENANCE RESPONSE (EXAMPLE)" %}

```json
{
  "status": "Maintenance",
  "minimal_api_version":"v1.0"
}
```

{% endcode %}


---

# 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://developer.gerosense.ai/gerosense-api-proxy-reference/checking-api-status.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.