API-Dokumentation

Starte Screenshots und visuelle Prüfungen aus CI, Tools und Webhooks.

Nutze die API für CI, Release-Hooks oder Backend-Jobs. Die Seiteneinrichtung bleibt in der Übersicht, damit Teams Referenzen, Fehler und Ergebnisdateien prüfen können.

Schnellstart Endpunktreferenz

Was die API abdeckt

8 Endpunkte

Render-Ergebnisse: Erstelle Screenshots, PDFs, HTML, Markdown und Dateien über eine API.
Regelmäßige Website-Prüfungen: Starte gespeicherte Prüfsuites aus CI und prüfe geänderte Seiten in der Übersicht.
Ergebnisse und Review: Frage Aufträge ab, lade Artefakte herunter und halte den Verlauf mit Referenzen zusammen.

Basis-URL

https://renderlog.com

Schnellstart

Prüfsuite ausführen

Erstelle ein API-Token mit runs:write, starte eine gespeicherte Website-Prüfung aus CI und frage den Auftrag bis zum Abschluss ab. Die Einrichtung bleibt in der Übersicht.

OpenAPI-Spezifikation herunterladen

Ausführung erstellencURL

curl -X POST https://renderlog.com/api/check-suites/suite_01J/runs \
  -H "Authorization: Bearer rl_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "format": "png",
    "labels": {
      "branch": "main",
      "commit": "8f4a7f2"
    }
  }'

Auftrag abfragencURL

curl https://renderlog.com/api/jobs/job_01J \
  -H "Authorization: Bearer rl_live_xxx"

Anwendungsfälle

Beginne mit dem API-Pfad, der zur Aufgabe passt

Nutze die Übersicht für die Einrichtung und die API für Arbeit, die aus CI, Release-Hooks oder Hintergrundaufgaben laufen soll.

Einmalige Render-Ausführung

Erstelle ein Screenshot-, PDF-, HTML- oder Markdown-Ergebnis mit einer Anfrage, wenn der Auftrag in einer Datei enden soll.

Visuelle CI-Prüfung

Starte eine gespeicherte Prüfsuite nach einer Veröffentlichung, frage den Auftrag ab und prüfe nur Fälle mit Änderung oder Fehler.

Schutz vor schlechten Ergebnissen

Verwerfe Seiten mit CAPTCHA, Challenge Screen, fehlendem Selektor oder falschem Text.

Ergebnisdateien

Rufe das gespeicherte Ergebnis ab, nachdem eine asynchrone Ausführung abgeschlossen ist.

Authentifizierung

API-Tokens sind an den Arbeitsbereich gebunden. Erstelle eng begrenzte Tokens und kurzlebige Tokens für GET-URLs, die in Protokollen landen können.

Authorization: Bearer rl_live_xxx

Abrechnungsregeln

Eine Ausführung ist nur abrechenbar, wenn sie erfolgreich ist und ein echtes Ergebnis zurückgibt. Fehler ohne brauchbares Ergebnis werden nicht abgerechnet.

Unterstützte öffentliche Ausgaben: Screenshot, PDF, HTML, Markdown und generierte Datei. Video läuft asynchron und wird separat berechnet, wenn es aktiviert ist.

Artefakt-Routing

Ergebnisdateien in eigenen S3-kompatiblen Speicher schreiben

RenderLog kann Ergebnisdateien im verwalteten Speicher behalten oder in deinen Bucket schreiben. Verlauf, Review-Status und Metadaten bleiben in RenderLog.

Felder

Bucket: Der genaue Bucket- oder Containername.
Region: Provider-Region, zum Beispiel us-east-1. Manche Provider brauchen sie nicht.
Endpoint: Eigener S3-kompatibler Endpoint. Für Standard-AWS-S3 leer lassen.
Präfix: Optionaler Ordnerpfad vor jeder Datei, zum Beispiel renderlog/.

Vor dem Hinzufügen

Erstelle einen Bucket für RenderLog-Ergebnisdateien.
Erlaube den RenderLog-Speicherzugangsdaten, Objekte in diesen Bucket zu schreiben.
Füge den Speicher in den Arbeitsbereichseinstellungen hinzu und wähle ihn für künftige Ausführungen aus.

Methoden

GET oder POST

GET ist bequem für einfache URL-Renders. POST ist sicherer, wenn die Anfrage Geheimnisse, längere Schritte oder Speichereinstellungen enthält.

GET

GET ist bequem

Nutze GET für teilbare Render-URLs und einfache Abfrageparameter. Wenn eine URL sensible Werte enthält, verwende einen eng begrenzten kurzlebigen Schlüssel.

curl "https://renderlog.com/api/render?url=https%3A%2F%2Fexample.com&format=png&width=1366&height=768&dpr=1&selector=%23app" \
  -H "Authorization: Bearer rl_live_xxx"

POST

POST ist sicherer für Geheimnisse

Nutze POST für Header, Cookies, HTML, Markdown, längere Flow-Schritte, Speichereinstellungen und Webhooks.

curl -X POST https://renderlog.com/api/render \
  -H "Authorization: Bearer rl_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/account",
    "format": "png",
    "headers": { "X-RenderLog-Access": "secret" },
    "failureRules": [
      { "type": "preset", "preset": "cloudflare_challenge" },
      { "type": "selector_missing", "selector": "#app" }
    ]
  }'

Render-API

Erstelle einmalige Render-Ausführungen per GET oder POST. GET ist bequem. POST wird für sensible Werte empfohlen.

GET/api/render

Per URL rendern

Startet eine URL-basierte Render-Ausführung aus Abfrageparametern. Sensible Werte in URLs können in Protokollen, Browserverlauf und Analysewerkzeugen auftauchen. Verwende dafür bewusst nur einen eng begrenzten kurzlebigen Token.

API-Token

Auftrag

{
  "id": "job_01J",
  "status": "passed",
  "result": [
    {
      "id": "run_01J",
      "status": "passed",
      "format": "png",
      "billable": true,
      "artifacts": [
        {
          "id": "artifact_01J",
          "url": "/api/runs/run_01J/artifacts/artifact_01J",
          "contentType": "image/png"
        }
      ]
    }
  ]
}

Pfad- und Abfrageparameter

urlqueryPflichtZiel-URL.

formatqueryOptionalpng, jpeg, webp, pdf, html oder markdown. Standard: png

widthqueryOptionalViewport-Breite in CSS-Pixeln. Standard: 1366

heightqueryOptionalViewport-Höhe in CSS-Pixeln. Standard: 768

dprqueryOptionalGeräteskalierung von 1 bis 3. Standard: 1

selectorqueryOptionalCSS-Selektor für eine Elementaufnahme.

fullPagequeryOptionalSetze true für eine Aufnahme der ganzen Seite. Standard: false

Antwortfelder

idPflichtAuftrags-ID. Verwende sie mit GET /api/jobs/.

statusPflichtqueued, running, passed, failed oder canceled.

resultOptionalNull während queued oder running. Enthält Ergebniszeilen nach Abschluss. Standard: null

POST/api/render

Mit Anfragekörper rendern

Startet eine Render-Ausführung mit vollständigen Einstellungen wie Headern, Cookies, HTML, Markdown, Flow-Schritten, Speicher und Fehlerregeln.

API-Token

Render-Anfrage

{
  "url": "https://example.com/account",
  "format": "png",
  "headers": {
    "X-RenderLog-Access": "secret"
  },
  "failureRules": [
    {
      "type": "preset",
      "preset": "cloudflare_challenge"
    },
    {
      "type": "selector_missing",
      "selector": "#app"
    }
  ]
}

Auftrag

{
  "id": "job_01J",
  "status": "passed",
  "result": [
    {
      "id": "run_01J",
      "status": "passed",
      "format": "png",
      "billable": true,
      "artifacts": [
        {
          "id": "artifact_01J",
          "url": "/api/runs/run_01J/artifacts/artifact_01J",
          "contentType": "image/png"
        }
      ]
    }
  ]
}

Anfragefelder

urlPflichtSeiten-URL zum Rendern. Pflichtfeld, außer du sendest HTML- oder Markdown-Inhalt.

formatOptionalErgebnisformat: png, jpeg, webp, pdf, html, markdown, file oder webm. Standard: png

headersOptionalZusätzliche Anfrage-Header. Nutze POST für Geheimnisse. Standard: {}

cookiesOptionalCookies, die vor dem Öffnen der Seite gesetzt werden. Standard: []

failureRulesOptionalRegeln, die ein Ergebnis als unbrauchbar markieren, etwa CAPTCHA, Cloudflare-Challenge oder fehlender Selektor. Standard: []

asyncOptionalGibt sofort zurück und erlaubt Statusabfragen über GET /api/jobs/, wenn das Ergebnis länger dauern kann. Standard: false

Antwortfelder

idPflichtAuftrags-ID. Verwende sie mit GET /api/jobs/.

statusPflichtqueued, running, passed, failed oder canceled.

Prüfausführungen

Starte gespeicherte Prüfsuiten oder einen Prüffall aus CI, Bereitstellungs-Hooks oder internen Tools.

POST/api/check-suites/{id}/runs

Prüfsuite ausführen

Startet alle aktiven Prüffälle in einer gespeicherten Prüfsuite. Nutze Markierungen für Branch, Build oder Umgebung.

API-Token

Prüfsuite ausführen

{
  "format": "png",
  "labels": {
    "environment": "production",
    "build": "142",
    "commit": "8f4a7f2"
  },
  "delaySeconds": 30
}

Auftrag

{
  "id": "job_01J",
  "status": "queued",
  "result": null
}

Pfad- und Abfrageparameter

idpathPflichtPrüfsuite-ID.

Anfragefelder

formatOptionalErgebnisformat für jeden Prüffall in dieser Ausführung. Standard: png

labelsOptionalSchlüssel-Wert-Markierungen zum späteren Filtern, etwa Branch, Build oder Umgebung. Standard: {}

delaySecondsOptionalWartezeit vor dem Start. Nützlich nach Bereitstellungen, die Aufwärmzeit brauchen. Standard: 0

asyncOptionalGibt sofort zurück und erlaubt Statusabfragen über GET /api/jobs/. Standard: false

POST/api/check-cases/{id}/runs

Einen Prüffall ausführen

Startet ein gespeichertes Ziel. Nutze das, wenn eine Bereitstellung nur eine Seite oder Komponente geändert hat.

API-Token

Prüffall ausführen

{
  "format": "png",
  "labels": {
    "branch": "main",
    "commit": "8f4a7f2"
  },
  "delaySeconds": 0
}

Auftrag

{
  "id": "job_01J",
  "status": "passed",
  "summary": {
    "total": 1,
    "passed": 1,
    "failed": 0,
    "errored": 0,
    "skipped": 0
  },
  "result": [
    {
      "id": "run_01J",
      "status": "passed",
      "format": "png",
      "billable": true
    }
  ]
}

Pfad- und Abfrageparameter

idpathPflichtPrüffall-ID.

Anfragefelder

formatOptionalErgebnisformat für diesen Prüffall. Standard: png

labelsOptionalSchlüssel-Wert-Markierungen zum späteren Filtern. Standard: {}

delaySecondsOptionalWartezeit vor dem Start. Standard: 0

Ergebnisse

Frage Aufträge ab, prüfe Ausführungen und lade generierte Dateien herunter.

GET/api/runs

Ausführungen auflisten

Gibt aktuelle Ausführungen mit Markierungen, Ergebnisdateien und Abrechnungsstatus zurück.

API-Token

Ausführungen

{
  "runs": [
    {
      "id": "run_01J",
      "status": "passed",
      "format": "png",
      "billable": true,
      "bytes": 128420
    }
  ]
}

GET/api/jobs/{id}

Auftrag abrufen

Gibt Status und Ergebniszeilen für eine Render- oder Prüfsuite-Ausführung zurück.

API-Token

Auftrag

{
  "id": "job_01J",
  "status": "passed",
  "summary": {
    "total": 4,
    "passed": 4,
    "failed": 0,
    "errored": 0,
    "skipped": 0
  },
  "result": [
    {
      "id": "run_01J",
      "status": "passed",
      "format": "png",
      "billable": true,
      "artifacts": [
        {
          "id": "artifact_01J",
          "url": "/api/runs/run_01J/artifacts/artifact_01J",
          "contentType": "image/png"
        }
      ]
    }
  ]
}

Pfad- und Abfrageparameter

idpathPflichtAuftrags-ID, die beim Start einer Render- oder Prüfsuite-Ausführung zurückgegeben wird.

GET/api/runs/{id}

Ausführung abrufen

Gibt Status, Markierungen und Links zu Ergebnisdateien für eine Ausführung zurück.

API-Token

Ausführung

{
  "id": "run_01J",
  "status": "passed",
  "format": "png",
  "billable": true,
  "artifacts": [
    {
      "id": "artifact_01J",
      "kind": "primary",
      "contentType": "image/png",
      "url": "/api/runs/run_01J/artifacts/artifact_01J"
    }
  ]
}

Pfad- und Abfrageparameter

idpathPflichtAusführungs-ID.

GET/api/runs/{id}/artifacts/{artifactId}

Ergebnisdatei herunterladen

Lädt einen erzeugten Screenshot, PDF, HTML, Markdown, eine Datei oder ein Video herunter.

API-Token

Ergebnisdatei

"Binary artifact response with the stored content type."

Pfad- und Abfrageparameter

idpathPflichtAusführungs-ID.

artifactIdpathPflichtID der Ergebnisdatei.