Initiate a web crawl
curl --request POST \
--url https://api.askmy.biz/crawl \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"base_url": "https://example.com",
"namespace": "example_com",
"max_pages": 1
}
'import requests
url = "https://api.askmy.biz/crawl"
payload = {
"base_url": "https://example.com",
"namespace": "example_com",
"max_pages": 1
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({base_url: 'https://example.com', namespace: 'example_com', max_pages: 1})
};
fetch('https://api.askmy.biz/crawl', 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.askmy.biz/crawl",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'base_url' => 'https://example.com',
'namespace' => 'example_com',
'max_pages' => 1
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.askmy.biz/crawl"
payload := strings.NewReader("{\n \"base_url\": \"https://example.com\",\n \"namespace\": \"example_com\",\n \"max_pages\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
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.askmy.biz/crawl")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"base_url\": \"https://example.com\",\n \"namespace\": \"example_com\",\n \"max_pages\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.askmy.biz/crawl")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"base_url\": \"https://example.com\",\n \"namespace\": \"example_com\",\n \"max_pages\": 1\n}"
response = http.request(request)
puts response.read_body{
"job_id": "645f3c1649ec746bc1871307",
"namespace": "example_com"
}API Reference
Initiate a web crawl
Starts crawling a given domain, discovering and processing internal links
POST
/
crawl
Initiate a web crawl
curl --request POST \
--url https://api.askmy.biz/crawl \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"base_url": "https://example.com",
"namespace": "example_com",
"max_pages": 1
}
'import requests
url = "https://api.askmy.biz/crawl"
payload = {
"base_url": "https://example.com",
"namespace": "example_com",
"max_pages": 1
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({base_url: 'https://example.com', namespace: 'example_com', max_pages: 1})
};
fetch('https://api.askmy.biz/crawl', 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.askmy.biz/crawl",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'base_url' => 'https://example.com',
'namespace' => 'example_com',
'max_pages' => 1
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.askmy.biz/crawl"
payload := strings.NewReader("{\n \"base_url\": \"https://example.com\",\n \"namespace\": \"example_com\",\n \"max_pages\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
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.askmy.biz/crawl")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"base_url\": \"https://example.com\",\n \"namespace\": \"example_com\",\n \"max_pages\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.askmy.biz/crawl")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"base_url\": \"https://example.com\",\n \"namespace\": \"example_com\",\n \"max_pages\": 1\n}"
response = http.request(request)
puts response.read_body{
"job_id": "645f3c1649ec746bc1871307",
"namespace": "example_com"
}Authorizations
API key for authentication
Body
application/json
⌘I