Skip to content

Give a skill collections to retrieve from

POST
/skills/{action_id}/collections

ADDITIVE, not a replace: attaching does not detach what is already there.

Takes effect on the next run. A collection with no vectors retrieves nothing - check /voice/collections/{id}/vector-status if a skill seems to be ignoring what you gave it.

Authorizations

Parameters

Path Parameters

action_id
required

Skill or workflow action_id.

string
>= 1 characters

Skill or workflow action_id.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
collection_ids
required

Collections to attach. Additive - existing links survive.

Array<integer>
>= 1 items

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