Zum Hauptinhalt springen
taskType wählt die Engine. Sie senden jeden Task auf dieselbe Weise, und jedes Ergebnis kommt im selben Ergebnisobjekt zurück. Nur das darin enthaltene response-Objekt unterscheidet sich von Engine zu Engine.

Was alle Tasks gemeinsam haben

GET /v1/async/task/{id} liefert für jede Engine dasselbe Ergebnisobjekt: success, task (ID, Status und Metadaten), credits und, sobald der Task beendet ist, response oder error. Den Lebenszyklus beschreibt Asynchrone Tasks, die Zustellung per Push Webhooks. Jede Antwort-Engine liefert die Antwort in response.text und die zitierten Seiten in response.sources, einem Array aus { position, url, label } plus engine-spezifischen Feldern. Google AI Overviews ist die Ausnahme: Die Übersicht steht unter response.aioverview, in einem Suchergebnisobjekt.

Antwort-Engines

SERP

WEB_SCRAPE: url ist Pflicht: eine öffentliche Seite oder PDF, bis 2.048 Zeichen. render liest sie im Browser nach der Skriptausführung, und maxAge akzeptiert eine Cache-Lesung bis sieben Tage alt. COMMERCE_SERP: site erforderlich: amazon, walmart, target, ebay, aliexpress, google_shopping, sephora oder ulta (US), coupang, oliveyoung, 11st, lotteon, musinsa oder kurly (KR), rakuten, yahoo_shopping oder qoo10 (JP), flipkart, myntra oder nykaa (IN) oder zalando (DE). query: erforderlich, 1 bis 500 Zeichen. country: optional, standardmäßig das Land des Shops. limit: optionale Ganzzahl von 1 bis 40, Standard 20. COMMERCE_PRODUCT: url erforderlich: eine Produktseite von amazon, walmart, target, sephora oder ulta (US), 11st, lotteon, musinsa, kurly oder oliveyoung (KR), rakuten, yahoo_shopping oder qoo10 (JP), flipkart, myntra oder nykaa (IN) oder zalando (DE), höchstens 2.048 Zeichen. country: optional, standardmäßig das Land des Shops. WEB_SCRAPE: url ist Pflicht: eine öffentliche Seite oder PDF, bis 2.048 Zeichen. render liest sie im Browser nach der Skriptausführung, und maxAge akzeptiert eine Cache-Lesung bis sieben Tage alt. Search und Pro Search laufen über einen eigenen Endpoint, POST /v1/search, und liefern die Ergebnisse in derselben Antwort: 0.5 Credits pro Suche, 2 pro Pro-Suche. Die Preise gelten pro abgeschlossenem Task. Credits und Limits erklärt Reservierungen, Abrechnung und Add-ons.

Welches Payload-Feld gelesen wird

Für die unten aufgeführten Engines akzeptiert die Validierung einen Task, der prompt oder query mit 1 bis 100.000 Zeichen enthält (sonst 400 VALIDATION_ERROR). Jede Engine liest zuerst ein Feld und greift auf das andere zurück, sodass eine mit dem anderen Schlüssel gesendete Anfrage trotzdem läuft:
  • CHATGPT, GEMINI, PERPLEXITY, COPILOT, BING_AIMODE, META_AI, QWEN, DOUBAO, BAIDU_WENXIN und BING_SEARCH lesen prompt, dann query.
  • GOOGLE_AIO, GOOGLE_AIMODE, GOOGLE_SERP, GOOGLE_PLACES, GOOGLE_NEWS, NAVER_AI_BRIEF, NAVER_AI_TAB, NAVER_SERP und BAIDU_AI_SEARCH lesen query, dann prompt.
  • BRAVE_SEARCH liest query, dann prompt.
Senden Sie beide, gewinnt das zuerst gelesene Feld. Die Spalte Liest zeigt das Feld, das die Seite der jeweiligen Engine dokumentiert.

Akzeptierte Aliase

Diese Namen werden beim Einreichen akzeptiert und als kanonischer taskType ausgeführt. Neuer Code sollte den kanonischen Namen senden. GOOGLE und AIMODE sind die früheren Namen von GOOGLE_AIO und GOOGLE_AIMODE. Ein Task antwortet unter dem Namen, mit dem er gesendet wurde, und Nutzung, Monitore und Berichte führen die beiden Engines als GOOGLE und AIMODE. Private Engines werden mit 403 ENGINE_PRIVATE abgelehnt.

Die aktuelle Liste

GET /v1/capabilities braucht keinen API-Schlüssel und liefert jeden öffentlichen taskType mit seinen Aliasen, Endpunkt, Credits, erforderlichen und optionalen Eingabefeldern, ob er state und include.html akzeptiert, seiner Länderregel und einem minimalen Beispiel-Payload. Die Liste entsteht aus demselben Code, der jede Regel durchsetzt; nutzen Sie sie daher für Engine- und Länderauswahlen.
Das Antwortschema finden Sie in der API-Referenz.

Anfrageoptionen