kb-ingest
- Written for
- + Written for
- Deprecated
- + Deprecated
- Applies to
- + Applies to
AdminUpdated Sep 19, 2026
GET
https://api.chatlychat.com/v1/kb-ingest/sourcesConfigured URL crawls and ingested PDFs, with their last run
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
Idempotency-Key | header | string | no | UUIDv4 or 16-128 char opaque token. Required on write endpoints in production. Replays return the cached response with `Idempotency-Replay: true`; reusing the key with a different body returns 409 idempotency_conflict. |
Responses
200
Code samples
cURL
curl -X GET "https://api.chatlychat.com/v1/kb-ingest/sources" \
-H "Idempotency-Key: <value>"TypeScript
const res = await fetch('https://api.chatlychat.com/v1/kb-ingest/sources', {
method: 'GET',
headers: {
'Idempotency-Key': '<value>',
},
});
const data = await res.json();Python
import requests
res = requests.request(
"GET",
"https://api.chatlychat.com/v1/kb-ingest/sources",
headers={
"Idempotency-Key": "<value>",
},
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://api.chatlychat.com/v1/kb-ingest/sources", nil)
req.Header.Set("Idempotency-Key", "<value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.chatlychat.com/v1/kb-ingest/sources');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Idempotency-Key: <value>']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://api.chatlychat.com/v1/kb-ingest/sources')
req = Net::HTTP::Get.new(uri)
req['Idempotency-Key'] = '<value>'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.chatlychat.com/v1/kb-ingest/sources"))
.header("Idempotency-Key", "<value>")
.GET()
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());GET
https://api.chatlychat.com/v1/kb-ingest/sources/{id}One source, including the skipped-page report from its last run
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | |
Idempotency-Key | header | string | no | UUIDv4 or 16-128 char opaque token. Required on write endpoints in production. Replays return the cached response with `Idempotency-Replay: true`; reusing the key with a different body returns 409 idempotency_conflict. |
Responses
200
Code samples
cURL
curl -X GET "https://api.chatlychat.com/v1/kb-ingest/sources/{id}" \
-H "Idempotency-Key: <value>"TypeScript
const res = await fetch('https://api.chatlychat.com/v1/kb-ingest/sources/{id}', {
method: 'GET',
headers: {
'Idempotency-Key': '<value>',
},
});
const data = await res.json();Python
import requests
res = requests.request(
"GET",
"https://api.chatlychat.com/v1/kb-ingest/sources/{id}",
headers={
"Idempotency-Key": "<value>",
},
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://api.chatlychat.com/v1/kb-ingest/sources/{id}", nil)
req.Header.Set("Idempotency-Key", "<value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.chatlychat.com/v1/kb-ingest/sources/{id}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Idempotency-Key: <value>']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://api.chatlychat.com/v1/kb-ingest/sources/{id}')
req = Net::HTTP::Get.new(uri)
req['Idempotency-Key'] = '<value>'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.chatlychat.com/v1/kb-ingest/sources/{id}"))
.header("Idempotency-Key", "<value>")
.GET()
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());DELETE
https://api.chatlychat.com/v1/kb-ingest/sources/{id}Remove a source, keeping the articles it created
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | |
Idempotency-Key | header | string | no | UUIDv4 or 16-128 char opaque token. Required on write endpoints in production. Replays return the cached response with `Idempotency-Replay: true`; reusing the key with a different body returns 409 idempotency_conflict. |
Responses
200
Code samples
cURL
curl -X DELETE "https://api.chatlychat.com/v1/kb-ingest/sources/{id}" \
-H "Idempotency-Key: <value>"TypeScript
const res = await fetch('https://api.chatlychat.com/v1/kb-ingest/sources/{id}', {
method: 'DELETE',
headers: {
'Idempotency-Key': '<value>',
},
});
const data = await res.json();Python
import requests
res = requests.request(
"DELETE",
"https://api.chatlychat.com/v1/kb-ingest/sources/{id}",
headers={
"Idempotency-Key": "<value>",
},
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("DELETE", "https://api.chatlychat.com/v1/kb-ingest/sources/{id}", nil)
req.Header.Set("Idempotency-Key", "<value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.chatlychat.com/v1/kb-ingest/sources/{id}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Idempotency-Key: <value>']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://api.chatlychat.com/v1/kb-ingest/sources/{id}')
req = Net::HTTP::Delete.new(uri)
req['Idempotency-Key'] = '<value>'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.chatlychat.com/v1/kb-ingest/sources/{id}"))
.header("Idempotency-Key", "<value>")
.method("DELETE", BodyPublishers.noBody())
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());PATCH
https://api.chatlychat.com/v1/kb-ingest/sources/{id}Rename, pause, re-schedule or publish/unpublish a source
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | |
Idempotency-Key | header | string | no | UUIDv4 or 16-128 char opaque token. Required on write endpoints in production. Replays return the cached response with `Idempotency-Replay: true`; reusing the key with a different body returns 409 idempotency_conflict. |
Request body application/json
{
"label": "string",
"status": "active",
"publishOnIngest": true,
"syncIntervalMinutes": 0
}Responses
200
Code samples
cURL
curl -X PATCH "https://api.chatlychat.com/v1/kb-ingest/sources/{id}" \
-H "Idempotency-Key: <value>" \
-H "Content-Type: application/json" \
-d '{"label":"string","status":"active","publishOnIngest":true,"syncIntervalMinutes":0}'TypeScript
const res = await fetch('https://api.chatlychat.com/v1/kb-ingest/sources/{id}', {
method: 'PATCH',
headers: {
'Idempotency-Key': '<value>',
'Content-Type': 'application/json',
},
body: JSON.stringify({"label":"string","status":"active","publishOnIngest":true,"syncIntervalMinutes":0}),
});
const data = await res.json();Python
import requests
res = requests.request(
"PATCH",
"https://api.chatlychat.com/v1/kb-ingest/sources/{id}",
headers={
"Idempotency-Key": "<value>",
"Content-Type": "application/json",
},
json={"label": "string", "status": "active", "publishOnIngest": True, "syncIntervalMinutes": 0},
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
req, _ := http.NewRequest("PATCH", "https://api.chatlychat.com/v1/kb-ingest/sources/{id}", strings.NewReader(`{"label":"string","status":"active","publishOnIngest":true,"syncIntervalMinutes":0}`))
req.Header.Set("Idempotency-Key", "<value>")
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.chatlychat.com/v1/kb-ingest/sources/{id}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Idempotency-Key: <value>', 'Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"label":"string","status":"active","publishOnIngest":true,"syncIntervalMinutes":0}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://api.chatlychat.com/v1/kb-ingest/sources/{id}')
req = Net::HTTP::Patch.new(uri)
req['Idempotency-Key'] = '<value>'
req['Content-Type'] = 'application/json'
req.body = '{"label":"string","status":"active","publishOnIngest":true,"syncIntervalMinutes":0}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.chatlychat.com/v1/kb-ingest/sources/{id}"))
.header("Idempotency-Key", "<value>")
.header("Content-Type", "application/json")
.method("PATCH", BodyPublishers.ofString("{\"label\":\"string\",\"status\":\"active\",\"publishOnIngest\":true,\"syncIntervalMinutes\":0}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());POST
https://api.chatlychat.com/v1/kb-ingest/sources/urlCrawl a page or a site section into the knowledge base
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
Idempotency-Key | header | string | no | UUIDv4 or 16-128 char opaque token. Required on write endpoints in production. Replays return the cached response with `Idempotency-Replay: true`; reusing the key with a different body returns 409 idempotency_conflict. |
Request body application/json
{
"url": "string",
"label": "string",
"collectionId": "string",
"publishOnIngest": true,
"syncIntervalMinutes": 0,
"maxPages": 0,
"maxDepth": 0,
"confineToPathPrefix": true,
"followPdfLinks": true
}Responses
201
Code samples
cURL
curl -X POST "https://api.chatlychat.com/v1/kb-ingest/sources/url" \
-H "Idempotency-Key: <value>" \
-H "Content-Type: application/json" \
-d '{"url":"string","label":"string","collectionId":"string","publishOnIngest":true,"syncIntervalMinutes":0,"maxPages":0,"maxDepth":0,"confineToPathPrefix":true,"followPdfLinks":true}'TypeScript
const res = await fetch('https://api.chatlychat.com/v1/kb-ingest/sources/url', {
method: 'POST',
headers: {
'Idempotency-Key': '<value>',
'Content-Type': 'application/json',
},
body: JSON.stringify({"url":"string","label":"string","collectionId":"string","publishOnIngest":true,"syncIntervalMinutes":0,"maxPages":0,"maxDepth":0,"confineToPathPrefix":true,"followPdfLinks":true}),
});
const data = await res.json();Python
import requests
res = requests.request(
"POST",
"https://api.chatlychat.com/v1/kb-ingest/sources/url",
headers={
"Idempotency-Key": "<value>",
"Content-Type": "application/json",
},
json={"url": "string", "label": "string", "collectionId": "string", "publishOnIngest": True, "syncIntervalMinutes": 0, "maxPages": 0, "maxDepth": 0, "confineToPathPrefix": True, "followPdfLinks": True},
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
req, _ := http.NewRequest("POST", "https://api.chatlychat.com/v1/kb-ingest/sources/url", strings.NewReader(`{"url":"string","label":"string","collectionId":"string","publishOnIngest":true,"syncIntervalMinutes":0,"maxPages":0,"maxDepth":0,"confineToPathPrefix":true,"followPdfLinks":true}`))
req.Header.Set("Idempotency-Key", "<value>")
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.chatlychat.com/v1/kb-ingest/sources/url');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Idempotency-Key: <value>', 'Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"url":"string","label":"string","collectionId":"string","publishOnIngest":true,"syncIntervalMinutes":0,"maxPages":0,"maxDepth":0,"confineToPathPrefix":true,"followPdfLinks":true}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://api.chatlychat.com/v1/kb-ingest/sources/url')
req = Net::HTTP::Post.new(uri)
req['Idempotency-Key'] = '<value>'
req['Content-Type'] = 'application/json'
req.body = '{"url":"string","label":"string","collectionId":"string","publishOnIngest":true,"syncIntervalMinutes":0,"maxPages":0,"maxDepth":0,"confineToPathPrefix":true,"followPdfLinks":true}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.chatlychat.com/v1/kb-ingest/sources/url"))
.header("Idempotency-Key", "<value>")
.header("Content-Type", "application/json")
.method("POST", BodyPublishers.ofString("{\"url\":\"string\",\"label\":\"string\",\"collectionId\":\"string\",\"publishOnIngest\":true,\"syncIntervalMinutes\":0,\"maxPages\":0,\"maxDepth\":0,\"confineToPathPrefix\":true,\"followPdfLinks\":true}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());POST
https://api.chatlychat.com/v1/kb-ingest/sources/pdfIngest a PDF already uploaded via POST /v1/uploads/presign — pass the key it returned
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
Idempotency-Key | header | string | no | UUIDv4 or 16-128 char opaque token. Required on write endpoints in production. Replays return the cached response with `Idempotency-Replay: true`; reusing the key with a different body returns 409 idempotency_conflict. |
Request body application/json
{
"storageKey": "string",
"fileName": "string",
"label": "string",
"collectionId": "string",
"publishOnIngest": true
}Responses
201
Code samples
cURL
curl -X POST "https://api.chatlychat.com/v1/kb-ingest/sources/pdf" \
-H "Idempotency-Key: <value>" \
-H "Content-Type: application/json" \
-d '{"storageKey":"string","fileName":"string","label":"string","collectionId":"string","publishOnIngest":true}'TypeScript
const res = await fetch('https://api.chatlychat.com/v1/kb-ingest/sources/pdf', {
method: 'POST',
headers: {
'Idempotency-Key': '<value>',
'Content-Type': 'application/json',
},
body: JSON.stringify({"storageKey":"string","fileName":"string","label":"string","collectionId":"string","publishOnIngest":true}),
});
const data = await res.json();Python
import requests
res = requests.request(
"POST",
"https://api.chatlychat.com/v1/kb-ingest/sources/pdf",
headers={
"Idempotency-Key": "<value>",
"Content-Type": "application/json",
},
json={"storageKey": "string", "fileName": "string", "label": "string", "collectionId": "string", "publishOnIngest": True},
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
req, _ := http.NewRequest("POST", "https://api.chatlychat.com/v1/kb-ingest/sources/pdf", strings.NewReader(`{"storageKey":"string","fileName":"string","label":"string","collectionId":"string","publishOnIngest":true}`))
req.Header.Set("Idempotency-Key", "<value>")
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.chatlychat.com/v1/kb-ingest/sources/pdf');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Idempotency-Key: <value>', 'Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"storageKey":"string","fileName":"string","label":"string","collectionId":"string","publishOnIngest":true}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://api.chatlychat.com/v1/kb-ingest/sources/pdf')
req = Net::HTTP::Post.new(uri)
req['Idempotency-Key'] = '<value>'
req['Content-Type'] = 'application/json'
req.body = '{"storageKey":"string","fileName":"string","label":"string","collectionId":"string","publishOnIngest":true}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.chatlychat.com/v1/kb-ingest/sources/pdf"))
.header("Idempotency-Key", "<value>")
.header("Content-Type", "application/json")
.method("POST", BodyPublishers.ofString("{\"storageKey\":\"string\",\"fileName\":\"string\",\"label\":\"string\",\"collectionId\":\"string\",\"publishOnIngest\":true}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());POST
https://api.chatlychat.com/v1/kb-ingest/sources/{id}/ingestIngest now — enqueues the same job the scheduler runs
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | |
Idempotency-Key | header | string | no | UUIDv4 or 16-128 char opaque token. Required on write endpoints in production. Replays return the cached response with `Idempotency-Replay: true`; reusing the key with a different body returns 409 idempotency_conflict. |
Responses
201
Code samples
cURL
curl -X POST "https://api.chatlychat.com/v1/kb-ingest/sources/{id}/ingest" \
-H "Idempotency-Key: <value>"TypeScript
const res = await fetch('https://api.chatlychat.com/v1/kb-ingest/sources/{id}/ingest', {
method: 'POST',
headers: {
'Idempotency-Key': '<value>',
},
});
const data = await res.json();Python
import requests
res = requests.request(
"POST",
"https://api.chatlychat.com/v1/kb-ingest/sources/{id}/ingest",
headers={
"Idempotency-Key": "<value>",
},
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("POST", "https://api.chatlychat.com/v1/kb-ingest/sources/{id}/ingest", nil)
req.Header.Set("Idempotency-Key", "<value>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.chatlychat.com/v1/kb-ingest/sources/{id}/ingest');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Idempotency-Key: <value>']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://api.chatlychat.com/v1/kb-ingest/sources/{id}/ingest')
req = Net::HTTP::Post.new(uri)
req['Idempotency-Key'] = '<value>'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.chatlychat.com/v1/kb-ingest/sources/{id}/ingest"))
.header("Idempotency-Key", "<value>")
.method("POST", BodyPublishers.noBody())
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Was this page helpful?