PRODUCTION REST API · v1

Build downloads with YTSave

Resolve a public media URL, select an exact format, create an asynchronous job and hand the signed result to your user. The same bounded production pipeline powers the YTSave website.

YTSaveClientJSON über HTTPSAsynchrone JobsAnmeldeinformationen mit Bereich

Schnellstart

YTSave handles API host by first identifying support-activated credentials. It follows with an assigned tenant endpoint and keeps a server-only call path in view.

Tenant-URLhttps://ytsave.app

AuthentifizierungX-API-Key: ys_live_…

Profil des KundenYTSaveClient

API-Versionv1

# Available only after support activation
export YTSAVE_API_KEY="issued-after-review"

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

To explain Credential safety, YTSave separates server-side secret storage from no client bundle embedding. An evidence record gives no public logs or repositories its own place.

Auflösen eines Links

YTSave handles Resolve operation by first identifying source detection. It follows with formats from one submitted URL and keeps no invented outputs in view.

Post/v1/resolveGeltungsbereich: resolve

Feld	Typ	Erforderlich	Beschreibung
`url`	HTTPS-URL	Ja	Öffentliche oder autorisierte Medienseite zu analysieren.
`tenant`	Zeichenfolge	Nein	Zugewiesene Mandantendomäne. Normalerweise weggelassen.

{
  "success": true,
  "platform": "youtube",
  "title": "Example video",
  "formats": [
    {"id":"18","type":"video","quality":"360p","container":"mp4"}
  ],
  "cached": false
}

To explain Format identifier, YTSave separates the returned value unchanged from per-link availability. An evidence record gives no guessed quality label its own place.

Download-Auftrag erstellen und verfolgen

For Job creation, YTSave begins with asynchronous preparation. Its evidence record pairs that with a short HTTP request and ends with bounded worker execution.

Post/v1/jobsGeltungsbereich: Jobs

Feld	Typ	Erforderlich	Beschreibung
`url`	HTTPS-URL	Ja	Die gleiche normalisierte Quelle, die zur Auflösung eingereicht wurde.
`format_id`	Zeichenfolge	Ja	Eine genaue ID aus der Auflösungsantwort.
`tenant`	Zeichenfolge	Nein	Zugewiesene Mandantendomäne. Normalerweise weggelassen.

curl -X POST https://ytsave.app/v1/jobs \
  -H "X-API-Key: $YTSAVE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://www.youtube.com/watch?v=VIDEO_ID","format_id":"18"}'

1202 AkzeptiertSave job_id.

2UmfragestatusGET /v1/jobs/{job_id} with the same key.

3BereitÖffnen Sie die signierte Download-URL.

Status	Bedeutung	Client-Action
`queued`	In die begrenzte Warteschlange aufgenommen.	Abstimmung nochmal mit Rückzug.
`extracting`	Aktualisierung von Quellmetadaten oder Route.	Fahren Sie mit dem Abstimmen fort.
`processing`	Herunterladen, Remuxen oder Zusammenführen.	Serverfortschritt anzeigen.
`ready`	Signierter Download ist verfügbar.	Senden Sie die URL an den Benutzer.
`failed`	Terminal strukturierter Fehler.	Read `error_code`. Retry only when advised.
`expired`	Temporäre Ausgabe wurde entfernt.	Erstellen Sie einen neuen Job.

curl https://ytsave.app/v1/jobs/JOB_ID \
  -H "X-API-Key: $YTSAVE_API_KEY"

YTSave makes Job polling easy to scan. The page starts with one-second initial wait, moves to capped backoff, and clearly states temporary signed delivery.

Vorhersehbare Fehler

For Error contract, YTSave checks one non-2xx envelope before a support request ID. This evidence record also makes predictable client handling clear.

{
  "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": "…"
}

HTTP	Typische Bedeutung	Action
400	Ungültige URL, ungültiger Text oder unzugängliches Format.	Korrigieren Sie die Anfrage. Lösen Sie erneut für Formate auf.
401	Fehlender, ungültiger, abgelaufener oder falscher Schlüsselbereich.	Überprüfen Sie die serverseitigen Anmeldeinformationen.
403	Die Anforderung wurde von der Mandanten- oder Quellenrichtlinie abgelehnt.	Umgehen Sie die Richtlinie nicht. Wenden Sie sich an den Support.
404	Unbekannter oder abgelaufener Job.	Erstellen Sie ggf. einen neuen Auftrag.
429	Anfrage- oder Aktiv-Job-Limit erreicht.	Honor `retry_after_seconds`.
503	Warteschlange/Kapazität oder Upstream vorübergehend nicht verfügbar.	Wiederholen Sie den Versuch mit exponentiellem Rückschlag und Jitter.

Betriebsvertrag

YTSave issues an operational quota with each approval to safeguard the API consumer and upstream media services.

Verwenden Sie idempotente Anwendungslogik und starten Sie niemals doppelte Aufträge für denselben Benutzerklick.
Speichern Sie Auflösungsmetadaten nur kurz zwischen und behandeln Sie signierte Download-URLs stets als ablaufend.
Use bounded exponential backoff with jitter for 429, 503 and retryable errors.
Verarbeiten Sie nur öffentliche Medien oder Medien, auf die Sie zugreifen dürfen, und umgehen Sie keine DRM- und Zugriffskontrollen.
Bewahren Sie Anforderungs-IDs und Auftrags-IDs in privaten Betriebsprotokollen auf und protokollieren Sie übermittelte URLs nicht unnötig.

YTSave handles Schema access by first identifying activation before exploration. It follows with assigned authentication and keeps documented request shapes in view. OpenAPI-Referenz

VOM BETRIEBSERHALTER ÜBERPRÜFTER ZUGANG

Request your API key

Document the API consumer, its monthly request estimate and supported platform requirements. YTSave reviews whether resolve, job submission or both are justified before issuing a once-visible key.

Request API access Schlüssel sind mandantenspezifisch, widerrufbar und werden über das Kontaktformular ausgestellt. Anonyme Skripte können keine Downloader-Arbeit ausführen.