Zum Hauptinhalt springen
POST
Starte einen neuen Crawl
Benachrichtigung bei Abschluss: Übermittle den webhook-Parameter mit der URL deines Endpunkts, um einen HTTP POST zu erhalten, wenn der Crawl abgeschlossen ist. Siehe Webhooks für Details.
Ergebnisaufbewahrung: Übermittle storage.expires_in, um die gespeicherten Dateien dieses Crawls länger als die standardmäßigen 7 Tage aufzubewahren. Werte: 7d, 10d, 30d, 60d, 90d, 180d, 365d oder never. Siehe Speicherung für Details.

Autorisierungen

Authorization
string
header
erforderlich

Bearer-Authentifizierungs-Header in der Form Bearer , wobei dein Authentifizierungs-Token ist.

Body

application/json
start_url
string
erforderlich

Der Startpunkt des Crawls.

max_pages
number
erforderlich

Maximale Anzahl von Seiten, die gecrawlt werden sollen. Empfohlen für die meisten Anwendungsfälle wie das Crawlen einer gesamten Website.

storage
object

Bestimmt, wie lange die gespeicherten Dateien dieses Crawls (seine gecrawlten Seiten) aufbewahrt werden. Wenn nicht angegeben, werden sie 7 Tage lang aufbewahrt. Der tatsächlich verwendete Wert wird in der Antwort als storage.expires_in zurückgegeben. Siehe den Abschnitt Storage in den Feature-Dokumentationen. Ein ungültiger Wert gibt 400 mit dem Code invalid_storage_expires_in zurück.

include_urls
string[]

URL-Pfadmuster, die im Crawl mit der Glob-Syntax eingeschlossen werden sollen. Standardmäßig /**, was alle URLs einschließt. Verwende Muster wie /blog/**, um bestimmte Abschnitte zu crawlen (z.B. nur Blog-Seiten), /products/*.html für Produktseiten oder mehrere Muster für verschiedene Abschnitte. Unterstützt Standard-Glob-Funktionen wie * (beliebige Zeichen) und ** (rekursives Matching).

exclude_urls
string[]

URL-Pfadnamen im Glob-Muster, die ausgeschlossen werden sollen. Zum Beispiel: /careers/**. Ausgeschlossene URLs haben Vorrang vor eingeschlossenen URLs.

max_depth
number

Maximale Tiefe des Crawls. Nützlich, um nur bis zu einem n-Grad von Links zu extrahieren.

include_external
boolean

Crawl von externen Links ersten Grades.

include_subdomain
boolean

Subdomains der Website einbeziehen. Standardmäßig false.

search_query
string

Eine optionale Suchanfrage, um spezifische Links zu finden und die Ergebnisse auch nach Relevanz zu sortieren.

top_n
number

Eine optionale Zahl, um nur die Top N relevantesten Links auf jeder Seite gemäß der Suchanfrage zu crawlen.

webhook
string<uri>

HTTPS-URL, um eine POST-Anfrage zu erhalten, wenn der Crawl abgeschlossen ist. Muss eine öffentlich zugängliche URL mit dem Protokoll http:// oder https:// sein. Kann nicht auf localhost oder private IP-Adressen verweisen. Siehe Webhooks für das Payload-Format und das Wiederholungsverhalten.

timeout
number

Beende den Crawl nach n Sekunden mit den bis dahin abgeschlossenen Seiten. Kann ~10s extra von der angegebenen Timeout-Zeit in Anspruch nehmen.

follow_robots_txt
boolean
Standard:true

Ob die Regeln von robots.txt beachtet werden sollen. Wenn auf false gesetzt, wird der Crawler die Website unabhängig von den Disallow-Direktiven in robots.txt scrapen. Standardmäßig true.

scrape_options
object

Bestimmt, was jede einzelne Seitenabfrage von der Olostep-API anfordert. Alle Felder sind optional.

Antwort

Crawl erfolgreich gestartet.

storage
object

Aufbewahrung angewendet auf die gespeicherten Dateien dieses Crawls.

id
string

Crawl-ID

object
string

Die Art des Objekts. "crawl" für diesen Endpunkt.

status
string

in_progress oder completed

created
number

Erstellungszeit in Epoch

start_date
string

Erstellungszeit im Datum

start_url
string
max_pages
number
max_depth
number
exclude_urls
string[]
include_urls
string[]
include_external
boolean
search_query
string
top_n
number
current_depth
number

Die aktuelle Tiefe des Crawl-Prozesses.

pages_count
number

Anzahl der gecrawlten Seiten

webhook
string
follow_robots_txt
boolean
credits_consumed
integer | null

Anzahl der durch diese Anfrage verbrauchten Credits. Wird nach Abschluss der Ausführung ausgefüllt. Credits sind die Grundlage für die Abrechnung.

cost_usd
number | null

Geschätzte Kosten in USD für diese Anfrage. Wird nach Abschluss der Ausführung ausgefüllt. Berechnet aus den verbrauchten Credits und deinem Tarif — 99% genau, aber credits_consumed ist der maßgebliche Wert.