# Neattrim API and developer docs

URL: https://neattrim.com/docs

Run video, audio, image and AI tools from your own code with one API key. Every account can use the API, free accounts included, within its allowance.

A free account includes 1 hour of subtitle time and 5 minutes of voice and AI time each month. The website, the API and MCP share that allowance. Test keys draw nothing.

## Your first call

Estimate what a one-minute video compression would draw from your allowance. The call works with a test key or a live key, needs no file, and draws nothing.

### curl

```bash
curl -X POST https://api.neattrim.com/v1/estimate \
  -H "Authorization: Bearer $NEATTRIM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tool":"compress_video","duration_seconds":60}'
```

### 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 km = new Neattrim({ apiKey: "$NEATTRIM_API_KEY", baseUrl: "https://api.neattrim.com" });
const estimate = unwrap(
  await api.estimateUsage({ client: km.client, body: {"tool":"compress_video","duration_seconds":60} }),
);
console.log(estimate);
```

### Python

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

with Neattrim(api_key="$NEATTRIM_API_KEY", base_url="https://api.neattrim.com") as km:
    print(km.estimate_usage("compress_video", duration_seconds=60))
```

### CLI

```bash
# @neattrim/cli is not on npm yet: it arrives with the first client release. Use the curl example today.
npx @neattrim/cli login
npx @neattrim/cli whoami
```

## Webhooks

Get a signed event when a job ends, so you do not need to poll. Events follow the Standard Webhooks layout, and the SDKs check the signature for you.

[Read about webhooks](https://neattrim.com/docs/webhooks)

## Batches

Run one tool over many files in one request: up to 20 files on Free, 100 on Plus and 500 on Pro.

[Read about jobs and batches](https://neattrim.com/docs/jobs)

## MCP and AI assistants

Connect Claude, ChatGPT and coding agents to the same tools, or run the local server on your own computer.

[Connect with MCP](https://neattrim.com/docs/mcp)

## Rate limits and errors

A free account may send 60 requests a minute. Every error has a stable code and a fix, and every response shows how many requests you have left.

[Read usage and limits](https://neattrim.com/docs/usage-and-limits)

## Status

Check whether the API is up before you debug.

[Open the status page](https://neattrim.com/status)

## More in the docs

- [Quickstart](https://neattrim.com/docs/quickstart)
- [Authentication](https://neattrim.com/docs/authentication)
- [Files](https://neattrim.com/docs/files)
- [Jobs and batches](https://neattrim.com/docs/jobs)
- [Webhooks](https://neattrim.com/docs/webhooks)
- [Usage and limits](https://neattrim.com/docs/usage-and-limits)
- [Errors](https://neattrim.com/docs/errors)
- [MCP](https://neattrim.com/docs/mcp)
- [SDKs](https://neattrim.com/docs/sdks)
- [Command line](https://neattrim.com/docs/cli)
- [Changelog](https://neattrim.com/docs/changelog)
- [Tools](https://neattrim.com/docs/tools)
- [Get capabilities](https://neattrim.com/docs/tools/get_capabilities)
- [Estimate usage](https://neattrim.com/docs/tools/estimate_usage)
- [Create upload](https://neattrim.com/docs/tools/create_upload)
- [Get job](https://neattrim.com/docs/tools/get_job)
- [Cancel job](https://neattrim.com/docs/tools/cancel_job)
- [List library](https://neattrim.com/docs/tools/list_library)
- [Delete file](https://neattrim.com/docs/tools/delete_file)
- [Probe media](https://neattrim.com/docs/tools/probe_media)
- [Trim video](https://neattrim.com/docs/tools/trim_video)
- [Compress video](https://neattrim.com/docs/tools/compress_video)
- [Convert media](https://neattrim.com/docs/tools/convert_media)
- [Edit video](https://neattrim.com/docs/tools/edit_video)
- [Make GIF](https://neattrim.com/docs/tools/make_gif)
- [Make meme](https://neattrim.com/docs/tools/make_meme)
- [Edit audio](https://neattrim.com/docs/tools/edit_audio)
- [Edit image](https://neattrim.com/docs/tools/edit_image)
- [Convert subtitles](https://neattrim.com/docs/tools/convert_subtitles)
- [Transcribe media](https://neattrim.com/docs/tools/transcribe_media)
- [Translate subtitles](https://neattrim.com/docs/tools/translate_subtitles)
- [Review translation](https://neattrim.com/docs/tools/review_translation)
- [Burn captions](https://neattrim.com/docs/tools/burn_captions)
- [Subtitle video](https://neattrim.com/docs/tools/subtitle_video)
- [Make notes](https://neattrim.com/docs/tools/make_notes)
- [Clean audio](https://neattrim.com/docs/tools/clean_audio)
- [Remove music](https://neattrim.com/docs/tools/remove_music)
- [Separate vocals](https://neattrim.com/docs/tools/separate_vocals)
- [Remove image background](https://neattrim.com/docs/tools/remove_image_background)
- [Make passport photo](https://neattrim.com/docs/tools/make_passport_photo)
- [Clean up talking video](https://neattrim.com/docs/tools/clean_up_talking_video)
- [Process podcast](https://neattrim.com/docs/tools/process_podcast)
- [Smart edit video](https://neattrim.com/docs/tools/smart_edit_video)
- [Make shorts](https://neattrim.com/docs/tools/make_shorts)
- [Reframe video](https://neattrim.com/docs/tools/reframe_video)
- [List voices](https://neattrim.com/docs/tools/list_voices)
- [Text to speech](https://neattrim.com/docs/tools/text_to_speech)
- [Dub video](https://neattrim.com/docs/tools/dub_video)
- [Text to video](https://neattrim.com/docs/tools/text_to_video)
- [Generate reel](https://neattrim.com/docs/tools/generate_reel)
- [API reference](https://neattrim.com/docs/api)
- [Plans, prices, features and server time](https://neattrim.com/docs/api/get-config)
- [Liveness for the external monitor](https://neattrim.com/docs/api/get-health)
- [Sign-in path health](https://neattrim.com/docs/api/get-health-auth)
- [Billing webhook and reconcile health](https://neattrim.com/docs/api/get-health-billing)
- [Queue and job heartbeat health](https://neattrim.com/docs/api/get-health-jobs)
- [Cron heartbeat health](https://neattrim.com/docs/api/get-health-ops)
- [Principal, plan, allowance per meter with reset time, library setting](https://neattrim.com/docs/api/get-me)
- [Rights request: access, export, delete, correct, restrict, object, withdraw consent, appeal](https://neattrim.com/docs/api/create-privacy-request)
- [Usage history in seconds per meter, receipts](https://neattrim.com/docs/api/get-usage)
- [Parts received, for resume](https://neattrim.com/docs/api/get-upload)
- [Abort an unfinished upload and release its lease](https://neattrim.com/docs/api/abort-upload)
- [Get a presigned PUT URL for a direct multipart part](https://neattrim.com/docs/api/sign-upload-part)
- [Upload one part through the API (web app path)](https://neattrim.com/docs/api/upload-part)
- [Finish the upload and verify size and type](https://neattrim.com/docs/api/complete-upload)
- [List jobs, newest first](https://neattrim.com/docs/api/list-jobs)
- [Run any tool by name](https://neattrim.com/docs/api/create-job)
- [Server-sent progress events](https://neattrim.com/docs/api/stream-job-events)
- [Run one tool over many inputs (every account, within its allowance)](https://neattrim.com/docs/api/create-batch)
- [Batch status and outputs manifest](https://neattrim.com/docs/api/get-batch)
- [Cancel the remaining items](https://neattrim.com/docs/api/cancel-batch)
- [File metadata and a fresh signed download URL](https://neattrim.com/docs/api/get-file)
- [List endpoints](https://neattrim.com/docs/api/list-webhook-endpoints)
- [Change events or disable](https://neattrim.com/docs/api/update-webhook-endpoint)
- [Delete an endpoint](https://neattrim.com/docs/api/delete-webhook-endpoint)
- [Send a signed sample event](https://neattrim.com/docs/api/test-webhook-endpoint)
- [Re-enable an endpoint disabled after repeated failures](https://neattrim.com/docs/api/enable-webhook-endpoint)
- [Deliveries of the last 72 hours, for replay](https://neattrim.com/docs/api/list-webhook-deliveries)
- [Replay one delivery with the same webhook-id and an identical body](https://neattrim.com/docs/api/replay-webhook-delivery)
