curl --request POST \
--url https://api.talkpilot.io/v1/agents/{agentId}/knowledge-base \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"title": "Oeffnungszeiten",
"content": "Unsere Oeffnungszeiten:\nMontag - Freitag: 08:00 - 18:00 Uhr\nSamstag: 09:00 - 14:00 Uhr\nSonntag: geschlossen\n"
}
'import requests
url = "https://api.talkpilot.io/v1/agents/{agentId}/knowledge-base"
payload = {
"title": "Oeffnungszeiten",
"content": "Unsere Oeffnungszeiten:
Montag - Freitag: 08:00 - 18:00 Uhr
Samstag: 09:00 - 14:00 Uhr
Sonntag: geschlossen
"
}
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({
title: 'Oeffnungszeiten',
content: 'Unsere Oeffnungszeiten:\nMontag - Freitag: 08:00 - 18:00 Uhr\nSamstag: 09:00 - 14:00 Uhr\nSonntag: geschlossen\n'
})
};
fetch('https://api.talkpilot.io/v1/agents/{agentId}/knowledge-base', 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://api.talkpilot.io/v1/agents/{agentId}/knowledge-base",
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([
'title' => 'Oeffnungszeiten',
'content' => 'Unsere Oeffnungszeiten:
Montag - Freitag: 08:00 - 18:00 Uhr
Samstag: 09:00 - 14:00 Uhr
Sonntag: geschlossen
'
]),
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://api.talkpilot.io/v1/agents/{agentId}/knowledge-base"
payload := strings.NewReader("{\n \"title\": \"Oeffnungszeiten\",\n \"content\": \"Unsere Oeffnungszeiten:\\nMontag - Freitag: 08:00 - 18:00 Uhr\\nSamstag: 09:00 - 14:00 Uhr\\nSonntag: geschlossen\\n\"\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://api.talkpilot.io/v1/agents/{agentId}/knowledge-base")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"Oeffnungszeiten\",\n \"content\": \"Unsere Oeffnungszeiten:\\nMontag - Freitag: 08:00 - 18:00 Uhr\\nSamstag: 09:00 - 14:00 Uhr\\nSonntag: geschlossen\\n\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.talkpilot.io/v1/agents/{agentId}/knowledge-base")
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 \"title\": \"Oeffnungszeiten\",\n \"content\": \"Unsere Oeffnungszeiten:\\nMontag - Freitag: 08:00 - 18:00 Uhr\\nSamstag: 09:00 - 14:00 Uhr\\nSonntag: geschlossen\\n\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scope": "agent",
"title": "<string>",
"content": "<string>",
"source_type": "manual",
"source_url": "<string>",
"status": "pending",
"chunk_count": 123,
"error_message": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Create a knowledge base document
Create a new knowledge base document with text content
(source_type: manual). The processing pipeline picks it up
(pending → processing → ready), chunks and embeds the content.
The status cannot be set via the API.
For file uploads and website imports, use the Dashboard UI.
curl --request POST \
--url https://api.talkpilot.io/v1/agents/{agentId}/knowledge-base \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"title": "Oeffnungszeiten",
"content": "Unsere Oeffnungszeiten:\nMontag - Freitag: 08:00 - 18:00 Uhr\nSamstag: 09:00 - 14:00 Uhr\nSonntag: geschlossen\n"
}
'import requests
url = "https://api.talkpilot.io/v1/agents/{agentId}/knowledge-base"
payload = {
"title": "Oeffnungszeiten",
"content": "Unsere Oeffnungszeiten:
Montag - Freitag: 08:00 - 18:00 Uhr
Samstag: 09:00 - 14:00 Uhr
Sonntag: geschlossen
"
}
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({
title: 'Oeffnungszeiten',
content: 'Unsere Oeffnungszeiten:\nMontag - Freitag: 08:00 - 18:00 Uhr\nSamstag: 09:00 - 14:00 Uhr\nSonntag: geschlossen\n'
})
};
fetch('https://api.talkpilot.io/v1/agents/{agentId}/knowledge-base', 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://api.talkpilot.io/v1/agents/{agentId}/knowledge-base",
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([
'title' => 'Oeffnungszeiten',
'content' => 'Unsere Oeffnungszeiten:
Montag - Freitag: 08:00 - 18:00 Uhr
Samstag: 09:00 - 14:00 Uhr
Sonntag: geschlossen
'
]),
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://api.talkpilot.io/v1/agents/{agentId}/knowledge-base"
payload := strings.NewReader("{\n \"title\": \"Oeffnungszeiten\",\n \"content\": \"Unsere Oeffnungszeiten:\\nMontag - Freitag: 08:00 - 18:00 Uhr\\nSamstag: 09:00 - 14:00 Uhr\\nSonntag: geschlossen\\n\"\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://api.talkpilot.io/v1/agents/{agentId}/knowledge-base")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"Oeffnungszeiten\",\n \"content\": \"Unsere Oeffnungszeiten:\\nMontag - Freitag: 08:00 - 18:00 Uhr\\nSamstag: 09:00 - 14:00 Uhr\\nSonntag: geschlossen\\n\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.talkpilot.io/v1/agents/{agentId}/knowledge-base")
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 \"title\": \"Oeffnungszeiten\",\n \"content\": \"Unsere Oeffnungszeiten:\\nMontag - Freitag: 08:00 - 18:00 Uhr\\nSamstag: 09:00 - 14:00 Uhr\\nSonntag: geschlossen\\n\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scope": "agent",
"title": "<string>",
"content": "<string>",
"source_type": "manual",
"source_url": "<string>",
"status": "pending",
"chunk_count": 123,
"error_message": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Authorizations
API key for external access. Format: tp_live_<32-hex-chars>.
Create keys in the TalkPilot Dashboard under Settings > API.
Path Parameters
Agent UUID
Body
Response
Document created (processing starts automatically)
Agent that created the document; null for organization-level documents
agent: created by this agent, writable. organization: shared company knowledge granted to this agent — readable, but write operations return 403 (manage it in the Dashboard)
agent, organization Document text content (null for file-based documents)
manual for documents created via the API; Dashboard uploads carry their file type or website
manual, pdf, csv, txt, docx, website Processing status, managed by the pipeline (read-only)
pending, processing, ready, error, failed Number of chunks created for embedding