Skip to main content
POST
/
v1
/
ingestion
/
website
Ingest website data
curl --request POST \
  --url https://api.qontext.ai/v1/ingestion/website \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "workspaceId": "ws_123e4567-e89b-12d3-a456-426614174000",
  "knowledgeGraphId": "kg_681c0068-b589-4923-ac4a-73040fab7a45",
  "url": "https://gryffindor-inc.com/about",
  "type": "singlePage"
}
'
{
  "syncLogId": "sync_a01c7c1c-ecb0-49ec-af7f-329f4b4628bf"
}
Choose between fetching only the given page or crawling all nested pages. Ideal for enriching your context vault with web-based information.

Authorizations

​
X-API-Key
string
header
required

API key for the Qontext API

Body

application/json
​
workspaceId
string
required

The id of the workspace that the context vault belongs to.

Example:

"ws_123e4567-e89b-12d3-a456-426614174000"

​
knowledgeGraphId
string
required

The id of the vault that the data should be ingested into.

Example:

"kg_681c0068-b589-4923-ac4a-73040fab7a45"

​
url
string
required

The url of the website to ingest.

Example:

"https://gryffindor-inc.com/about"

​
type
enum<string>
required

The type of ingestion to perform.

Available options:
deepCrawl,
singlePage
Example:

"singlePage"

Response

Website data ingestion initiated

​
syncLogId
string
required

The sync log id for the ingestion process.

Example:

"sync_a01c7c1c-ecb0-49ec-af7f-329f4b4628bf"