curl --request POST \
--url https://api-prod.studio.getsupervisor.ai/v1/knowledge-bases \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-workspace-id: <x-workspace-id>' \
--data '
{
"name": "Manuales de cobranza",
"description": "Lo que el agente consulta durante la llamada",
"uploadIds": [
"7f3a1b2c-9d4e-4f6a-8b1c-2d3e4f5a6b7c",
"9a1e5d7b-3c2f-4a8e-9b0d-1e2f3a4b5c6d"
]
}
'import requests
url = "https://api-prod.studio.getsupervisor.ai/v1/knowledge-bases"
payload = {
"name": "Manuales de cobranza",
"description": "Lo que el agente consulta durante la llamada",
"uploadIds": ["7f3a1b2c-9d4e-4f6a-8b1c-2d3e4f5a6b7c", "9a1e5d7b-3c2f-4a8e-9b0d-1e2f3a4b5c6d"]
}
headers = {
"x-workspace-id": "<x-workspace-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-workspace-id': '<x-workspace-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Manuales de cobranza',
description: 'Lo que el agente consulta durante la llamada',
uploadIds: ['7f3a1b2c-9d4e-4f6a-8b1c-2d3e4f5a6b7c', '9a1e5d7b-3c2f-4a8e-9b0d-1e2f3a4b5c6d']
})
};
fetch('https://api-prod.studio.getsupervisor.ai/v1/knowledge-bases', 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-prod.studio.getsupervisor.ai/v1/knowledge-bases",
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([
'name' => 'Manuales de cobranza',
'description' => 'Lo que el agente consulta durante la llamada',
'uploadIds' => [
'7f3a1b2c-9d4e-4f6a-8b1c-2d3e4f5a6b7c',
'9a1e5d7b-3c2f-4a8e-9b0d-1e2f3a4b5c6d'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-workspace-id: <x-workspace-id>"
],
]);
$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-prod.studio.getsupervisor.ai/v1/knowledge-bases"
payload := strings.NewReader("{\n \"name\": \"Manuales de cobranza\",\n \"description\": \"Lo que el agente consulta durante la llamada\",\n \"uploadIds\": [\n \"7f3a1b2c-9d4e-4f6a-8b1c-2d3e4f5a6b7c\",\n \"9a1e5d7b-3c2f-4a8e-9b0d-1e2f3a4b5c6d\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-workspace-id", "<x-workspace-id>")
req.Header.Add("Authorization", "Bearer <token>")
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-prod.studio.getsupervisor.ai/v1/knowledge-bases")
.header("x-workspace-id", "<x-workspace-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Manuales de cobranza\",\n \"description\": \"Lo que el agente consulta durante la llamada\",\n \"uploadIds\": [\n \"7f3a1b2c-9d4e-4f6a-8b1c-2d3e4f5a6b7c\",\n \"9a1e5d7b-3c2f-4a8e-9b0d-1e2f3a4b5c6d\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-prod.studio.getsupervisor.ai/v1/knowledge-bases")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-workspace-id"] = '<x-workspace-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Manuales de cobranza\",\n \"description\": \"Lo que el agente consulta durante la llamada\",\n \"uploadIds\": [\n \"7f3a1b2c-9d4e-4f6a-8b1c-2d3e4f5a6b7c\",\n \"9a1e5d7b-3c2f-4a8e-9b0d-1e2f3a4b5c6d\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"status": "queued",
"documentCount": 123,
"totalSizeBytes": 123,
"agentCount": 123,
"documents": [
{
"id": "<string>",
"name": "<string>",
"sizeBytes": 123,
"url": "<string>"
}
],
"errorMessages": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"code": "<string>",
"message": "<string>",
"details": {
"subcode": "<string>",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"code": "<string>",
"message": "<string>",
"details": {
"subcode": "<string>",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"code": "<string>",
"message": "<string>",
"details": {
"subcode": "<string>",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"code": "<string>",
"message": "<string>",
"details": {
"subcode": "<string>",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Dar de alta una base de conocimiento
Crea la base con archivos que el cliente ya subió y confirmó. En el cuerpo no viaja
ni un byte: sólo los uploadId de esas subidas.
El flujo completo son cuatro pasos: pedir las URLs con POST /v1/uploads/knowledge-sources,
subir cada archivo con un PUT directo al almacén, confirmarlo con
POST /v1/uploads/{uploadId}/confirm, y nombrarlos aquí. Un archivo sin confirmar no
sirve: sin verificar no se sabe si sus bytes son lo que dice su nombre.
Responde 202 y no 201 porque cuando esta llamada vuelve, lo del cliente está a
salvo —la base y sus documentos están escritos— pero el proveedor todavía no lo sabe. La
base nace en queued y el listado la ve pasar a ready.
Es idempotente sin clave adicional: un archivo sólo puede pertenecer a una base, así
que repetir la petición con los mismos uploadIds devuelve la base que ya los tiene en
vez de crear otra. Un doble clic o un reintento tras un timeout son seguros.
Y es todo o nada: si un archivo no vale, no se crea nada y el error nombra cuáles y por qué. Una base con parte de los documentos sería indistinguible de una completa.
curl --request POST \
--url https://api-prod.studio.getsupervisor.ai/v1/knowledge-bases \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-workspace-id: <x-workspace-id>' \
--data '
{
"name": "Manuales de cobranza",
"description": "Lo que el agente consulta durante la llamada",
"uploadIds": [
"7f3a1b2c-9d4e-4f6a-8b1c-2d3e4f5a6b7c",
"9a1e5d7b-3c2f-4a8e-9b0d-1e2f3a4b5c6d"
]
}
'import requests
url = "https://api-prod.studio.getsupervisor.ai/v1/knowledge-bases"
payload = {
"name": "Manuales de cobranza",
"description": "Lo que el agente consulta durante la llamada",
"uploadIds": ["7f3a1b2c-9d4e-4f6a-8b1c-2d3e4f5a6b7c", "9a1e5d7b-3c2f-4a8e-9b0d-1e2f3a4b5c6d"]
}
headers = {
"x-workspace-id": "<x-workspace-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-workspace-id': '<x-workspace-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Manuales de cobranza',
description: 'Lo que el agente consulta durante la llamada',
uploadIds: ['7f3a1b2c-9d4e-4f6a-8b1c-2d3e4f5a6b7c', '9a1e5d7b-3c2f-4a8e-9b0d-1e2f3a4b5c6d']
})
};
fetch('https://api-prod.studio.getsupervisor.ai/v1/knowledge-bases', 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-prod.studio.getsupervisor.ai/v1/knowledge-bases",
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([
'name' => 'Manuales de cobranza',
'description' => 'Lo que el agente consulta durante la llamada',
'uploadIds' => [
'7f3a1b2c-9d4e-4f6a-8b1c-2d3e4f5a6b7c',
'9a1e5d7b-3c2f-4a8e-9b0d-1e2f3a4b5c6d'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-workspace-id: <x-workspace-id>"
],
]);
$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-prod.studio.getsupervisor.ai/v1/knowledge-bases"
payload := strings.NewReader("{\n \"name\": \"Manuales de cobranza\",\n \"description\": \"Lo que el agente consulta durante la llamada\",\n \"uploadIds\": [\n \"7f3a1b2c-9d4e-4f6a-8b1c-2d3e4f5a6b7c\",\n \"9a1e5d7b-3c2f-4a8e-9b0d-1e2f3a4b5c6d\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-workspace-id", "<x-workspace-id>")
req.Header.Add("Authorization", "Bearer <token>")
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-prod.studio.getsupervisor.ai/v1/knowledge-bases")
.header("x-workspace-id", "<x-workspace-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Manuales de cobranza\",\n \"description\": \"Lo que el agente consulta durante la llamada\",\n \"uploadIds\": [\n \"7f3a1b2c-9d4e-4f6a-8b1c-2d3e4f5a6b7c\",\n \"9a1e5d7b-3c2f-4a8e-9b0d-1e2f3a4b5c6d\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-prod.studio.getsupervisor.ai/v1/knowledge-bases")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-workspace-id"] = '<x-workspace-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Manuales de cobranza\",\n \"description\": \"Lo que el agente consulta durante la llamada\",\n \"uploadIds\": [\n \"7f3a1b2c-9d4e-4f6a-8b1c-2d3e4f5a6b7c\",\n \"9a1e5d7b-3c2f-4a8e-9b0d-1e2f3a4b5c6d\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"status": "queued",
"documentCount": 123,
"totalSizeBytes": 123,
"agentCount": 123,
"documents": [
{
"id": "<string>",
"name": "<string>",
"sizeBytes": 123,
"url": "<string>"
}
],
"errorMessages": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"code": "<string>",
"message": "<string>",
"details": {
"subcode": "<string>",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"code": "<string>",
"message": "<string>",
"details": {
"subcode": "<string>",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"code": "<string>",
"message": "<string>",
"details": {
"subcode": "<string>",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"code": "<string>",
"message": "<string>",
"details": {
"subcode": "<string>",
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Identificador del workspace multi-tenant.
Body
Un nombre y los archivos ya subidos. Cero bytes: lo que viaja son referencias a objetos que ya están en el almacén y ya se verificaron.
1 - 120De 1 a 25 archivos confirmados, sin repetir. El mínimo no es cosmético: el proveedor
rechaza una base sin fuentes, así que nace con al menos un documento o no nace. El
máximo es el tope del namespace knowledge-sources.
1 - 25 elements500Response
Aceptada. La base existe con sus documentos y la ingesta está encolada; el proveedor
todavía no la conoce, así que documentCount y totalSizeBytes vienen en cero hasta
que él los reporte.
Identificador de la base en Agents Studio. La referencia interna del proveedor no se publica.
queued: dada de alta, todavía no existe en el proveedor. syncing: el proveedor
la está indexando. ready: el agente ya puede consultarla. error: el indexado
falló, y errorMessages dice por qué.
queued, syncing, ready, error Cuántos agentes del workspace consultan esta base. Cuenta agentes, no conexiones: un agente con dos conexiones a la misma base suma uno.
Cero significa que ninguno la consulta, y por tanto que retirarla no cambia el comportamiento de nadie.
Vacío en el listado a propósito. Los documentos los tiene el proveedor y traerlos costaría una llamada por elemento de la página. Vienen en el detalle.
Show child attributes
Show child attributes
Vacío salvo que status sea error.
