Importly
DocumentationDashboard

Quick Start

Below is a streamlined guide to help you integrate Importly in minutes.

Sign Up & Get Your API Key

  1. Create an Account at Importly.io.
  2. Generate an API Key via the dashboard. Keep it private—treat it like a password!

Your First Request

Example: Fetch Metadata

curl -X GET "https://api.importly.io/metadata?url=<YOUR_MEDIA_URL>" \
  -H "Authorization: Bearer YOUR_API_KEY"

Expected Response (sample):

{
  "success": true,
  "data": {
    "jobId": "abc123",
    "status": "queued",
    "message": "Metadata request queued. You will receive a webhook when it's complete."
  }
}

Check Status

curl -X GET "https://api.importly.io/metadata/status?id=abc123" \
  -H "Authorization: Bearer YOUR_API_KEY"

Expected Response (sample):

{
  "success": true,
  "data": {
    "jobId": "abc123",
    "status": "completed",
    "result": {
      "title": "Sample Media",
      "duration": 300,
      "availableFormats": [
        {
          "formatId": "preset_360p",
          "selector": "bestvideo[height<=360][vcodec^=avc1]/.../best[height<=360]",
          "ext": "mp4",
          "approxSizeMB": 25
        },
        {
          "formatId": "preset_720p",
          "selector": "bestvideo[height<=720][vcodec^=avc1]/.../best[height<=720]",
          "ext": "mp4",
          "approxSizeMB": 60
        }
      ]
    }
  }
}

You've just retrieved metadata about a remote media file—no local downloads required.

Full Import Example

Example: Import & Store

curl -X POST "https://api.importly.io/import" \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
       "url": "https://example.com/some-page-with-video",
       "format": "720p"
     }'
IntroductionAuthentication & Security