docs - update /health docs to show correct info

This commit is contained in:
Ishaan Jaff 2024-09-02 08:54:14 -07:00
parent 6375affeea
commit 5c0480114e

View file

@ -11,6 +11,11 @@ The proxy exposes:
## `/health`
#### Request
Make a GET Request to `/health` on the proxy
:::info
**This endpoint makes an LLM API call to each model to check if it is healthy.**
:::
```shell
curl --location 'http://0.0.0.0:4000/health' -H "Authorization: Bearer sk-1234"
```
@ -152,6 +157,12 @@ Expected Response
You can enable model health checks being run in the background, to prevent each model from being queried too frequently via `/health`.
:::info
**This makes an LLM API call to each model to check if it is healthy.**
:::
Here's how to use it:
1. in the config.yaml add:
```