Probe media API
View as Markdown · Open in Claude Desktop
Reads a media file's container, codecs, duration, resolution, frame rate, size and audio tracks without changing it. Use to check a file before choosing settings.
- Endpoint
POST /v1/tools/probe_media- MCP name
probe_media- Available in MCP sets
- core, full, local_free
What it draws
- Does not draw from the allowance.
Input
| Name | Type | Required | Description |
|---|---|---|---|
source | string | yes | The media to process: an https:// URL that returns the file directly, a file_id from create_upload or from an earlier job's output, or (local server only) an absolute file path inside an allowed folder. Links to video-platform pages (YouTube, TikTok, Instagram and similar) are not accepted. |
Output
| Name | Type | Required | Description |
|---|---|---|---|
format | string | yes | |
streams | array of object | yes | |
duration_seconds | number or null | no | |
size_bytes | integer | yes |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
Idempotency-Key | header | string | no | Required on POSTs that create a job, upload, checkout, plan change or top-up; stored 24 h per ledger subject; same key with a different body returns 409 IDEMPOTENCY_MISMATCH |
Neattrim-Simulate | header | string | no | Test keys only (km_test_). Forces a deterministic outcome such as completed, failed or LIMIT for sandbox tests; ignored with live keys |
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/tools/probe_media" \
-H "Authorization: Bearer $NEATTRIM_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d "{\"source\":\"$VIDEO_FILE_ID\"}"Errors
400- BAD_REQUEST
401- UNAUTHENTICATED or INACTIVE
402- LIMIT (allowance used), NEEDS_PLAN (paid feature) or DECLINED
403- FORBIDDEN_SCOPE or VOICE_PROTECTED
409- CONFLICT, IDEMPOTENCY_MISMATCH, DEVICE_LIMIT or a billing 409 (ALREADY_SUBSCRIBED, QUOTE_CHANGED, BILLING_OP_IN_PROGRESS, RESUME_FIRST, PAYMENT_ISSUE)
413- TOO_BIG or TOO_LONG for the caller's plan
415- UNSUPPORTED_MEDIA
422- SOURCE_REFUSED, PART_CORRUPT, CONTENT_REFUSED, NOT_HEARD, TOO_SHORT or CHECKOUT_UNAVAILABLE
429- RATE_LIMITED
503- BUSY or UNAVAILABLE; never charged
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