Skip to content
Neattrim

Estimate usage API

View as Markdown · Open in Claude Desktop

Estimates how much of the account's allowance a planned job will use, from the media duration and options, and whether it fits what is left. Use before long jobs and tell the user the estimate. Works without sign-in (returns the draw only).

Endpoint
POST /v1/estimate
MCP name
estimate_usage
Available in MCP sets
core, generate, full, local_free

What it draws

  • Does not draw from the allowance.

Input

Input
NameTypeRequiredDescription
toolstringyesOperation name, for example subtitle_video, or one of the device tools' AI calls: shorts_moments, shorts_hook, shorts_frames, podcast_notes, ai_text_summary, ai_text_pack, ai_text_hook, ai_text_clips.
duration_secondsnumbernoLength of the media in seconds. (at least 0)
optionsobjectnoThe input the job would be given.

Output

Output
NameTypeRequiredDescription
drawsobjectyes
fits_allowanceboolean or nullno
displaystringyes

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 POST "https://api.neattrim.com/v1/estimate" \
  -H "Authorization: Bearer $NEATTRIM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tool":"compress_video","duration_seconds":6}'

Errors

400
BAD_REQUEST
401
UNAUTHENTICATED or INACTIVE
429
RATE_LIMITED

Limits

Largest upload
Free: 200 MB, Plus: 2 GB, Pro: 4 GB
Jobs running at once
Free: 2, Plus: 3, Pro: 6
Requests a minute
Free: 60, Plus: 60, Pro: 60

Related: usage and limits · errors