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