FÜR ENTWICKLER

API-Dokumentation

Lade Dateien aus Apps, Bots, Skripten oder ShareX hoch. Die API antwortet als JSON und hält die wichtigsten Endpunkte bewusst klein.

01

Authentifizierung

Für Uploads nutzt du einen Upload-Key. Für Lesen, Löschen und Kontodaten nutzt du einen Key mit Vollzugriff. Sende den passenden Key bei jedem Request über einen dieser Header:

HTTP-HEADER
Authorization: Bearer DEIN_KEY

Upload-Endpunkt: Key mit „Nur Upload“ oder „Vollzugriff“
Lesen/Löschen/Kontodaten: Key mit „Vollzugriff“
Wichtig: Behandle den Key wie ein Passwort. Regenerierst du ihn im Dashboard, wird der alte Key sofort ungültig.
02

Datei hochladen

POST/api/v1/upload

Sende eine Multipart-Anfrage mit einem Feld namens file. Pro Datei sind maximal 200 MB erlaubt. Zusätzlich gelten dein Speicherlimit und die Upload-Rate-Limits.

BEISPIEL
curl -X POST https://archvd.xyz/api/v1/upload \
  -H "Authorization: Bearer DEIN_UPLOAD_KEY" \
  -F "[email protected]"
201 · ERSTELLT
{
  "ok": true,
  "code": "a1B2c3D4.png",
  "url": "https://milo.bewetfor.me/a1B2c3D4.png",
  "size": 48213,
  "mime": "image/png",
  "deleteUrl": "https://archvd.xyz/api/v1/delete/a1B2c3D4.png"
}
03

Datei löschen

POST/api/v1/delete/{code}

Löscht ausschließlich eine Datei, die zu deinem API-Key gehört. Der freigewordene Speicher wird sofort wieder angerechnet.

BEISPIEL
curl -X POST https://archvd.xyz/api/v1/delete/a1B2c3D4.png \
  -H "Authorization: Bearer DEIN_API_KEY"
04

Uploads auflisten

GET/api/v1/images?limit=50

Gibt deine neuesten Uploads zurück. limit darf zwischen 1 und 100 liegen.

BEISPIEL
curl "https://archvd.xyz/api/v1/images?limit=10" \
  -H "X-Api-Key: DEIN_UPLOAD_KEY"
05

Konto und Speicher

GET/api/v1/me
{
  "ok": true,
  "user": {
    "username": "milo",
    "discordId": "1377013151022977205",
    "active": true
  },
  "quota": {
    "limit_bytes": 524288000,
    "used_bytes": 48213,
    "remaining_bytes": 524239787
  }
}
06

ShareX

Im Dashboard lädt der Button ShareX-Konfiguration eine fertige .sxcu-Datei für die neue API herunter. Screenshots und Dateien werden danach automatisch hochgeladen und die URL wird in die Zwischenablage kopiert.

SXCU
{
  "Name": "archvd.xyz API",
  "DestinationType": "ImageUploader, FileUploader",
  "RequestMethod": "POST",
  "RequestURL": "https://archvd.xyz/api/v1/upload",
  "Headers": {
    "Authorization": "Bearer DEIN_UPLOAD_KEY"
  },
  "Body": "MultipartFormData",
  "FileFormName": "file",
  "URL": "{json:url}",
  "DeletionURL": "{json:deleteUrl}"
}
07

Fehlercodes

400Ungültige Anfrage oder Datei fehlt
401API-Key fehlt oder ist ungültig
404Datei wurde nicht gefunden
413Datei ist zu groß
405Falsche HTTP-Methode
415Dateityp nicht erlaubt
422Datei wurde aus Sicherheitsgründen abgelehnt
429Rate-Limit erreicht
503Sicherheitsprüfung vorübergehend nicht verfügbar
507Speicherlimit erreicht
{
  "ok": false,
  "code": "invalid_api_key",
  "message": "API-Key ist ungültig.",
  "request_id": "req_..."
}