API-Überblick

Die Suede-Such-API liefert private, werbefreie Suchergebnisse als JSON: dieselben Web-, Bilder-, Nachrichten-, Video- und Shopping-Ergebnisse, die Suede antreiben, ohne Werbung oder Tracking und ohne einen mit Ihnen verknüpften, gespeicherten Suchverlauf.

Basis-URL

Ein einziger globaler Endpunkt bedient jedes Konto:

https://api.suede.io

Anfragen werden automatisch in die nächstgelegene Infrastrukturregion geleitet — jede Region bedient dieselbe API, und der optionale Parameter gl wählt die Ergebnisgewichtung pro Anfrage. Es gibt nichts zu konfigurieren.

Der interaktive Explorer

Der API-Host stellt eine lebendige In-Browser-Referenz bereit. Öffnen Sie die Wurzel des Hosts (https://api.suede.io/), und sie leitet zum Explorer unter /scalar/v1 weiter, wo jeder Endpunkt dokumentiert und mit Ihrem eigenen Schlüssel aufrufbar ist. Die maschinenlesbare OpenAPI-Beschreibung liegt unter /openapi/v1.json, falls Sie einen Client generieren oder die API in ein anderes Werkzeug importieren möchten.

Authentifizierung

Jede Anfrage muss Ihren API-Schlüssel als Bearer-Token mit sich führen:

Authorization: Bearer suede_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Erstellen Sie einen Schlüssel in Ihrem Suede-Konto; siehe Authentifizierung. Die abrechenbaren Such-Endpunkte erfordern eine aktive Suede-Mitgliedschaft und ein positives API-Guthaben.

Eine erste Anfrage

curl "https://api.suede.io/v1/search?q=hello+world" \
  -H "Authorization: Bearer $SUEDE_API_KEY"

using var http = new HttpClient();
http.DefaultRequestHeaders.Authorization =
    new("Bearer", Environment.GetEnvironmentVariable("SUEDE_API_KEY"));
var json = await http.GetStringAsync("https://api.suede.io/v1/search?q=hello+world");
Console.WriteLine(json);

const res = await fetch("https://api.suede.io/v1/search?q=hello+world", {
  headers: { Authorization: `Bearer ${process.env.SUEDE_API_KEY}` },
});
console.log(await res.json());

Antworten

Eine erfolgreiche Antwort ist JSON mit HTTP 200. Ein Fehler verwendet einen einheitlichen Umschlag:

{ "error": { "type": "invalid_request", "message": "Query parameter 'q' is required.", "request_id": "a1b2c3d4e5f6a7b8" } }

Jede Antwort führt einen X-Request-Id-Header mit sich (in Fehlern als request_id gespiegelt); nennen Sie ihn, wenn Sie den Support kontaktieren. Fehler führt den vollständigen Satz von Typen und Statuscodes auf, und Ratenbegrenzungen beschreibt die Drosselung.

Versionierung

Die aktuelle Version ist v1, erreichbar unter dem Pfadpräfix /v1. Antworten können neue Felder erhalten, ohne dass sich die Version ändert, also parsen Sie defensiv und ignorieren Sie unbekannte Felder. Eine inkompatible Änderung würde unter einem neuen Versionspräfix ausgeliefert.

Endpunkte auf einen Blick