Skip to main content
GET
/
crawl-settings
/
{id}
Get web crawl setting
curl --request GET \
  --url https://developer.qaip.com/api/v1/crawl-settings/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "start_url": "<string>",
  "max_depth": 123,
  "html_only": true,
  "use_browser": true,
  "path_filters": [
    "<string>"
  ],
  "content_pattern": [
    "<string>"
  ],
  "max_num_files": 123,
  "file_extensions": [
    "<string>"
  ],
  "rrule": "<string>"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication

Path Parameters

​
id
string
required

Ingestion setting ID for the web crawl data source

Response

Successful retrieval of web crawl setting

​
id
string
required

Web crawl ingestion setting ID

​
name
string
required

Name of the web crawl ingestion setting

​
start_url
string
required

Start URL of the web crawl

​
max_depth
integer
required

Maximum crawl depth

​
html_only
boolean
required

When true, only HTML files will be downloaded

​
use_browser
boolean
required

Whether to use a headless browser for crawling

​
path_filters
string[]

Path filters for crawling

​
content_pattern
string[]

Content patterns for filtering

​
max_num_files
integer | null

Maximum number of files to crawl

​
file_extensions
string[]

File extensions to include (e.g. ".pdf", ".docx")

​
rrule
string

Recurrence rule (RFC 5545 RRULE)