File
Upload HTML Page
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
File
Upload HTML Page
Chunk HTML by headings and queue for indexing into the specified dataset.
POST
/
api
/
file
/
html_page
curl --request POST \
--url https://api.trieve.ai/api/file/html_page \
--header 'Content-Type: application/json' \
--data '{
"data": {
"extract": "<string>",
"html": "<string>",
"links": [
"<string>"
],
"markdown": "<string>",
"metadata": {
"articleSection": "<string>",
"articleTag": "<string>",
"dcDate": "<string>",
"dcDateCreated": "<string>",
"dcDescription": "<string>",
"dcSubject": "<string>",
"dcTermsAudience": "<string>",
"dcTermsCreated": "<string>",
"dcTermsKeywords": "<string>",
"dcTermsSubject": "<string>",
"dcTermsType": "<string>",
"dcType": "<string>",
"description": "<string>",
"error": "<string>",
"keywords": "<string>",
"language": "<string>",
"modifiedTime": "<string>",
"ogAudio": "<string>",
"ogDescription": "<string>",
"ogDeterminer": "<string>",
"ogImage": "<string>",
"ogLocale": "<string>",
"ogLocaleAlternate": [
"<string>"
],
"ogSiteName": "<string>",
"ogTitle": "<string>",
"ogUrl": "<string>",
"ogVideo": "<string>",
"publishedTime": "<string>",
"robots": "<string>",
"site_map": {
"changefreq": "<string>"
},
"sourceURL": "<string>",
"statusCode": 1,
"title": "<string>"
},
"rawHtml": "<string>",
"screenshot": "<string>"
},
"metadata": "<any>",
"scrapeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}'
This response does not have an example.
Body
application/json
JSON request payload to upload a file
Required range:
x >= 0
Response
204
_mintlify/placeholder
Confirmation that html is being processed
Was this page helpful?
curl --request POST \
--url https://api.trieve.ai/api/file/html_page \
--header 'Content-Type: application/json' \
--data '{
"data": {
"extract": "<string>",
"html": "<string>",
"links": [
"<string>"
],
"markdown": "<string>",
"metadata": {
"articleSection": "<string>",
"articleTag": "<string>",
"dcDate": "<string>",
"dcDateCreated": "<string>",
"dcDescription": "<string>",
"dcSubject": "<string>",
"dcTermsAudience": "<string>",
"dcTermsCreated": "<string>",
"dcTermsKeywords": "<string>",
"dcTermsSubject": "<string>",
"dcTermsType": "<string>",
"dcType": "<string>",
"description": "<string>",
"error": "<string>",
"keywords": "<string>",
"language": "<string>",
"modifiedTime": "<string>",
"ogAudio": "<string>",
"ogDescription": "<string>",
"ogDeterminer": "<string>",
"ogImage": "<string>",
"ogLocale": "<string>",
"ogLocaleAlternate": [
"<string>"
],
"ogSiteName": "<string>",
"ogTitle": "<string>",
"ogUrl": "<string>",
"ogVideo": "<string>",
"publishedTime": "<string>",
"robots": "<string>",
"site_map": {
"changefreq": "<string>"
},
"sourceURL": "<string>",
"statusCode": 1,
"title": "<string>"
},
"rawHtml": "<string>",
"screenshot": "<string>"
},
"metadata": "<any>",
"scrapeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}'
This response does not have an example.