Preview only — activation required

Build downloads with downf.io

DownF keeps API execution disabled until an operator reviews the compatibility use case. The examples describe the planned contract, while real credentials and quotas arrive only through support activation.

DownfBridgeJSON over HTTPSAsynchronous jobsScoped credentials
01

Quick start

API host on DownF starts with support-activated credentials. It distinguishes an assigned tenant endpoint from a server-only call path.

Tenant URLhttps://downf.io
AuthenticationX-API-Key: pending_activation_…
Client profileDownfBridge
API versionv1
# Available only after support activation
export DOWNF_ACCESS_TOKEN="issued-after-review"

curl -X POST https://downf.io/v1/resolve \
  -H "X-API-Key: $DOWNF_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"media_address":"https://www.youtube.com/watch?v=VIDEO_ID"}'

Credential safety on DownF starts with server-side secret storage. It distinguishes no client bundle embedding from no public logs or repositories.

02

Resolve a link

Resolve operation on DownF starts with source detection. It distinguishes formats from one submitted URL from no invented outputs.

POST/v1/resolveScope: resolve
FieldTypeRequiredDescription
media_addressHTTPS URLYesPublic or authorized media page to analyze.
tenantstringNoAssigned tenant domain. Usually omitted.
{
  "success": true,
  "platform": "youtube",
  "title": "Example video",
  "formats": [
    {"id":"18","type":"video","quality":"360p","container":"mp4"}
  ],
  "cached": false
}

Format identifier on DownF starts with the returned value unchanged. It distinguishes per-link availability from no guessed quality label.

03

Create and follow a download job

Job creation on DownF starts with asynchronous preparation. It distinguishes a short HTTP request from bounded worker execution.

POST/v1/jobsScope: jobs
FieldTypeRequiredDescription
media_addressHTTPS URLYesThe same normalized source submitted to resolve.
output_refstringYesAn exact ID from the resolve response.
tenantstringNoAssigned tenant domain. Usually omitted.
curl -X POST https://downf.io/v1/jobs \
  -H "X-API-Key: $DOWNF_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"media_address":"https://www.youtube.com/watch?v=VIDEO_ID","output_ref":"18"}'
1202 AcceptedSave transfer_ref.
2Poll statusGET /v1/jobs/{transfer_ref} with the same key.
3ReadyOpen the signed download URL.
StatusMeaningClient action
queuedAdmitted to the bounded queue.Poll again with backoff.
extractingRefreshing source metadata or route.Continue polling.
processingDownloading, remuxing or merging.Display server progress.
readySigned download is available.Send the URL to the user.
failedTerminal structured error.Read error_code. Retry only when advised.
expiredTemporary output was removed.Create a new job.
curl https://downf.io/v1/jobs/TRANSFER_REF \
  -H "X-API-Key: $DOWNF_ACCESS_TOKEN"

Job polling on DownF starts with one-second initial wait. It distinguishes capped backoff from temporary signed delivery.

04

Predictable errors

Error contract on DownF starts with one non-2xx envelope. It distinguishes a support request ID from predictable client handling.

{
  "success": false,
  "error": {
    "code": "RATE_LIMITED",
    "category": "rate_limited",
    "message": "Too many requests. Please try again shortly.",
    "retryable": true,
    "details": {"retry_after_seconds": 20}
  },
  "request_id": "…"
}
HTTPTypical meaningAction
400Invalid URL, body or unavailable format.Correct the request. Resolve again for formats.
401Missing, invalid, expired or wrong-scope key.Check the server-side credential.
403Tenant or source policy rejected the request.Do not bypass the policy. Contact support.
404Unknown or expired job.Create a new job if appropriate.
429Request or active-job limit reached.Honor retry_after_seconds.
503Queue/capacity or upstream temporarily unavailable.Retry with exponential backoff and jitter.
05

Operational contract

DownF assigns a request ceiling after reviewing the intended client, keeping its compatibility checks and upstream providers stable.

Schema access on DownF starts with activation before exploration. It distinguishes assigned authentication from documented request shapes.

OPERATOR-REVIEWED ACCESS

Activate through support

Describe the product, forecast its monthly calls and list the platforms it must analyze. DownF support will confirm the required scopes before issuing a one-time visible credential whose stored copy is only a hash.

Request activation Keys are tenant-scoped, revocable and issued through the Contact form. Anonymous scripts cannot execute downloader work.