Skip to content
Neattrim

Principal, plan, allowance per meter with reset time, library setting

View as Markdown · Open in Claude Desktop

Endpoint
GET /v1/me
Who can call it
An API key, or an OAuth token for an app.

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/me" \
  -H "Authorization: Bearer $NEATTRIM_API_KEY"

Response

200
Me
Response 200
NameTypeRequiredDescription
principalanyyes (one of "anon", "account")
account_idstring or nullno
plananyyes (one of "signed_out", "free", "plus", "pro")
allowanceobjectyes
libraryobjectno
featuresarray of stringno
made_with_tagbooleanno
test_paymentsbooleannoTrue when payments run in test mode (Config.billing.mode) and this account may still buy, with test cards only; no real payment is taken. False in live mode and for every other account.
marketing_consentbooleannoWhether marketing email may go to the account's address: an opt-in or the buyer basis, and no unsubscribe or complaint, checked again at send time. Accounts only.
subscriptionobject or nullnoThe plan that cancel and resume act on, with its end date; null without one

Errors

401
UNAUTHENTICATED or INACTIVE
429
RATE_LIMITED

Every error code and its fix