agentIdstringrequired
Publish the current draft to an environment
post
https://api.dev.poly.ai/v1/agents/{agentId}/deployments/publish
Path Parameters
Body
application/json
Body
application/json
PublishDeploymentBody
Metadata attached to a publish action, with an optional target environment.
deploymentMessagestring
Message describing this publish
Default:
environmentstring
Environment to publish to (defaults to sandbox)
Response
application/json
Response
application/json
Successful response
MutationDeploymentResponse
The resulting deployment from a promote / rollback / publish action,
plus any test runs it triggered.
deploymentobjectrequired
A deployment of an agent version to a specific environment, plus
who created it and when.
Show Child Parameters
testRunIdsarray[string]
IDs of test runs triggered by this deployment action
post/v1/agents/{agentId}/deployments/publish
Authentication
Path Parameters
Body
{}
application/json
Promote a deployment to the next environment
post
https://api.dev.poly.ai/v1/agents/{agentId}/deployments/{deploymentId}/promote
Path Parameters
agentIdstringrequired
deploymentIdstringrequired
Body
application/json
Body
application/json
PromoteDeploymentBody
Metadata attached to a promote action: an optional message and an
explicit target environment override.
deploymentMessagestring
Message describing this promotion
Default:
targetEnvironmentstring
Target environment to promote to. If omitted, promotes to the next environment in sequence (sandbox->pre-release->live).
Response
application/json
Response
application/json
Successful response
MutationDeploymentResponse
The resulting deployment from a promote / rollback / publish action,
plus any test runs it triggered.
deploymentobjectrequired
A deployment of an agent version to a specific environment, plus
who created it and when.
Show Child Parameters
testRunIdsarray[string]
IDs of test runs triggered by this deployment action
post/v1/agents/{agentId}/deployments/{deploymentId}/promote
Authentication
Path Parameters
Body
{}
application/json
Rollback to a previous deployment
post
https://api.dev.poly.ai/v1/agents/{agentId}/deployments/{deploymentId}/rollback
Path Parameters
agentIdstringrequired
deploymentIdstringrequired
Body
application/json
Body
application/json
RollbackDeploymentBody
Metadata attached to a rollback action.
deploymentMessagestring
Message describing this rollback
Default:
Response
application/json
Response
application/json
Successful response
MutationDeploymentResponse
The resulting deployment from a promote / rollback / publish action,
plus any test runs it triggered.
deploymentobjectrequired
A deployment of an agent version to a specific environment, plus
who created it and when.
Show Child Parameters
testRunIdsarray[string]
IDs of test runs triggered by this deployment action
post/v1/agents/{agentId}/deployments/{deploymentId}/rollback
Authentication
Path Parameters
Body
{}
application/json
List all config pages
get
https://api.dev.poly.ai/v1/agents/{agentId}/real-time-configs
Path Parameters
agentIdstringrequired
Response
application/json
Response
application/json
Successful response
GetConfigPagesResponse
One config page per environment (sandbox, pre-release, live).
configPagesarray[object]required
A real-time config page for one environment: its JSON Schema
definition plus the current variable values.
Show Child Parameters
get/v1/agents/{agentId}/real-time-configs
Authentication
Path Parameters
application/json
Get a config page by environment
get
https://api.dev.poly.ai/v1/agents/{agentId}/real-time-configs/{clientEnv}
Path Parameters
agentIdstringrequired
clientEnvstringrequired
Response
application/json
Response
application/json
Successful response
GetConfigPageResponse
A single config page for one environment.
clientEnvstringrequired
Environment (sandbox, pre-release, live)
variablesobject
Config key-value pairs
schemaobject
JSON Schema (Draft 7) definition
lastUpdatedstring
ISO 8601 timestamp of last update
get/v1/agents/{agentId}/real-time-configs/{clientEnv}
Authentication
Path Parameters
application/json