Skip to main content
POST
/
v1
/
hives
Create a New Hive
curl --request POST \
  --url https://api.trata.ai/v1/hives \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "hiveType": "WEBSITE",
  "url": "<string>",
  "file_ids": [
    "<string>"
  ],
  "hiveProps": {}
}'
{
  "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"
}

Authorizations

​
Authorization
string
header
required

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

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
​
file_ids
string[] | null

List of file ids to be referenced for the hive

​
hiveProps
object | null

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

Response

Hive created successfully

Reference to all business knowledge base will be stored in Hive

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