# Queue and job heartbeat health

URL: https://neattrim.com/docs/api/get-health-jobs

GET /v1/health/jobs: Queue and job heartbeat health.

Endpoint: `GET /v1/health/jobs`

Who can call it: Anyone: no key or sign-in.

## Examples

Set NEATTRIM_API_KEY to your key, then copy an example. A tool that draws from your allowance reads an uploaded file: upload a sample file as in the quickstart and set VIDEO_FILE_ID (or AUDIO_FILE_ID, IMAGE_FILE_ID, SUBTITLES_FILE_ID) to its file_id. Any other id in an example, such as JOB_ID, is read from a variable of the same name.

### curl

```bash
curl -X GET "https://api.neattrim.com/v1/health/jobs"
```

### TypeScript

```ts
// @neattrim/sdk is not on npm yet: it arrives with the first client release. Use the curl example today.
import { api, Neattrim, unwrap } from "@neattrim/sdk";

const client = new Neattrim({ apiKey: process.env.NEATTRIM_API_KEY });
const result = unwrap(
  await api.getHealthJobs({
    client: client.client,
  }),
);
console.log(result);
```

### Python

```python
# neattrim is not on PyPI yet: it arrives with the first client release. Use the curl example today.
import os

from neattrim import Neattrim
from neattrim_generated.api.ops import get_health_jobs

with Neattrim(api_key=os.environ["NEATTRIM_API_KEY"], base_url="https://api.neattrim.com") as client:
    result = get_health_jobs.sync(client=client.client)
    print(result)
```

## Response 200

Healthy

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `status` | any | no |  (one of "ok", "degraded", "down") |
| `checks` | object | no |  |
| `version` | string | no |  |

## Errors

- `429`: RATE_LIMITED
- `503`: A check failed; the body names it
