Get Text Entry

Retrieves a specific text-based knowledge base entry by its unique ID. Use this endpoint to inspect the content and status of a text entry.

GET /ai-agents/agent-builder/knowledge-base/text/{uniqueId}

Get Text Entry

cURL

curl --request GET \
  --url https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/knowledge-base/text/{uniqueId} \
  --header 'apikey: <api-key>'

import requests

url = "https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/knowledge-base/text/{uniqueId}"

headers = {"apikey": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {apikey: '<api-key>'}};

fetch('https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/knowledge-base/text/{uniqueId}', 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://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/knowledge-base/text/{uniqueId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "apikey: <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"
	"net/http"
	"io"
)

func main() {

	url := "https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/knowledge-base/text/{uniqueId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("apikey", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/knowledge-base/text/{uniqueId}")
  .header("apikey", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{appId}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/knowledge-base/text/{uniqueId}")

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

request = Net::HTTP::Get.new(url)
request["apikey"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "data": {
    "uniqueId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "title": "Company Policy Document",
    "text": "This document outlines...",
    "fileName": "company-policy-document.md",
    "s3Key": "my-app-id/text/f47ac10b/company-policy-document.md",
    "status": "indexed",
    "vectorizationStatus": "completed",
    "createdAt": 1700000000000,
    "updatedAt": 1700000000000,
    "isActive": true
  }
}

Authorizations

apikey · string · header · required

API Key (i.e. Rest API Key from the Dashboard).

Path Parameters

uniqueId · string · required

Unique text detail ID

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

Response

200 - application/json

Text detail retrieved successfully

data · object

Show child attributes