Skip to content

Latest commit

 

History

History
163 lines (134 loc) · 4.9 KB

quickstart.mdx

File metadata and controls

163 lines (134 loc) · 4.9 KB
title description
Quickstart
Get started with Probe.dev API in under 5 minutes
Ready to get started? [Sign up for free](https://www.probe.dev/dashboard) to get your API key and begin analyzing media files and streaming sources.

Minimal Request

The fastest way to get started is with a simple cURL request:

curl -G https://api.probe.dev/v1/probe/file \
  --data-urlencode "token=${PROBE_API_TOKEN}" \
  --data-urlencode "only=ffprobe" \
  --data-urlencode "url=https://probelibrary.s3.amazonaws.com/sample-source.mp4"

The response is standard JSON identical to what a local ffprobe run would return.

Authentication

Method Example Notes
Header (recommended) Authorization: Bearer $PROBE_API_TOKEN Keeps secrets out of URLs & logs
Query string ?token=$PROBE_API_TOKEN Handy for quick cURL tests

After signing up, you'll see your PROBE_API_TOKEN in your dashboard.

API Endpoint

https://api.probe.dev/v1/probe/file

We accept both GET and POST requests:

Method Parameters in Use when
GET Query string Small payloads, quick tests
POST Body (multipart/form-data,application/x-www-form-urlencoded, or application/json) Large payloads or many options

Provide the Media Asset

Static Media Files

Specify a direct link to media file hosted on any webserver or within a publicly available S3 bucket. If you don't have a media asset handy, check out our sample media library.

{
    "url": "https://probelibrary.s3.amazonaws.com/sample-source.mp4"
}

Streaming Formats & Protocols

Analyze streaming sources including HLS playlists, DASH manifests, and live protocols:

```bash curl -G https://api.probe.dev/v1/probe/file \ --data-urlencode "token=${PROBE_API_TOKEN}" \ --data-urlencode "only=mediainfo" \ --data-urlencode "url=https://probelibrary.s3.amazonaws.com/hls/sample/big_buck_bunny.m3u8" ``` ```bash curl -G https://api.probe.dev/v1/probe/file \ --data-urlencode "token=${PROBE_API_TOKEN}" \ --data-urlencode "inject_json=true" \ --data-urlencode "url=https://cdn.bitmovin.com/content/assets/art-of-motion-dash-hls-progressive/mpds/f08e80da-bf1d-4e3d-8899-f0f6155f6efa.mpd" ``` ```bash curl -G https://api.probe.dev/v1/probe/file \ --data-urlencode "token=${PROBE_API_TOKEN}" \ --data-urlencode "only=ffprobe" \ --data-urlencode "url=rtmp://matthewc.co.uk/vod/scooter" ``` ```bash curl -G https://api.probe.dev/v1/probe/mediastreamvalidator \ --data-urlencode "token=${PROBE_API_TOKEN}" \ --data-urlencode "url=https://probelibrary.s3.amazonaws.com/hls/sample/big_buck_bunny.m3u8" \ --data-urlencode "parse_playlist_only=true" ``` ```bash curl -G https://api.probe.dev/v1/probe/c2pa \ --data-urlencode "token=${PROBE_API_TOKEN}" \ --data-urlencode "url=https://probelibrary.s3.amazonaws.com/c2pa/sample-with-credentials.jpg" \ --data-urlencode "inject_output=true" ``` Streaming analysis supports video, audio, and caption tracks across all supported protocols (HLS, DASH, RTMP, RTSP, SRT).

Alternative: Use with AI Assistants

Skip the manual API calls and integrate Probe.dev directly with your AI assistant:

snippets/mcp-quick-setup.mdx

Next Steps

Learn about API authentication methods Comprehensive guide to static files and streaming formats Connect AI assistants to Probe.dev Understand different analysis tools available Explore the complete API documentation Test with our sample files and streaming sources