Skip to content

Create the organisation's company knowledge

POST
/voice/company-knowledge

Set the org-wide knowledge for the first time.

There is ONE record per organisation - 409 if it already exists, and the update route is how you change it.

The body is forwarded as given rather than re-declared field by field. The record is twenty-odd fields wide and voice owns it; a mirror here would be a second place to forget one. org_id is the exception: it is stripped from anything the caller sends and set from the key, so a body cannot name another tenant.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Company knowledge record. company_name, company_description, value_proposition, pitch, bot_name, bot_personality, persona and target_audience are required; the list fields (company_services, company_products, customer_pain_points, faqs) default to empty.

object
key
additional properties
any

Responses

201

Successful Response

object
data
required

One voice object - a collection, an agent, a route, a chat.

Open-shaped: voice adds fields to these bodies on its own release cadence and a dropped-or-added key must not be a 500 in this service.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string