Skip to main content
PUT
/
v1
/
hives
/
{hive_id}
Update a Specific Hive by ID
curl --request PUT \
  --url https://api.trata.ai/v1/hives/{hive_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "files": [
    {
      "id": "<string>",
      "orgId": "<string>",
      "fileName": "<string>",
      "fileUrl": "<string>",
      "createdBy": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedBy": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "hiveProps": {},
  "internalProps": {}
}
'
import requests

url = "https://api.trata.ai/v1/hives/{hive_id}"

payload = {
"url": "<string>",
"files": [
{
"id": "<string>",
"orgId": "<string>",
"fileName": "<string>",
"fileUrl": "<string>",
"createdBy": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"hiveProps": {},
"internalProps": {}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: '<string>',
files: [
{
id: '<string>',
orgId: '<string>',
fileName: '<string>',
fileUrl: '<string>',
createdBy: '<string>',
createdAt: '2023-11-07T05:31:56Z',
updatedBy: '<string>',
updatedAt: '2023-11-07T05:31:56Z'
}
],
hiveProps: {},
internalProps: {}
})
};

fetch('https://api.trata.ai/v1/hives/{hive_id}', 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.trata.ai/v1/hives/{hive_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'url' => '<string>',
'files' => [
[
'id' => '<string>',
'orgId' => '<string>',
'fileName' => '<string>',
'fileUrl' => '<string>',
'createdBy' => '<string>',
'createdAt' => '2023-11-07T05:31:56Z',
'updatedBy' => '<string>',
'updatedAt' => '2023-11-07T05:31:56Z'
]
],
'hiveProps' => [

],
'internalProps' => [

]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.trata.ai/v1/hives/{hive_id}"

payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"files\": [\n {\n \"id\": \"<string>\",\n \"orgId\": \"<string>\",\n \"fileName\": \"<string>\",\n \"fileUrl\": \"<string>\",\n \"createdBy\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"updatedBy\": \"<string>\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"hiveProps\": {},\n \"internalProps\": {}\n}")

req, _ := http.NewRequest("PUT", url, payload)

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.put("https://api.trata.ai/v1/hives/{hive_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"files\": [\n {\n \"id\": \"<string>\",\n \"orgId\": \"<string>\",\n \"fileName\": \"<string>\",\n \"fileUrl\": \"<string>\",\n \"createdBy\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"updatedBy\": \"<string>\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"hiveProps\": {},\n \"internalProps\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.trata.ai/v1/hives/{hive_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"files\": [\n {\n \"id\": \"<string>\",\n \"orgId\": \"<string>\",\n \"fileName\": \"<string>\",\n \"fileUrl\": \"<string>\",\n \"createdBy\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"updatedBy\": \"<string>\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"hiveProps\": {},\n \"internalProps\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "id": "hiv.1727418138.IPGwVl1f",
  "orgId": "org.1726902940.GZChqlpU",
  "content": {
    "hiveType": "WEBSITE",
    "url": "https://www.cotekoreansteakhouse.com/",
    "hiveProps": {
      "crawl_child_pages": true
    }
  },
  "status": "completed",
  "createdBy": "org.1726902940.GZChqlpU",
  "createdAt": "2024-09-27T06:22:18.000277",
  "updatedBy": "trata-system",
  "updatedAt": "2024-09-27T06:27:34.276065"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

hive_id
string
required

ID of the hive

Body

application/json
hiveType
enum<string>
required
Available options:
WEBSITE,
GOOGLE_DOCS,
DOCS,
TRANSCRIPTS
url
string | null

URL of the content

Required string length: 1 - 512
files
Files · object[] | null

List of files to be referenced for the hive

hiveProps
Hiveprops · object | null

To recursively crawl child pages, add this as props {"crawl_child_pages": true}, "depth": "3"

internalProps
Internalprops · object | null

To add any internal props, add this as props {"last_crawl_time": "123123123123"}

Response

Hive updated successfully

Reference to all business knowledge base will be stored in Hive

content
HiveContent · object
required
status
string
required
id
string
orgId
string
createdBy
string
createdAt
string<date-time>
updatedBy
string
updatedAt
string<date-time>