Using the REST API

The REST API returns the downloadable files for a video URL as JSON, for apps or other websites.

Turning it on

1. Enable Enable public REST API in Settings → REST API and set the default limits.

2. Create a key in Admin → API keys. The key is shown only once, so copy it right away. Per key you can set allowed IP addresses and requests per minute and per day.

Request

GET https://your-domain.com/api/v1/download?url=https://vimeo.com/76979871
X-API-Key: aio_...

The key can also be sent as ?key= in the URL.

Response

The response contains title, thumbnail, duration, source and medias[]. Each media entry has quality, extension, url and download_url. For platforms that serve video and sound separately, merged[] lists the "video with sound" downloads.

Errors

Errors return {"ok": false, "error": "...", "message": "..."} with HTTP status 401 (missing or wrong key), 403 (IP not allowed or API disabled), 404 (no downloadable content), 422 (invalid or unsupported URL) or 429 (limit reached).