Publish the current draft to an environment

POST /v1/agents/{agentId}/deployments/publish

Publish the current draft to an environment

cURL

curl --request POST \
  --url https://api.us.poly.ai/v1/agents/{agentId}/deployments/publish \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "deploymentMessage": "",
  "environment": "<string>"
}
'

201

{
  "deployment": {
    "id": "<string>",
    "accountId": "<string>",
    "agentId": "<string>",
    "environment": "<string>",
    "artifactVersion": "<string>",
    "version": "<string>",
    "createdBy": "<string>",
    "createdAt": "<string>",
    "metadata": {}
  },
  "testRunIds": [
    "<string>"
  ]
}

Authorizations

X-API-KEY · string · header · required

Path Parameters

agentId · string · required

Body

application/json

Metadata attached to a publish action, with an optional target environment.

deploymentMessage · string · default: ""

Message describing this publish

environment · string

Environment to publish to (defaults to sandbox)

Response

201

application/json

Successful response

The resulting deployment from a promote / rollback / publish action, plus any test runs it triggered.

deployment · object · required

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

Show child attributes

testRunIds · string[]

IDs of test runs triggered by this deployment action