# API reference

URL: https://neattrim.com/docs/api

Every endpoint of the REST API. The interactive console loads when you ask for it.

OpenAPI document: https://api.neattrim.com/openapi.json

## All endpoints

| Method | Path | What it does |
| --- | --- | --- |
| GET | `/v1/config` | [Plans, prices, features and server time](https://neattrim.com/docs/api/get-config) |
| GET | `/v1/health` | [Liveness for the external monitor](https://neattrim.com/docs/api/get-health) |
| GET | `/v1/health/auth` | [Sign-in path health](https://neattrim.com/docs/api/get-health-auth) |
| GET | `/v1/health/billing` | [Billing webhook and reconcile health](https://neattrim.com/docs/api/get-health-billing) |
| GET | `/v1/health/jobs` | [Queue and job heartbeat health](https://neattrim.com/docs/api/get-health-jobs) |
| GET | `/v1/health/ops` | [Cron heartbeat health](https://neattrim.com/docs/api/get-health-ops) |
| GET | `/v1/capabilities` | [Tools, formats, per-file limits for the caller and allowance draws](https://neattrim.com/docs/tools/get_capabilities) |
| POST | `/v1/estimate` | [Estimate how much allowance a job uses](https://neattrim.com/docs/tools/estimate_usage) |
| GET | `/v1/me` | [Principal, plan, allowance per meter with reset time, library setting](https://neattrim.com/docs/api/get-me) |
| POST | `/v1/privacy/requests` | [Rights request: access, export, delete, correct, restrict, object, withdraw consent, appeal](https://neattrim.com/docs/api/create-privacy-request) |
| GET | `/v1/usage` | [Usage history in seconds per meter, receipts](https://neattrim.com/docs/api/get-usage) |
| POST | `/v1/uploads` | [Start a resumable or presigned upload](https://neattrim.com/docs/tools/create_upload) |
| GET | `/v1/uploads/{id}` | [Parts received, for resume](https://neattrim.com/docs/api/get-upload) |
| DELETE | `/v1/uploads/{id}` | [Abort an unfinished upload and release its lease](https://neattrim.com/docs/api/abort-upload) |
| GET | `/v1/uploads/{id}/parts/{n}` | [Get a presigned PUT URL for a direct multipart part](https://neattrim.com/docs/api/sign-upload-part) |
| PUT | `/v1/uploads/{id}/parts/{n}` | [Upload one part through the API (web app path)](https://neattrim.com/docs/api/upload-part) |
| POST | `/v1/uploads/{id}/complete` | [Finish the upload and verify size and type](https://neattrim.com/docs/api/complete-upload) |
| GET | `/v1/jobs` | [List jobs, newest first](https://neattrim.com/docs/api/list-jobs) |
| POST | `/v1/jobs` | [Run any tool by name](https://neattrim.com/docs/api/create-job) |
| GET | `/v1/jobs/{id}` | [Get a job; long-poll with wait](https://neattrim.com/docs/tools/get_job) |
| DELETE | `/v1/jobs/{id}` | [Cancel a job; unused allowance is returned](https://neattrim.com/docs/tools/cancel_job) |
| GET | `/v1/jobs/{id}/events` | [Server-sent progress events](https://neattrim.com/docs/api/stream-job-events) |
| POST | `/v1/batches` | [Run one tool over many inputs (every account, within its allowance)](https://neattrim.com/docs/api/create-batch) |
| GET | `/v1/batches/{id}` | [Batch status and outputs manifest](https://neattrim.com/docs/api/get-batch) |
| POST | `/v1/batches/{id}/cancel` | [Cancel the remaining items](https://neattrim.com/docs/api/cancel-batch) |
| POST | `/v1/tools/probe_media` | [Probe media](https://neattrim.com/docs/tools/probe_media) |
| POST | `/v1/tools/trim_video` | [Trim video](https://neattrim.com/docs/tools/trim_video) |
| POST | `/v1/tools/compress_video` | [Compress video](https://neattrim.com/docs/tools/compress_video) |
| POST | `/v1/tools/convert_media` | [Convert media](https://neattrim.com/docs/tools/convert_media) |
| POST | `/v1/tools/edit_video` | [Edit video](https://neattrim.com/docs/tools/edit_video) |
| POST | `/v1/tools/make_gif` | [Make GIF](https://neattrim.com/docs/tools/make_gif) |
| POST | `/v1/tools/make_meme` | [Make meme](https://neattrim.com/docs/tools/make_meme) |
| POST | `/v1/tools/edit_audio` | [Edit audio](https://neattrim.com/docs/tools/edit_audio) |
| POST | `/v1/tools/edit_image` | [Edit image](https://neattrim.com/docs/tools/edit_image) |
| POST | `/v1/tools/remove_image_background` | [Remove image background](https://neattrim.com/docs/tools/remove_image_background) |
| POST | `/v1/tools/make_passport_photo` | [Make passport photo](https://neattrim.com/docs/tools/make_passport_photo) |
| POST | `/v1/tools/convert_subtitles` | [Convert subtitles](https://neattrim.com/docs/tools/convert_subtitles) |
| POST | `/v1/tools/transcribe_media` | [Transcribe media](https://neattrim.com/docs/tools/transcribe_media) |
| POST | `/v1/tools/translate_subtitles` | [Translate subtitles](https://neattrim.com/docs/tools/translate_subtitles) |
| POST | `/v1/tools/review_translation` | [Review translation](https://neattrim.com/docs/tools/review_translation) |
| POST | `/v1/tools/burn_captions` | [Burn captions](https://neattrim.com/docs/tools/burn_captions) |
| POST | `/v1/tools/subtitle_video` | [Subtitle video](https://neattrim.com/docs/tools/subtitle_video) |
| POST | `/v1/tools/make_notes` | [Make notes](https://neattrim.com/docs/tools/make_notes) |
| POST | `/v1/tools/clean_audio` | [Clean audio](https://neattrim.com/docs/tools/clean_audio) |
| POST | `/v1/tools/clean_up_talking_video` | [Clean up talking video](https://neattrim.com/docs/tools/clean_up_talking_video) |
| POST | `/v1/tools/process_podcast` | [Process podcast](https://neattrim.com/docs/tools/process_podcast) |
| POST | `/v1/tools/smart_edit_video` | [Smart edit video](https://neattrim.com/docs/tools/smart_edit_video) |
| POST | `/v1/tools/make_shorts` | [Make shorts](https://neattrim.com/docs/tools/make_shorts) |
| POST | `/v1/tools/reframe_video` | [Reframe video](https://neattrim.com/docs/tools/reframe_video) |
| POST | `/v1/tools/text_to_speech` | [Text to speech](https://neattrim.com/docs/tools/text_to_speech) |
| POST | `/v1/tools/dub_video` | [Dub video](https://neattrim.com/docs/tools/dub_video) |
| POST | `/v1/tools/text_to_video` | [Text to video](https://neattrim.com/docs/tools/text_to_video) |
| POST | `/v1/tools/generate_reel` | [Generate reel](https://neattrim.com/docs/tools/generate_reel) |
| GET | `/v1/files/{id}` | [File metadata and a fresh signed download URL](https://neattrim.com/docs/api/get-file) |
| DELETE | `/v1/files/{id}` | [Delete a file now](https://neattrim.com/docs/tools/delete_file) |
| GET | `/v1/library` | [Library items kept 7 days, with storage used against the cap](https://neattrim.com/docs/tools/list_library) |
| GET | `/v1/voices` | [Voices by language and tier](https://neattrim.com/docs/tools/list_voices) |
| GET | `/v1/webhook-endpoints` | [List endpoints](https://neattrim.com/docs/api/list-webhook-endpoints) |
| PATCH | `/v1/webhook-endpoints/{id}` | [Change events or disable](https://neattrim.com/docs/api/update-webhook-endpoint) |
| DELETE | `/v1/webhook-endpoints/{id}` | [Delete an endpoint](https://neattrim.com/docs/api/delete-webhook-endpoint) |
| POST | `/v1/webhook-endpoints/{id}/test` | [Send a signed sample event](https://neattrim.com/docs/api/test-webhook-endpoint) |
| POST | `/v1/webhook-endpoints/{id}/enable` | [Re-enable an endpoint disabled after repeated failures](https://neattrim.com/docs/api/enable-webhook-endpoint) |
| GET | `/v1/webhook-endpoints/{id}/deliveries` | [Deliveries of the last 72 hours, for replay](https://neattrim.com/docs/api/list-webhook-deliveries) |
| POST | `/v1/webhook-endpoints/{id}/deliveries/{delivery_id}/replay` | [Replay one delivery with the same webhook-id and an identical body](https://neattrim.com/docs/api/replay-webhook-delivery) |

## Calls the website makes

The API document also describes the calls the website, payment and email providers make. They cannot be made with an API key.

| Method | Path | What it does |
| --- | --- | --- |
| POST | `/v1/ops/gate-results` | Operator only: record real-device test results |
| POST | `/v1/anon/token` | Signed-out device token for cloud jobs |
| PATCH | `/v1/me/settings` | Change library autosave, locale and notifications |
| GET | `/v1/me/notices` | In-app account notices |
| POST | `/v1/me/notices/{id}/read` | Mark a notice read |
| POST | `/v1/me/notices/{id}/dismiss` | Dismiss a notice; mandatory notices collapse and return while their condition holds |
| PUT | `/v1/me/devices/current/push` | Save this device's web push subscription (job finished, files sent to your devices) |
| DELETE | `/v1/me/devices/current/push` | Remove this device's push subscription |
| GET | `/v1/me/sessions` | Signed-in sessions |
| DELETE | `/v1/me/sessions/{id}` | Sign out one session |
| POST | `/v1/me/sessions/revoke-all` | Sign out everywhere |
| GET | `/v1/me/connected-apps` | OAuth grants to assistants and apps |
| DELETE | `/v1/me/connected-apps/{id}` | Revoke an OAuth grant |
| GET | `/v1/devices` | Devices on the account |
| DELETE | `/v1/devices/{id}` | Remove a device |
| POST | `/v1/account/export` | Start a data export (signed URL by email) |
| DELETE | `/v1/account` | Delete the account and its data |
| POST | `/v1/reports` | Report a file or share (takedown) |
| POST | `/v1/consent` | Record a cookie consent choice |
| GET | `/v1/d/{token}` | Signed download on api.neattrim.com (HMAC token, valid 24 h) |
| POST | `/v1/library/delete-all` | Delete every library item now |
| POST | `/v1/library/{file_id}/send` | Send to my devices |
| GET | `/v1/inbox` | Files sent to this device |
| POST | `/v1/shares` | Create a share link that expires with the file |
| GET | `/v1/shares/{id}` | Resolve a share link for its recipient (no session; the token is the capability) |
| DELETE | `/v1/shares/{id}` | Revoke a share link |
| GET | `/v1/glossaries` | Synced glossaries (paid feature of subtitle-qc and video-translator) |
| POST | `/v1/glossaries` | Create a synced glossary |
| GET | `/v1/glossaries/{id}` | Read a glossary |
| PUT | `/v1/glossaries/{id}` | Replace a glossary |
| DELETE | `/v1/glossaries/{id}` | Delete a glossary |
| GET | `/v1/referrals` | This account's referral code and referral statuses |
| GET | `/v1/referrals/visit/{code}` | Record a referral visit and redirect to the site |
| POST | `/v1/shorts/moments` | Find the moments of a talking video that work as Shorts |
| POST | `/v1/shorts/hook` | Write the hook line of a Short that is the whole video |
| POST | `/v1/shorts/frames` | Find the speaker in a few small frames to place the vertical crop |
| POST | `/v1/podcast/notes` | Write show notes, chapters, titles and description from a transcript |
| POST | `/v1/ai-text` | Write a summary, a creator pack, hook ideas or the best clips from subtitles |
| GET | `/v1/embed-domains` | Domains registered for embeds (our branding on every embed) |
| POST | `/v1/embed-domains` | Register an embed domain; verify by DNS TXT |
| DELETE | `/v1/embed-domains/{id}` | Remove an embed domain |
| POST | `/v1/embed-domains/{id}/verify` | Check the DNS TXT record |
| GET | `/v1/voice-clones` | Cloned voices of this account (web only; Pro plan) |
| POST | `/v1/voice-clones` | Create a clone from a live recording against a challenge |
| POST | `/v1/voice-clones/challenges` | Consent script with a one-use code and a random passage |
| DELETE | `/v1/voice-clones/{id}` | Revoke a clone and delete it at the voice provider |
| POST | `/v1/voice-clones/{id}/speech` | Speak text with your own cloned voice (web only) |
| POST | `/v1/voice-clones/{id}/dub` | Dub a video into another language with your own cloned voice (web only) |
| GET | `/v1/api-keys` | List keys (session only) |
| POST | `/v1/api-keys` | Create a key; shown once (every account) |
| DELETE | `/v1/api-keys/{id}` | Revoke a key |
| POST | `/v1/webhook-endpoints` | Register an endpoint; secret shown once |
| POST | `/v1/checkout` | Create a Dodo checkout for a product (signed-in accounts only) |
| POST | `/v1/topups` | Checkout for a top-up (active Plus or Pro only) |
| GET | `/v1/portal` | Dodo customer portal URL |
| POST | `/v1/plan-changes/quote` | Pro-ration quote valid 15 minutes |
| POST | `/v1/plan-changes` | Apply a quoted plan change |
| DELETE | `/v1/plan-changes/scheduled` | Undo a scheduled downgrade (Dodo DELETE change-plan/scheduled) |
| POST | `/v1/subscription/cancel` | Stop renewal; the plan runs to the end of the paid period |
| POST | `/v1/subscription/resume` | Turn renewal back on before the period ends |
| GET | `/v1/receipts` | Payments and refunds for this account or key |
| GET | `/v1/receipts/payments/{payment_id}/invoice` | Dodo invoice PDF for one payment |
| GET | `/v1/receipts/refunds/{refund_id}` | Dodo refund receipt PDF |
| POST | `/v1/refund-requests` | Ask for a refund; a person reviews it |
| POST | `/v1/support/messages` | Contact form for support; sent by email to our support address |
| POST | `/v1/email-consent` | Voluntary email capture with consent text version |
| POST | `/v1/auth/email-delivery-retry` | Self-serve retry when sign-in or key mail is suppressed |
| POST | `/v1/email/unsubscribe` | One-click unsubscribe (RFC 8058) from a signed link |
| GET | `/v1/email/preferences` | Read the switches of the address a signed link names (the /email/preferences page; changes nothing) |
| PUT | `/v1/email/preferences` | Set marketing and optional-notice preferences from a signed link |
| POST | `/v1/events` | Analytics beacon batch; each event is checked against a fixed schema |
| POST | `/v1/telemetry/csp` | CSP violation reports; sampled, never forwarded |
| POST | `/v1/webhooks/dodo` | Dodo events (Standard Webhooks signature) |
