Create Text Entry

Creates a new text-based knowledge base entry. Use this endpoint to add custom text content that agents can reference during conversations.

Processing: Accepts a title and text content, converts it to a Markdown file, and adds it to the knowledge base for indexing.

POST /ai-agents/agent-builder/knowledge-base/text

Create Text Entry

cURL

curl --request POST \
  --url https://{appid}.api-{region}.cometchat.io/v3/ai-agents/agent-builder/knowledge-base/text \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "title": "Company Policy Document",
  "text": "This document outlines the company policies and procedures for remote work, including communication guidelines, working hours expectations, and performance metrics."
}
'

200

{
  "success": true,
  "message": "Text detail created and uploaded successfully",
  "data": {
    "uniqueId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "title": "Company Policy Document",
    "fileName": "company-policy-document.md",
    "s3Key": "my-app-id/text/f47ac10b/company-policy-document.md",
    "status": "indexing"
  }
}

Authorizations

apikey · string · header · required

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

Body

application/json

title · string · required

Title of the text content

Maximum string length: 500

Example:

"Company Policy Document"

text · string · required

Text content to be processed

Maximum string length: 5000

Example:

"This document outlines the company policies and procedures..."

Response

200 - application/json

Text detail created and uploaded to S3 successfully

success · boolean

Example:

true

message · string

Example:

"Text detail created and uploaded successfully"

data · object

Show child attributes