Search
K
Agents API

Create knowledge base topic

post
https://api.dev.poly.ai/v1/agents/{agentId}/branches/{branchId}/knowledge-base/topics

Body

application/json

CreateKnowledgeBaseTopicBody

* Additional properties are NOT allowed.
namestringrequired

>= 1 characters

contentstringrequired

>= 1 characters

actionsstring
exampleQueriesobject
* Additional properties are NOT allowed.
Show Child Parameters
isActiveboolean

Response

201

Created topic

post/v1/agents/{agentId}/branches/{branchId}/knowledge-base/topics

Body

{ "name": "name", "content": "content" }
 
201

Get knowledge base topic

get
https://api.dev.poly.ai/v1/agents/{agentId}/branches/{branchId}/knowledge-base/topics/{topicId}

Response

Knowledge base topic

get/v1/agents/{agentId}/branches/{branchId}/knowledge-base/topics/{topicId}
 

Delete knowledge base topic

delete
https://api.dev.poly.ai/v1/agents/{agentId}/branches/{branchId}/knowledge-base/topics/{topicId}

Response

204

Topic deleted

delete/v1/agents/{agentId}/branches/{branchId}/knowledge-base/topics/{topicId}
 
204

Update knowledge base topic

patch
https://api.dev.poly.ai/v1/agents/{agentId}/branches/{branchId}/knowledge-base/topics/{topicId}

Body

application/json

UpdateKnowledgeBaseTopicBody

* Additional properties are NOT allowed.
namestring

>= 1 characters

contentstring
actionsstring
exampleQueriesobject
* Additional properties are NOT allowed.
Show Child Parameters
isActiveboolean

Response

Topic updated

patch/v1/agents/{agentId}/branches/{branchId}/knowledge-base/topics/{topicId}

Body

{}
 

List deployments for an environment

get
https://api.dev.poly.ai/v1/agents/{agentId}/deployments

Query Parameters

environmentstringrequired

Environment to list deployments for (sandbox, pre-release, live)

Allowed values:sandboxpre-releaselive

limitinteger

Max number of deployments to return

Path Parameters

agentIdstringrequired

Response

application/json

Successful response

GetDeploymentsResponse

Deployments for the requested environment, ordered newest first.

deploymentsarray[object]required

A deployment of an agent version to a specific environment, plus
who created it and when.

Show Child Parameters
get/v1/agents/{agentId}/deployments
 
application/json