Search
K
Agents API

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

Get active deployment per environment

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

Path Parameters

agentIdstringrequired

Response

application/json

Successful response

ActiveDeploymentsResponse

The latest deployment for each environment (sandbox, pre-release,
live). Entries are null when no deployment exists for an environment.

activeDeploymentsobjectrequired

Latest deployment per environment (sandbox, pre-release, live). Value is null if no deployment exists for that environment.

get/v1/agents/{agentId}/deployments/active
 
application/json