Chunk
- POSTCreate or Upsert Chunk or Chunks
- POSTSearch
- POSTAutocomplete
- POSTGet Recommended Chunks
- POSTScroll Chunks
- POSTCount chunks above threshold
- POSTGenerate suggested queries
- POSTRAG on Specified Chunks
- PUTUpdate Chunk
- PUTUpdate Chunk By Tracking Id
- GETGet Chunk By Id
- GETGet Chunk By Tracking Id
- POSTGet Chunks By Tracking Ids
- POSTGet Chunks By Ids
- DELDelete Chunk
- DELDelete Chunk By Tracking Id
- DELBulk Delete Chunks
- POSTSplit HTML Content into Chunks
Chunk Group
- POSTCreate or Upsert Group or Groups
- POSTSearch Over Groups
- POSTSearch Within Group
- POSTGet Recommended Groups
- POSTAdd Chunk to Group
- POSTAdd Chunk to Group by Tracking ID
- POSTGet Groups for Chunks
- GETGet Chunks in Group by Tracking ID
- GETGet Group by Tracking ID
- PUTUpdate Group
- DELRemove Chunk from Group
- DELDelete Group by Tracking ID
- DELDelete Group
- GETGet Group
- GETGet Chunks in Group
- GETGet Groups for Dataset
Message
Crawl
File
Analytics
Dataset
- POSTCreate Dataset
- POSTBatch Create Datasets
- POSTGet All Tags
- POSTGet events for the dataset
- PUTUpdate Dataset by ID or Tracking ID
- PUTClear Dataset
- GETGet Dataset By ID
- GETGet Dataset by Tracking ID
- GETGet Datasets from Organization
- POSTCreate ETL Job
- PUTCreate Pagefind Index for Dataset
- GETGet Pagefind Index Url for Dataset
- GETGet Usage By Dataset ID
- GETGet dataset crawl options
- GETGet apipublic page
- DELDelete Dataset
- DELDelete Dataset by Tracking ID
Organization
Health
Stripe
Metrics
Get dataset crawl options
curl --request GET \
--url https://api.trieve.ai/api/dataset/crawl_options/{dataset_id} \
--header 'Authorization: <api-key>' \
--header 'TR-Dataset: <tr-dataset>'{
"crawl_options": {
"exclude_paths": [
"https://example.com/exclude"
],
"exclude_tags": [
"#ad",
"#footer"
],
"include_paths": [
"https://example.com/include"
],
"include_tags": [
"h1",
"p",
"a",
".main-content"
],
"interval": "daily",
"limit": 1000,
"site_url": "https://example.com"
}
}Authorizations
Headers
The dataset id or tracking_id to use for the request. We assume you intend to use an id if the value is a valid uuid.
Path Parameters
The id of the dataset you want to retrieve.
Response
Options for setting up the crawl which will populate the dataset.
Option for allowing the crawl to follow links to external websites.
Text strings to remove from body when creating chunks for each page
Boost titles such that keyword matches in titles are prioritized in search results. Strongly recommended to leave this on. Defaults to true.
URL Patterns to exclude from the crawl
Specify the HTML tags, classes and ids to exclude from the response.
Text strings to remove from headings when creating chunks for each page
Ignore the website sitemap when crawling, defaults to true.
URL Patterns to include in the crawl
Specify the HTML tags, classes and ids to include in the response.
Interval at which specified site should be re-scraped
daily, weekly, monthly How many pages to crawl, defaults to 1000
Options for including an openapi spec or shopify settigns
OpenAPI json schema to be processed alongside the site crawl
Tag to look for to determine if a page should create an openapi route chunk instead of chunks from heading-split of the HTML
openapi The URL to crawl
Metadata to send back with the webhook call for each successful page scrape
Host to call back on the webhook for each successful page scrape
Was this page helpful?
curl --request GET \
--url https://api.trieve.ai/api/dataset/crawl_options/{dataset_id} \
--header 'Authorization: <api-key>' \
--header 'TR-Dataset: <tr-dataset>'{
"crawl_options": {
"exclude_paths": [
"https://example.com/exclude"
],
"exclude_tags": [
"#ad",
"#footer"
],
"include_paths": [
"https://example.com/include"
],
"include_tags": [
"h1",
"p",
"a",
".main-content"
],
"interval": "daily",
"limit": 1000,
"site_url": "https://example.com"
}
}