Skip to content

Create a knowledge collection

POST
/voice/collections

Create an empty collection for an agent to retrieve from.

Voice takes name and description as QUERY parameters. They are a JSON body here because a description is prose - putting it in a URL means length limits and encoding bugs for the one field most likely to contain a newline. The bounds are voice’s own.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

A new knowledge collection. Bounds mirror voice’s own Query limits.

object
description
Any of:
string
<= 500 characters
name
required

Collection name.

string
>= 2 characters <= 100 characters

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