Skip to main content
POST
/
web
/
crawl
Typescript (SDK)
import { Crevio } from "@crevio/sdk";

const crevio = new Crevio({
  apiKey: process.env["CREVIO_API_KEY"] ?? "",
});

async function run() {
  const result = await crevio.web.crawl({
    url: "https://muffled-clavicle.info",
  });

  console.log(result);
}

run();
curl --request POST \
  --url https://api.crevio.co/v1/web/crawl \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "max_pages": 123,
  "max_depth": 123
}
'
import requests

url = "https://api.crevio.co/v1/web/crawl"

payload = {
    "url": "<string>",
    "max_pages": 123,
    "max_depth": 123
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({url: '<string>', max_pages: 123, max_depth: 123})
};

fetch('https://api.crevio.co/v1/web/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.crevio.co/v1/web/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([
    'url' => '<string>',
    'max_pages' => 123,
    'max_depth' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$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.crevio.co/v1/web/crawl"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"max_pages\": 123,\n  \"max_depth\": 123\n}")

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

	req.Header.Add("Authorization", "<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.crevio.co/v1/web/crawl")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"<string>\",\n  \"max_pages\": 123,\n  \"max_depth\": 123\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.crevio.co/v1/web/crawl")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"<string>\",\n  \"max_pages\": 123,\n  \"max_depth\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "object": "<string>",
  "type": "<string>",
  "model": "<string>",
  "progress": 123,
  "input": {},
  "result": {},
  "error": "<string>",
  "error_code": "<string>",
  "credits_used": 123,
  "provider_request_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}
{
  "error": {
    "type": "invalid_request_error",
    "code": "bad_request",
    "message": "The request was malformed or contained invalid parameters"
  }
}
{
  "error": {
    "type": "invalid_request_error",
    "code": "authentication_required",
    "message": "You did not provide an API key."
  }
}
{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "param": "<string>",
    "errors": {}
  }
}
{
  "error": {
    "type": "validation_error",
    "code": "validation_failed",
    "message": "Email is required",
    "errors": {
      "email": [
        "can't be blank"
      ]
    }
  }
}
{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected error occurred"
  }
}

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Body

application/json
url
string
required

Starting URL.

max_pages
integer

Maximum pages to crawl (default 10, capped at 100).

max_depth
integer

Maximum link depth (default 2).

Response

Job queued

id
string
required
object
string
required
type
string
required
status
enum<string>
required
Available options:
queued,
processing,
completed,
failed,
cancelled
model
string
required
progress
integer
required
input
object
required
result
object | null
required
error
string | null
required
error_code
string | null
required
credits_used
integer | null
required
provider_request_id
string | null
required
created_at
string<date-time>
required
started_at
string<date-time> | null
required
completed_at
string<date-time> | null
required