Create or subscribe to a source
curl --request POST \
--url https://bulkgrid.com/api/v1/sources \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"type": "domain",
"identifier": "<string>",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"crawl_config": {
"maxDepth": 2,
"maxPages": 2,
"includePaths": [
"<string>"
],
"excludePaths": [
"<string>"
],
"selectedUrls": [
"<string>"
],
"crawlOptions": {
"waitAfterLoad": 15000,
"timeout": 30500,
"includeTags": [
"<string>"
],
"excludeTags": [
"<string>"
],
"useHttp": true,
"useLlmsTxt": true,
"removeConsentPopups": true,
"includeDocumentLinks": true
}
},
"metadata": {},
"custom_interval_minutes": 123,
"analysis_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://bulkgrid.com/api/v1/sources"
payload = {
"type": "domain",
"identifier": "<string>",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"crawl_config": {
"maxDepth": 2,
"maxPages": 2,
"includePaths": ["<string>"],
"excludePaths": ["<string>"],
"selectedUrls": ["<string>"],
"crawlOptions": {
"waitAfterLoad": 15000,
"timeout": 30500,
"includeTags": ["<string>"],
"excludeTags": ["<string>"],
"useHttp": True,
"useLlmsTxt": True,
"removeConsentPopups": True,
"includeDocumentLinks": True
}
},
"metadata": {},
"custom_interval_minutes": 123,
"analysis_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
type: 'domain',
identifier: '<string>',
workspace_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
label: '<string>',
crawl_config: {
maxDepth: 2,
maxPages: 2,
includePaths: ['<string>'],
excludePaths: ['<string>'],
selectedUrls: ['<string>'],
crawlOptions: {
waitAfterLoad: 15000,
timeout: 30500,
includeTags: ['<string>'],
excludeTags: ['<string>'],
useHttp: true,
useLlmsTxt: true,
removeConsentPopups: true,
includeDocumentLinks: true
}
},
metadata: {},
custom_interval_minutes: 123,
analysis_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://bulkgrid.com/api/v1/sources', 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://bulkgrid.com/api/v1/sources",
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([
'type' => 'domain',
'identifier' => '<string>',
'workspace_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'label' => '<string>',
'crawl_config' => [
'maxDepth' => 2,
'maxPages' => 2,
'includePaths' => [
'<string>'
],
'excludePaths' => [
'<string>'
],
'selectedUrls' => [
'<string>'
],
'crawlOptions' => [
'waitAfterLoad' => 15000,
'timeout' => 30500,
'includeTags' => [
'<string>'
],
'excludeTags' => [
'<string>'
],
'useHttp' => true,
'useLlmsTxt' => true,
'removeConsentPopups' => true,
'includeDocumentLinks' => true
]
],
'metadata' => [
],
'custom_interval_minutes' => 123,
'analysis_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://bulkgrid.com/api/v1/sources"
payload := strings.NewReader("{\n \"type\": \"domain\",\n \"identifier\": \"<string>\",\n \"workspace_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"label\": \"<string>\",\n \"crawl_config\": {\n \"maxDepth\": 2,\n \"maxPages\": 2,\n \"includePaths\": [\n \"<string>\"\n ],\n \"excludePaths\": [\n \"<string>\"\n ],\n \"selectedUrls\": [\n \"<string>\"\n ],\n \"crawlOptions\": {\n \"waitAfterLoad\": 15000,\n \"timeout\": 30500,\n \"includeTags\": [\n \"<string>\"\n ],\n \"excludeTags\": [\n \"<string>\"\n ],\n \"useHttp\": true,\n \"useLlmsTxt\": true,\n \"removeConsentPopups\": true,\n \"includeDocumentLinks\": true\n }\n },\n \"metadata\": {},\n \"custom_interval_minutes\": 123,\n \"analysis_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://bulkgrid.com/api/v1/sources")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"domain\",\n \"identifier\": \"<string>\",\n \"workspace_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"label\": \"<string>\",\n \"crawl_config\": {\n \"maxDepth\": 2,\n \"maxPages\": 2,\n \"includePaths\": [\n \"<string>\"\n ],\n \"excludePaths\": [\n \"<string>\"\n ],\n \"selectedUrls\": [\n \"<string>\"\n ],\n \"crawlOptions\": {\n \"waitAfterLoad\": 15000,\n \"timeout\": 30500,\n \"includeTags\": [\n \"<string>\"\n ],\n \"excludeTags\": [\n \"<string>\"\n ],\n \"useHttp\": true,\n \"useLlmsTxt\": true,\n \"removeConsentPopups\": true,\n \"includeDocumentLinks\": true\n }\n },\n \"metadata\": {},\n \"custom_interval_minutes\": 123,\n \"analysis_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://bulkgrid.com/api/v1/sources")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"domain\",\n \"identifier\": \"<string>\",\n \"workspace_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"label\": \"<string>\",\n \"crawl_config\": {\n \"maxDepth\": 2,\n \"maxPages\": 2,\n \"includePaths\": [\n \"<string>\"\n ],\n \"excludePaths\": [\n \"<string>\"\n ],\n \"selectedUrls\": [\n \"<string>\"\n ],\n \"crawlOptions\": {\n \"waitAfterLoad\": 15000,\n \"timeout\": 30500,\n \"includeTags\": [\n \"<string>\"\n ],\n \"excludeTags\": [\n \"<string>\"\n ],\n \"useHttp\": true,\n \"useLlmsTxt\": true,\n \"removeConsentPopups\": true,\n \"includeDocumentLinks\": true\n }\n },\n \"metadata\": {},\n \"custom_interval_minutes\": 123,\n \"analysis_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"source": {
"crawl_config": null,
"crawl_interval": "hourly",
"created_at": "<string>",
"created_by_user_id": "<string>",
"created_by_workspace_id": "<string>",
"custom_interval_minutes": 123,
"icon_url": "<string>",
"id": "<string>",
"identifier": "<string>",
"integration_type": "web",
"is_active": true,
"label": "<string>",
"last_crawled_at": "<string>",
"max_depth": 123,
"max_items": 123,
"metadata": null,
"next_crawl_at": "<string>",
"public_source_id": "<string>",
"source_mode": "discover",
"total_items_found": 123,
"type": "domain",
"updated_at": "<string>",
"visibility": "public",
"workspace_id": "<string>"
},
"created": true
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}Sources
Create or subscribe to a source
Required permission: sources:write.
POST
/
api
/
v1
/
sources
Create or subscribe to a source
curl --request POST \
--url https://bulkgrid.com/api/v1/sources \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"type": "domain",
"identifier": "<string>",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"crawl_config": {
"maxDepth": 2,
"maxPages": 2,
"includePaths": [
"<string>"
],
"excludePaths": [
"<string>"
],
"selectedUrls": [
"<string>"
],
"crawlOptions": {
"waitAfterLoad": 15000,
"timeout": 30500,
"includeTags": [
"<string>"
],
"excludeTags": [
"<string>"
],
"useHttp": true,
"useLlmsTxt": true,
"removeConsentPopups": true,
"includeDocumentLinks": true
}
},
"metadata": {},
"custom_interval_minutes": 123,
"analysis_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://bulkgrid.com/api/v1/sources"
payload = {
"type": "domain",
"identifier": "<string>",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"label": "<string>",
"crawl_config": {
"maxDepth": 2,
"maxPages": 2,
"includePaths": ["<string>"],
"excludePaths": ["<string>"],
"selectedUrls": ["<string>"],
"crawlOptions": {
"waitAfterLoad": 15000,
"timeout": 30500,
"includeTags": ["<string>"],
"excludeTags": ["<string>"],
"useHttp": True,
"useLlmsTxt": True,
"removeConsentPopups": True,
"includeDocumentLinks": True
}
},
"metadata": {},
"custom_interval_minutes": 123,
"analysis_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
type: 'domain',
identifier: '<string>',
workspace_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
label: '<string>',
crawl_config: {
maxDepth: 2,
maxPages: 2,
includePaths: ['<string>'],
excludePaths: ['<string>'],
selectedUrls: ['<string>'],
crawlOptions: {
waitAfterLoad: 15000,
timeout: 30500,
includeTags: ['<string>'],
excludeTags: ['<string>'],
useHttp: true,
useLlmsTxt: true,
removeConsentPopups: true,
includeDocumentLinks: true
}
},
metadata: {},
custom_interval_minutes: 123,
analysis_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://bulkgrid.com/api/v1/sources', 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://bulkgrid.com/api/v1/sources",
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([
'type' => 'domain',
'identifier' => '<string>',
'workspace_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'label' => '<string>',
'crawl_config' => [
'maxDepth' => 2,
'maxPages' => 2,
'includePaths' => [
'<string>'
],
'excludePaths' => [
'<string>'
],
'selectedUrls' => [
'<string>'
],
'crawlOptions' => [
'waitAfterLoad' => 15000,
'timeout' => 30500,
'includeTags' => [
'<string>'
],
'excludeTags' => [
'<string>'
],
'useHttp' => true,
'useLlmsTxt' => true,
'removeConsentPopups' => true,
'includeDocumentLinks' => true
]
],
'metadata' => [
],
'custom_interval_minutes' => 123,
'analysis_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://bulkgrid.com/api/v1/sources"
payload := strings.NewReader("{\n \"type\": \"domain\",\n \"identifier\": \"<string>\",\n \"workspace_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"label\": \"<string>\",\n \"crawl_config\": {\n \"maxDepth\": 2,\n \"maxPages\": 2,\n \"includePaths\": [\n \"<string>\"\n ],\n \"excludePaths\": [\n \"<string>\"\n ],\n \"selectedUrls\": [\n \"<string>\"\n ],\n \"crawlOptions\": {\n \"waitAfterLoad\": 15000,\n \"timeout\": 30500,\n \"includeTags\": [\n \"<string>\"\n ],\n \"excludeTags\": [\n \"<string>\"\n ],\n \"useHttp\": true,\n \"useLlmsTxt\": true,\n \"removeConsentPopups\": true,\n \"includeDocumentLinks\": true\n }\n },\n \"metadata\": {},\n \"custom_interval_minutes\": 123,\n \"analysis_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://bulkgrid.com/api/v1/sources")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"domain\",\n \"identifier\": \"<string>\",\n \"workspace_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"label\": \"<string>\",\n \"crawl_config\": {\n \"maxDepth\": 2,\n \"maxPages\": 2,\n \"includePaths\": [\n \"<string>\"\n ],\n \"excludePaths\": [\n \"<string>\"\n ],\n \"selectedUrls\": [\n \"<string>\"\n ],\n \"crawlOptions\": {\n \"waitAfterLoad\": 15000,\n \"timeout\": 30500,\n \"includeTags\": [\n \"<string>\"\n ],\n \"excludeTags\": [\n \"<string>\"\n ],\n \"useHttp\": true,\n \"useLlmsTxt\": true,\n \"removeConsentPopups\": true,\n \"includeDocumentLinks\": true\n }\n },\n \"metadata\": {},\n \"custom_interval_minutes\": 123,\n \"analysis_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://bulkgrid.com/api/v1/sources")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"domain\",\n \"identifier\": \"<string>\",\n \"workspace_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"label\": \"<string>\",\n \"crawl_config\": {\n \"maxDepth\": 2,\n \"maxPages\": 2,\n \"includePaths\": [\n \"<string>\"\n ],\n \"excludePaths\": [\n \"<string>\"\n ],\n \"selectedUrls\": [\n \"<string>\"\n ],\n \"crawlOptions\": {\n \"waitAfterLoad\": 15000,\n \"timeout\": 30500,\n \"includeTags\": [\n \"<string>\"\n ],\n \"excludeTags\": [\n \"<string>\"\n ],\n \"useHttp\": true,\n \"useLlmsTxt\": true,\n \"removeConsentPopups\": true,\n \"includeDocumentLinks\": true\n }\n },\n \"metadata\": {},\n \"custom_interval_minutes\": 123,\n \"analysis_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"source": {
"crawl_config": null,
"crawl_interval": "hourly",
"created_at": "<string>",
"created_by_user_id": "<string>",
"created_by_workspace_id": "<string>",
"custom_interval_minutes": 123,
"icon_url": "<string>",
"id": "<string>",
"identifier": "<string>",
"integration_type": "web",
"is_active": true,
"label": "<string>",
"last_crawled_at": "<string>",
"max_depth": 123,
"max_items": 123,
"metadata": null,
"next_crawl_at": "<string>",
"public_source_id": "<string>",
"source_mode": "discover",
"total_items_found": 123,
"type": "domain",
"updated_at": "<string>",
"visibility": "public",
"workspace_id": "<string>"
},
"created": true
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"details": "<unknown>"
}Authorizations
apiKeyAuthbearerAuth
Bulkgrid API key
Body
application/json
Available options:
domain Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Available options:
public, private Available options:
discover, selected_pages Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
hourly, daily, weekly, monthly, custom Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$