Skip to content
Neattrim

Liveness for the external monitor

View as Markdown · Open in Claude Desktop

Endpoint
GET /v1/health
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 -X GET "https://api.neattrim.com/v1/health"

Response

200
Healthy
Response 200
NameTypeRequiredDescription
statusanyno (one of "ok", "degraded", "down")
checksobjectno
versionstringno

Errors

429
RATE_LIMITED
503
A check failed; the body names it

Every error code and its fix