API Reference
Discover knowledge crawl jobs
Find recent crawl job IDs after a lost receipt or to diagnose queued/running/failed processing. Default active returns queued/running jobs; all includes completed/failed. Bounded recent list (no cursor/history completeness); copy jobId to get_knowledge_crawl. A queued job is not usable indexed knowledge. Required permission: knowledge:read. Connected business only; no tenant override.
GET
/
knowledge
/
url
/
crawl
Discover knowledge crawl jobs
curl --request GET \
--url https://platform-api.visitoai.com/m2m/v1/knowledge/url/crawl \
--header 'Authorization: Bearer <token>'import requests
url = "https://platform-api.visitoai.com/m2m/v1/knowledge/url/crawl"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform-api.visitoai.com/m2m/v1/knowledge/url/crawl', 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://platform-api.visitoai.com/m2m/v1/knowledge/url/crawl",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://platform-api.visitoai.com/m2m/v1/knowledge/url/crawl"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://platform-api.visitoai.com/m2m/v1/knowledge/url/crawl")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform-api.visitoai.com/m2m/v1/knowledge/url/crawl")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"jobs": [
{
"jobId": "<string>",
"status": "queued",
"progress": {
"phase": "queued",
"pagesDiscovered": 123,
"pagesProcessed": 123,
"chunksEmbedded": 123
},
"chunks": 123,
"url": "<string>",
"crawlDepth": 123,
"maxPages": 123,
"sourceId": "<string>",
"error": {
"code": "<string>",
"message": "<string>"
},
"websiteId": "<string>",
"websiteGenerationId": "<string>",
"createdAt": "<string>",
"startedAt": "<string>",
"completedAt": "<string>",
"updatedAt": "<string>",
"snapshotPages": 1
}
]
}Autorizaciones
Server-side tenant-scoped credential created from Build > API Keys.
Parámetros de consulta
Recent jobs limit, default twenty, maximum one hundred; no pagination.
Rango requerido:
1 <= x <= 100Default active means queued/running, not source activation.
Opciones disponibles:
active, all Respuesta
Success
Maximum array length:
100Show child attributes
Show child attributes
⌘I
Discover knowledge crawl jobs
curl --request GET \
--url https://platform-api.visitoai.com/m2m/v1/knowledge/url/crawl \
--header 'Authorization: Bearer <token>'import requests
url = "https://platform-api.visitoai.com/m2m/v1/knowledge/url/crawl"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://platform-api.visitoai.com/m2m/v1/knowledge/url/crawl', 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://platform-api.visitoai.com/m2m/v1/knowledge/url/crawl",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://platform-api.visitoai.com/m2m/v1/knowledge/url/crawl"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://platform-api.visitoai.com/m2m/v1/knowledge/url/crawl")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform-api.visitoai.com/m2m/v1/knowledge/url/crawl")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"jobs": [
{
"jobId": "<string>",
"status": "queued",
"progress": {
"phase": "queued",
"pagesDiscovered": 123,
"pagesProcessed": 123,
"chunksEmbedded": 123
},
"chunks": 123,
"url": "<string>",
"crawlDepth": 123,
"maxPages": 123,
"sourceId": "<string>",
"error": {
"code": "<string>",
"message": "<string>"
},
"websiteId": "<string>",
"websiteGenerationId": "<string>",
"createdAt": "<string>",
"startedAt": "<string>",
"completedAt": "<string>",
"updatedAt": "<string>",
"snapshotPages": 1
}
]
}