Skip to main content

API Usage

Rich reference for integrating Backend public API (`/api/v1/*`) used by DownAria clients and external apps.

Main Surface

/api/v1/extract, /api/v1/download, and /api/v1/jobs/{id} drive most client integrations.

Download Modes

Responses can be sync file streams or async jobs depending on merge/convert workload.

Client Rule

Extract first, choose source second, then download with the exact media URL or merge pair.

Base URL

http://localhost:8080

Production deployments should use your own Backend domain.

Request Header

No auth header required

No authentication header is required.

Flow Overview

  1. Call `POST /api/v1/extract` with the content URL.
  2. Read `media[].sources[]` and choose the exact source or merge pair.
  3. Call `POST /api/v1/download` for direct or async artifact delivery.
  4. When response is `202`, poll `GET /api/v1/jobs/{id}` until the artifact is complete.

Available Endpoints

Request

{
  "url": "https://www.instagram.com/reel/ABC123/"
}

Response

{
  "success": true,
  "data": {
    "url": "https://www.instagram.com/reel/ABC123/",
    "platform": "instagram",
    "extract_profile": "native",
    "content_type": "video",
    "title": "Example Reel",
    "media": [{
      "index": 0,
      "type": "video",
      "sources": [{
        "quality": "720p",
        "url": "...",
        "stream_profile": "muxed_progressive"
      }]
    }]
  }
}