Aperçu des paramètres de crawling

POST /crawl/params-preview

Prévisualiser les paramètres de crawl générés à partir d'une invite en langage naturel

cURL

curl --request POST \
  --url https://api.firecrawl.dev/v2/crawl/params-preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prompt": "<string>",
  "url": "<string>"
}
'

import requests

url = "https://api.firecrawl.dev/v2/crawl/params-preview"

payload = {
    "prompt": "<string>",
    "url": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({prompt: '<string>', url: '<string>'})
};

fetch('https://api.firecrawl.dev/v2/crawl/params-preview', 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.firecrawl.dev/v2/crawl/params-preview",
  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([
    'prompt' => '<string>',
    'url' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.firecrawl.dev/v2/crawl/params-preview"

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

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.firecrawl.dev/v2/crawl/params-preview")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"prompt\": \"<string>\",\n  \"url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firecrawl.dev/v2/crawl/params-preview")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"prompt\": \"<string>\",\n  \"url\": \"<string>\"\n}"

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

200

{
  "data": {
    "allowExternalLinks": true,
    "allowSubdomains": true,
    "crawlEntireDomain": true,
    "deduplicateSimilarURLs": true,
    "delay": 123,
    "excludePaths": [
      "<string>"
    ],
    "ignoreQueryParameters": true,
    "ignoreRobotsTxt": true,
    "includePaths": [
      "<string>"
    ],
    "limit": 123,
    "maxDepth": 123,
    "maxDiscoveryDepth": 123,
    "robotsUserAgent": "<string>",
    "url": "<string>"
  },
  "success": true
}

{
  "error": "Invalid request parameters",
  "success": false
}

{
  "error": "Unauthorized",
  "success": false
}

{
  "error": "Failed to process natural language prompt",
  "success": false
}

Autorisations

Authorization · string · header · requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Corps

application/json

prompt · string · requis

Invite en langage naturel décrivant ce que vous souhaitez crawler

Maximum string length: 10000

url · string<uri> · requis

L’URL à explorer

Réponse

200

application/json

Réponse réussie contenant les paramètres de crawl générés

data · object

Show child attributes

success · boolean

Exemple:

true