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>"
}
'

import requests

url = "https://api.us.poly.ai/v1/agents/{agentId}/deployments/publish"

payload = {
    "deploymentMessage": "",
    "environment": "<string>"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({deploymentMessage: '', environment: '<string>'})
};

fetch('https://api.us.poly.ai/v1/agents/{agentId}/deployments/publish', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.us.poly.ai/v1/agents/{agentId}/deployments/publish",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'deploymentMessage' => '',
    'environment' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.us.poly.ai/v1/agents/{agentId}/deployments/publish"

	payload := strings.NewReader("{\n  \"deploymentMessage\": \"\",\n  \"environment\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.us.poly.ai/v1/agents/{agentId}/deployments/publish")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"deploymentMessage\": \"\",\n  \"environment\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.us.poly.ai/v1/agents/{agentId}/deployments/publish")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"deploymentMessage\": \"\",\n  \"environment\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

201

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

{
  "success": false,
  "error": "Invalid or missing `environment` query parameter.",
  "error_id": "550e8400-e29b-41d4-a716-446655440000",
  "error_code": "DEPLOYMENTS_INVALID_ENVIRONMENT",
  "error_message": "Invalid or missing `environment` query parameter.",
  "data": null
}

{
  "success": false,
  "error": "<string>",
  "error_id": "<string>",
  "error_code": "<string>",
  "error_message": "<string>",
  "data": "<unknown>"
}

{
  "success": false,
  "error": "<string>",
  "error_id": "<string>",
  "error_code": "<string>",
  "error_message": "<string>",
  "data": "<unknown>"
}

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