Skip to main content
PATCH
Update knowledge base entry

Authorizations

Authorization
string
header
required

Use Authorization: Bearer tc_live_xxxxx

Headers

Idempotency-Key
string

Optional client-supplied idempotency key. When present, the gateway caches the response for 24 hours and returns the same response on retried requests with the same key (account-scoped). Safe for retries on network blips. Format: 8-255 ASCII characters from [A-Za-z0-9_-].

Required string length: 8 - 255
Pattern: ^[A-Za-z0-9_-]+$
Example:

"a1b2c3d4-e5f6-7890-abcd-ef0123456789"

Path Parameters

id
string<uuid>
required

Body

application/json

Every field is optional, but the body must include at least one.

name
string
Required string length: 1 - 100
content
string
Required string length: 50 - 10000
description_category
enum<string>

Category label for a knowledge base entry. Use custom with a custom_description for a free-form label.

Available options:
company_information,
product_catalog,
service_offerings,
restaurant_menu,
cocktail_bar_menu,
real_estate_properties,
faq_support,
pricing_packages,
policies_procedures,
contact_information,
custom,
residential_properties,
commercial_properties,
luxury_properties,
property_features,
food_menu,
bar_cocktails,
restaurant_location,
restaurant_hours,
restaurant_events,
business_header,
real_estate_header,
restaurant_header,
products_services_header,
support_header
custom_description
string | null
Required string length: 1 - 100

Response

OK

id
string<uuid>
required
account_id
string<uuid>
required
name
string
required
description_category
enum<string>
required

Category label for a knowledge base entry. Use custom with a custom_description for a free-form label.

Available options:
company_information,
product_catalog,
service_offerings,
restaurant_menu,
cocktail_bar_menu,
real_estate_properties,
faq_support,
pricing_packages,
policies_procedures,
contact_information,
custom,
residential_properties,
commercial_properties,
luxury_properties,
property_features,
food_menu,
bar_cocktails,
restaurant_location,
restaurant_hours,
restaurant_events,
business_header,
real_estate_header,
restaurant_header,
products_services_header,
support_header
custom_description
string | null
required
content
string
required
status
enum<string>
required

Processing status. Entries are usable once they carry content.

Available options:
draft,
processing,
active,
failed,
archived,
updating
created_at
string<date-time>
required
updated_at
string<date-time>
required