> ## Documentation Index
> Fetch the complete documentation index at: https://docs.probe.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Get started with Probe.dev API in under 5 minutes

<Note>
  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.
</Note>

## Minimal Request

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

```curl theme={null}
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](https://www.probe.dev/dashboard), you'll see your `PROBE_API_TOKEN` in your dashboard.

## API Endpoint

```bash theme={null}
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](/reference/sample-media-library).

```json theme={null}
{
    "url": "https://probelibrary.s3.amazonaws.com/sample-source.mp4"
}
```

### Streaming Formats & Protocols

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

<Tabs>
  <Tab title="HLS Playlist">
    ```bash theme={null}
    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"
    ```
  </Tab>

  <Tab title="DASH Manifest">
    ```bash theme={null}
    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"
    ```
  </Tab>

  <Tab title="RTMP Stream">
    ```bash theme={null}
    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"
    ```
  </Tab>

  <Tab title="HLS Validation">
    ```bash theme={null}
    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"
    ```
  </Tab>

  <Tab title="C2PA Analysis">
    ```bash theme={null}
    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"
    ```
  </Tab>
</Tabs>

<Info>
  Streaming analysis supports video, audio, and caption tracks across all supported protocols (HLS, DASH, RTMP, RTSP, SRT).
</Info>

## Alternative: Use with AI Assistants

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

<snippets>snippets/mcp-quick-setup.mdx</snippets>

## Next Steps

<CardGroup cols={2}>
  <Card title="Authentication Guide" icon="key" href="/authentication">
    Learn about API authentication methods
  </Card>

  <Card title="Media Sources" icon="link" href="/guides/media-sources">
    Comprehensive guide to static files and streaming formats
  </Card>

  <Card title="MCP Integration" icon="plug" href="/guides/mcp-integration">
    Connect AI assistants to Probe.dev
  </Card>

  <Card title="Report Types" icon="chart-bar" href="/guides/report-types">
    Understand different analysis tools available
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/introduction">
    Explore the complete API documentation
  </Card>

  <Card title="Sample Library" icon="video" href="/reference/sample-media-library">
    Test with our sample files and streaming sources
  </Card>
</CardGroup>