Skip to content
Neattrim

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

MethodPathWhat it does
GET/v1/configPlans, prices, features and server time
GET/v1/healthLiveness for the external monitor
GET/v1/health/authSign-in path health
GET/v1/health/billingBilling webhook and reconcile health
GET/v1/health/jobsQueue and job heartbeat health
GET/v1/health/opsCron heartbeat health
GET/v1/capabilitiesTools, formats, per-file limits for the caller and allowance draws
POST/v1/estimateEstimate how much allowance a job uses
GET/v1/mePrincipal, plan, allowance per meter with reset time, library setting
POST/v1/privacy/requestsRights request: access, export, delete, correct, restrict, object, withdraw consent, appeal
GET/v1/usageUsage history in seconds per meter, receipts
POST/v1/uploadsStart a resumable or presigned upload
GET/v1/uploads/{id}Parts received, for resume
DELETE/v1/uploads/{id}Abort an unfinished upload and release its lease
GET/v1/uploads/{id}/parts/{n}Get a presigned PUT URL for a direct multipart part
PUT/v1/uploads/{id}/parts/{n}Upload one part through the API (web app path)
POST/v1/uploads/{id}/completeFinish the upload and verify size and type
GET/v1/jobsList jobs, newest first
POST/v1/jobsRun any tool by name
GET/v1/jobs/{id}Get a job; long-poll with wait
DELETE/v1/jobs/{id}Cancel a job; unused allowance is returned
GET/v1/jobs/{id}/eventsServer-sent progress events
POST/v1/batchesRun one tool over many inputs (every account, within its allowance)
GET/v1/batches/{id}Batch status and outputs manifest
POST/v1/batches/{id}/cancelCancel the remaining items
POST/v1/tools/probe_mediaProbe media
POST/v1/tools/trim_videoTrim video
POST/v1/tools/compress_videoCompress video
POST/v1/tools/convert_mediaConvert media
POST/v1/tools/edit_videoEdit video
POST/v1/tools/make_gifMake GIF
POST/v1/tools/make_memeMake meme
POST/v1/tools/edit_audioEdit audio
POST/v1/tools/edit_imageEdit image
POST/v1/tools/remove_image_backgroundRemove image background
POST/v1/tools/make_passport_photoMake passport photo
POST/v1/tools/convert_subtitlesConvert subtitles
POST/v1/tools/transcribe_mediaTranscribe media
POST/v1/tools/translate_subtitlesTranslate subtitles
POST/v1/tools/review_translationReview translation
POST/v1/tools/burn_captionsBurn captions
POST/v1/tools/subtitle_videoSubtitle video
POST/v1/tools/make_notesMake notes
POST/v1/tools/clean_audioClean audio
POST/v1/tools/clean_up_talking_videoClean up talking video
POST/v1/tools/process_podcastProcess podcast
POST/v1/tools/smart_edit_videoSmart edit video
POST/v1/tools/make_shortsMake shorts
POST/v1/tools/reframe_videoReframe video
POST/v1/tools/text_to_speechText to speech
POST/v1/tools/dub_videoDub video
POST/v1/tools/text_to_videoText to video
POST/v1/tools/generate_reelGenerate reel
GET/v1/files/{id}File metadata and a fresh signed download URL
DELETE/v1/files/{id}Delete a file now
GET/v1/libraryLibrary items kept 7 days, with storage used against the cap
GET/v1/voicesVoices by language and tier
GET/v1/webhook-endpointsList endpoints
PATCH/v1/webhook-endpoints/{id}Change events or disable
DELETE/v1/webhook-endpoints/{id}Delete an endpoint
POST/v1/webhook-endpoints/{id}/testSend a signed sample event
POST/v1/webhook-endpoints/{id}/enableRe-enable an endpoint disabled after repeated failures
GET/v1/webhook-endpoints/{id}/deliveriesDeliveries of the last 72 hours, for replay
POST/v1/webhook-endpoints/{id}/deliveries/{delivery_id}/replayReplay one delivery with the same webhook-id and an identical body

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.

MethodPathWhat it doesCalled by
POST/v1/ops/gate-resultsOperator only: record real-device test resultsProviders and monitoring
POST/v1/anon/tokenSigned-out device token for cloud jobsThe website
PATCH/v1/me/settingsChange library autosave, locale and notificationsThe website, signed in
GET/v1/me/noticesIn-app account noticesThe website, signed in
POST/v1/me/notices/{id}/readMark a notice readThe website, signed in
POST/v1/me/notices/{id}/dismissDismiss a notice; mandatory notices collapse and return while their condition holdsThe website, signed in
PUT/v1/me/devices/current/pushSave this device's web push subscription (job finished, files sent to your devices)The website, signed in
DELETE/v1/me/devices/current/pushRemove this device's push subscriptionThe website, signed in
GET/v1/me/sessionsSigned-in sessionsThe website, signed in
DELETE/v1/me/sessions/{id}Sign out one sessionThe website, signed in
POST/v1/me/sessions/revoke-allSign out everywhereThe website, signed in
GET/v1/me/connected-appsOAuth grants to assistants and appsThe website, signed in
DELETE/v1/me/connected-apps/{id}Revoke an OAuth grantThe website, signed in
GET/v1/devicesDevices on the accountThe website, signed in
DELETE/v1/devices/{id}Remove a deviceThe website, signed in
POST/v1/account/exportStart a data export (signed URL by email)The website, signed in
DELETE/v1/accountDelete the account and its dataThe website, signed in
POST/v1/reportsReport a file or share (takedown)The website
POST/v1/consentRecord a cookie consent choiceThe website
GET/v1/d/{token}Signed download on api.neattrim.com (HMAC token, valid 24 h)The website
POST/v1/library/delete-allDelete every library item nowThe website, signed in
POST/v1/library/{file_id}/sendSend to my devicesThe website, signed in
GET/v1/inboxFiles sent to this deviceThe website, signed in
POST/v1/sharesCreate a share link that expires with the fileThe 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 linkThe website, signed in
GET/v1/glossariesSynced glossaries (paid feature of subtitle-qc and video-translator)The website, signed in
POST/v1/glossariesCreate a synced glossaryThe website, signed in
GET/v1/glossaries/{id}Read a glossaryThe website, signed in
PUT/v1/glossaries/{id}Replace a glossaryThe website, signed in
DELETE/v1/glossaries/{id}Delete a glossaryThe website, signed in
GET/v1/referralsThis account's referral code and referral statusesThe website, signed in
GET/v1/referrals/visit/{code}Record a referral visit and redirect to the siteThe website
POST/v1/shorts/momentsFind the moments of a talking video that work as ShortsThe website, signed in
POST/v1/shorts/hookWrite the hook line of a Short that is the whole videoThe website, signed in
POST/v1/shorts/framesFind the speaker in a few small frames to place the vertical cropThe website, signed in
POST/v1/podcast/notesWrite show notes, chapters, titles and description from a transcriptThe website, signed in
POST/v1/ai-textWrite a summary, a creator pack, hook ideas or the best clips from subtitlesThe website, signed in
GET/v1/embed-domainsDomains registered for embeds (our branding on every embed)The website, signed in
POST/v1/embed-domainsRegister an embed domain; verify by DNS TXTThe website, signed in
DELETE/v1/embed-domains/{id}Remove an embed domainThe website, signed in
POST/v1/embed-domains/{id}/verifyCheck the DNS TXT recordThe website, signed in
GET/v1/voice-clonesCloned voices of this account (web only; Pro plan)The website, signed in
POST/v1/voice-clonesCreate a clone from a live recording against a challengeThe website, signed in
POST/v1/voice-clones/challengesConsent script with a one-use code and a random passageThe website, signed in
DELETE/v1/voice-clones/{id}Revoke a clone and delete it at the voice providerThe website, signed in
POST/v1/voice-clones/{id}/speechSpeak text with your own cloned voice (web only)The website, signed in
POST/v1/voice-clones/{id}/dubDub a video into another language with your own cloned voice (web only)The website, signed in
GET/v1/api-keysList keys (session only)The website, signed in
POST/v1/api-keysCreate a key; shown once (every account)The website, signed in
DELETE/v1/api-keys/{id}Revoke a keyThe website, signed in
POST/v1/webhook-endpointsRegister an endpoint; secret shown onceThe website, signed in
POST/v1/checkoutCreate a Dodo checkout for a product (signed-in accounts only)The website
POST/v1/topupsCheckout for a top-up (active Plus or Pro only)The website
GET/v1/portalDodo customer portal URLThe website
POST/v1/plan-changes/quotePro-ration quote valid 15 minutesThe website
POST/v1/plan-changesApply a quoted plan changeThe website
DELETE/v1/plan-changes/scheduledUndo a scheduled downgrade (Dodo DELETE change-plan/scheduled)The website
POST/v1/subscription/cancelStop renewal; the plan runs to the end of the paid periodThe website
POST/v1/subscription/resumeTurn renewal back on before the period endsThe website
GET/v1/receiptsPayments and refunds for this account or keyThe website
GET/v1/receipts/payments/{payment_id}/invoiceDodo invoice PDF for one paymentThe website
GET/v1/receipts/refunds/{refund_id}Dodo refund receipt PDFThe website
POST/v1/refund-requestsAsk for a refund; a person reviews itThe website
POST/v1/support/messagesContact form for support; sent by email to our support addressThe website
POST/v1/email-consentVoluntary email capture with consent text versionThe website
POST/v1/auth/email-delivery-retrySelf-serve retry when sign-in or key mail is suppressedThe website
POST/v1/email/unsubscribeOne-click unsubscribe (RFC 8058) from a signed linkThe website
GET/v1/email/preferencesRead the switches of the address a signed link names (the /email/preferences page; changes nothing)The website
PUT/v1/email/preferencesSet marketing and optional-notice preferences from a signed linkThe website
POST/v1/eventsAnalytics beacon batch; each event is checked against a fixed schemaProviders and monitoring
POST/v1/telemetry/cspCSP violation reports; sampled, never forwardedProviders and monitoring
POST/v1/webhooks/dodoDodo events (Standard Webhooks signature)Providers and monitoring