Create new knowledge base items.
curl --request POST \
--url https://api.tryhamsa.com/v1/voice-agents/knowledge-base \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"itemName": "Product Documentation",
"itemUrl": "https://example.com/document.pdf",
"type": "TEXT",
"itemUrls": [
"https://example.com/document.pdf"
],
"content": "This is the content of the knowledge base item..."
}
]
}
'import requests
url = "https://api.tryhamsa.com/v1/voice-agents/knowledge-base"
payload = { "items": [
{
"itemName": "Product Documentation",
"itemUrl": "https://example.com/document.pdf",
"type": "TEXT",
"itemUrls": ["https://example.com/document.pdf"],
"content": "This is the content of the knowledge base item..."
}
] }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
itemName: 'Product Documentation',
itemUrl: 'https://example.com/document.pdf',
type: 'TEXT',
itemUrls: ['https://example.com/document.pdf'],
content: 'This is the content of the knowledge base item...'
}
]
})
};
fetch('https://api.tryhamsa.com/v1/voice-agents/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.tryhamsa.com/v1/voice-agents/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([
'items' => [
[
'itemName' => 'Product Documentation',
'itemUrl' => 'https://example.com/document.pdf',
'type' => 'TEXT',
'itemUrls' => [
'https://example.com/document.pdf'
],
'content' => 'This is the content of the knowledge base item...'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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.tryhamsa.com/v1/voice-agents/knowledge-base"
payload := strings.NewReader("{\n \"items\": [\n {\n \"itemName\": \"Product Documentation\",\n \"itemUrl\": \"https://example.com/document.pdf\",\n \"type\": \"TEXT\",\n \"itemUrls\": [\n \"https://example.com/document.pdf\"\n ],\n \"content\": \"This is the content of the knowledge base item...\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.tryhamsa.com/v1/voice-agents/knowledge-base")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"itemName\": \"Product Documentation\",\n \"itemUrl\": \"https://example.com/document.pdf\",\n \"type\": \"TEXT\",\n \"itemUrls\": [\n \"https://example.com/document.pdf\"\n ],\n \"content\": \"This is the content of the knowledge base item...\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tryhamsa.com/v1/voice-agents/knowledge-base")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"itemName\": \"Product Documentation\",\n \"itemUrl\": \"https://example.com/document.pdf\",\n \"type\": \"TEXT\",\n \"itemUrls\": [\n \"https://example.com/document.pdf\"\n ],\n \"content\": \"This is the content of the knowledge base item...\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": false,
"message": "success",
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"userId": "550e8400-e29b-41d4-a716-446655440000",
"projectId": "550e8400-e29b-41d4-a716-446655440000",
"itemName": "Product Documentation",
"fileSize": "2.5MB",
"type": "TEXT",
"status": "PROCESSED",
"failureReason": "File format not supported",
"content": "This is the content of the knowledge base item...",
"itemUrl": "https://example.com/document.pdf",
"itemUrls": [
"https://example.com/document.pdf"
],
"wordsNumber": 1298,
"extension": 1298,
"createdAt": "2024-01-15T10:30:00Z",
"isActive": true,
"used": true
}
}{
"code": 123,
"message": "<string>"
}{
"code": 123,
"message": "<string>"
}{
"code": 123,
"message": "<string>"
}Knowledge Base Routes
Create new knowledge base items.
POST
/
v1
/
voice-agents
/
knowledge-base
Create new knowledge base items.
curl --request POST \
--url https://api.tryhamsa.com/v1/voice-agents/knowledge-base \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"itemName": "Product Documentation",
"itemUrl": "https://example.com/document.pdf",
"type": "TEXT",
"itemUrls": [
"https://example.com/document.pdf"
],
"content": "This is the content of the knowledge base item..."
}
]
}
'import requests
url = "https://api.tryhamsa.com/v1/voice-agents/knowledge-base"
payload = { "items": [
{
"itemName": "Product Documentation",
"itemUrl": "https://example.com/document.pdf",
"type": "TEXT",
"itemUrls": ["https://example.com/document.pdf"],
"content": "This is the content of the knowledge base item..."
}
] }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
itemName: 'Product Documentation',
itemUrl: 'https://example.com/document.pdf',
type: 'TEXT',
itemUrls: ['https://example.com/document.pdf'],
content: 'This is the content of the knowledge base item...'
}
]
})
};
fetch('https://api.tryhamsa.com/v1/voice-agents/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.tryhamsa.com/v1/voice-agents/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([
'items' => [
[
'itemName' => 'Product Documentation',
'itemUrl' => 'https://example.com/document.pdf',
'type' => 'TEXT',
'itemUrls' => [
'https://example.com/document.pdf'
],
'content' => 'This is the content of the knowledge base item...'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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.tryhamsa.com/v1/voice-agents/knowledge-base"
payload := strings.NewReader("{\n \"items\": [\n {\n \"itemName\": \"Product Documentation\",\n \"itemUrl\": \"https://example.com/document.pdf\",\n \"type\": \"TEXT\",\n \"itemUrls\": [\n \"https://example.com/document.pdf\"\n ],\n \"content\": \"This is the content of the knowledge base item...\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.tryhamsa.com/v1/voice-agents/knowledge-base")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"itemName\": \"Product Documentation\",\n \"itemUrl\": \"https://example.com/document.pdf\",\n \"type\": \"TEXT\",\n \"itemUrls\": [\n \"https://example.com/document.pdf\"\n ],\n \"content\": \"This is the content of the knowledge base item...\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tryhamsa.com/v1/voice-agents/knowledge-base")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"items\": [\n {\n \"itemName\": \"Product Documentation\",\n \"itemUrl\": \"https://example.com/document.pdf\",\n \"type\": \"TEXT\",\n \"itemUrls\": [\n \"https://example.com/document.pdf\"\n ],\n \"content\": \"This is the content of the knowledge base item...\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": false,
"message": "success",
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"userId": "550e8400-e29b-41d4-a716-446655440000",
"projectId": "550e8400-e29b-41d4-a716-446655440000",
"itemName": "Product Documentation",
"fileSize": "2.5MB",
"type": "TEXT",
"status": "PROCESSED",
"failureReason": "File format not supported",
"content": "This is the content of the knowledge base item...",
"itemUrl": "https://example.com/document.pdf",
"itemUrls": [
"https://example.com/document.pdf"
],
"wordsNumber": 1298,
"extension": 1298,
"createdAt": "2024-01-15T10:30:00Z",
"isActive": true,
"used": true
}
}{
"code": 123,
"message": "<string>"
}{
"code": 123,
"message": "<string>"
}{
"code": 123,
"message": "<string>"
}Authorizations
Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token '
Body
application/json
Array of knowledge base items to be created.
Minimum array length:
1- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
Was this page helpful?
⌘I