Stop Website Crawl

curl --request POST \
  --url https://api.gurubase.io/api/v1/{guru_slug}/crawl/{crawl_id}/stop/ \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.gurubase.io/api/v1/{guru_slug}/crawl/{crawl_id}/stop/"

headers = {"x-api-key": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.gurubase.io/api/v1/{guru_slug}/crawl/{crawl_id}/stop/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gurubase.io/api/v1/{guru_slug}/crawl/{crawl_id}/stop/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gurubase.io/api/v1/{guru_slug}/crawl/{crawl_id}/stop/"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.gurubase.io/api/v1/{guru_slug}/crawl/{crawl_id}/stop/")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gurubase.io/api/v1/{guru_slug}/crawl/{crawl_id}/stop/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
    "id": 211,
    "url": "https://getanteon.com/",
    "status": "STOPPED",
    "guru_type": "anteon",
    "discovered_urls": [],
    "start_time": "2025-02-21T10:25:22.710211Z",
    "end_time": "2025-02-21T10:26:15.521433Z",
    "link_limit": 1500,
    "ignore_query_params": true
}

{
    "msg": "Crawl not found"
}

{
    "msg": "Invalid request"
}

POST

{guru_slug}

crawl

{crawl_id}

stop

Stop Website Crawl

curl --request POST \
  --url https://api.gurubase.io/api/v1/{guru_slug}/crawl/{crawl_id}/stop/ \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.gurubase.io/api/v1/{guru_slug}/crawl/{crawl_id}/stop/"

headers = {"x-api-key": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.gurubase.io/api/v1/{guru_slug}/crawl/{crawl_id}/stop/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gurubase.io/api/v1/{guru_slug}/crawl/{crawl_id}/stop/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gurubase.io/api/v1/{guru_slug}/crawl/{crawl_id}/stop/"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.gurubase.io/api/v1/{guru_slug}/crawl/{crawl_id}/stop/")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gurubase.io/api/v1/{guru_slug}/crawl/{crawl_id}/stop/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
    "id": 211,
    "url": "https://getanteon.com/",
    "status": "STOPPED",
    "guru_type": "anteon",
    "discovered_urls": [],
    "start_time": "2025-02-21T10:25:22.710211Z",
    "end_time": "2025-02-21T10:26:15.521433Z",
    "link_limit": 1500,
    "ignore_query_params": true
}

{
    "msg": "Crawl not found"
}

{
    "msg": "Invalid request"
}

Stops a running website crawl operation. This endpoint allows you to halt the crawling process before it completes naturally.

Path Parameters

string

required

The slug of the Guru type associated with the crawl

string

required

The unique identifier of the crawl operation to stop

Headers

string

required

Your API key for authentication. You can obtain your API key from the Gurubase dashboard.

Response

string

Unique identifier for the crawl operation

string

The root URL that was being crawled

string

Current status of the crawl operation

string

The Guru type that the crawl was initiated for

list

List of URLs discovered during crawling

string

Timestamp when crawl started (ISO 8601 format)

string

Timestamp when crawl ended (ISO 8601 format)

boolean

Whether query parameters were being stripped from discovered URLs

{
    "id": 211,
    "url": "https://getanteon.com/",
    "status": "STOPPED",
    "guru_type": "anteon",
    "discovered_urls": [],
    "start_time": "2025-02-21T10:25:22.710211Z",
    "end_time": "2025-02-21T10:26:15.521433Z",
    "link_limit": 1500,
    "ignore_query_params": true
}

{
    "msg": "Crawl not found"
}

{
    "msg": "Invalid request"
}

Start Website Crawl Get Crawl Status

API Documentation

Endpoints

Stop Website Crawl

Path Parameters

Headers

Response

​Path Parameters

​Headers

​Response

Path Parameters

Headers

Response