API Endpoint Reference

/api/v1/metadata-scrubber

Remove metadata from image/video files.

Get API Key Pricing & Tokens

Auth

Bearer or X-API-Key

Every request must include a valid user API key.

Estimate first

Preview token cost

Estimate endpoints help validate input and expected usage before processing.

Response

Download URL on success

Successful sync responses return a result URL plus token details.

Tool Usage Notes

Accepts one or multiple media URLs.
Supported file types: JPG, JPEG, PNG, WEBP, MP4, MOV, M4V.
If one file is processed, you get a single file.
If multiple files are processed, you get a ZIP file.

Estimate Before Processing

Use the estimate endpoint to preview token cost and validate your input URLs before starting conversion.

curl -X POST https://your-domain.example/api/v1/metadata-scrubber/estimate \
  -H "Authorization: Bearer fm_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "inputs": ["https://example.com/file"],
    "response_type": "json"
  }'

{
  "ok": true,
  "tool": "metadata-scrubber",
  "mode": "estimate",
  "estimated_tokens": 1,
  "available_tokens": 10,
  "enough_tokens": true,
  "shortfall_tokens": 0
}

Example Request

Select scrub mode depending on metadata policy.

curl -X POST https://your-domain.example/api/v1/metadata-scrubber \
  -H "Authorization: Bearer fm_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "inputs": ["https://example.com/photo.jpg"],
    "mode": "remove_all",
    "response_type": "json"
  }'

Request Parameters Breakdown

Parameter	Required	Type	Options	Default	Example
inputs	Yes	array<string>	HTTP/HTTPS URL(s) to supported image/video files	`none (required)`	`["https://example.com/photo.jpg"]`
Supported types include JPG, JPEG, PNG, WEBP, MP4, MOV, M4V.
mode	Yes	string	`remove_all, keep_color_profile, remove_location_only`	`none (required)`	`remove_all`
Defines how metadata is removed.
response_type	No	string	`json, xml, text`	`json`	`json`
Controls API response payload format.
promo_code	No	string	Any active promo code	`empty`	`SPRING25`
Optional; applies discount rules when valid.

Example Response

Scrubbed output is returned as downloadable file.

{
  "ok": true,
  "tool": "metadata-scrubber",
  "mode": "sync",
  "status": "completed",
  "download_url": "https://your-domain.example/tool/metadata-scrubber/jobs/.../download",
  "estimated_tokens": 1,
  "final_tokens": 1
}

Response Fields Breakdown

Field	Type	Always Returned	Example
ok	boolean	Yes	`true`
Indicates success/failure.
tool	string	Yes	`metadata-scrubber`
Tool identifier.
mode	string	Yes	`sync`
Current execution mode.
status	string	Yes	`completed`
Processing state.
download_url	string	Yes	`https://your-domain.example/tool/metadata-scrubber/jobs/.../download`
Single file or ZIP download URL.
estimated_tokens	integer	Yes	`1`
Estimated reserved tokens.
final_tokens	integer	Yes	`1`
Final charged tokens.