Upsert the JSON Schema for a config page

PUT /v1/agents/{agentId}/real-time-configs/{clientEnv}/schema

Upsert the JSON Schema for a config page

cURL

curl --request PUT \
  --url https://api.us.poly.ai/v1/agents/{agentId}/real-time-configs/{clientEnv}/schema \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
  "schema": {}
}'

import requests

url = "https://api.us.poly.ai/v1/agents/{agentId}/real-time-configs/{clientEnv}/schema"

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

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

print(response.text)

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

fetch('https://api.us.poly.ai/v1/agents/{agentId}/real-time-configs/{clientEnv}/schema', 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}/real-time-configs/{clientEnv}/schema",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'schema' => [
        
    ]
  ]),
  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}/real-time-configs/{clientEnv}/schema"

	payload := strings.NewReader("{\n  \"schema\": {}\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.us.poly.ai/v1/agents/{agentId}/real-time-configs/{clientEnv}/schema")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"schema\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.us.poly.ai/v1/agents/{agentId}/real-time-configs/{clientEnv}/schema")

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

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

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

200

{
  "clientEnv": "<string>",
  "variables": {},
  "schema": {},
  "lastUpdated": "<string>"
}

{
  "success": false,
  "error": "JSON Schema definition is invalid.",
  "error_id": "550e8400-e29b-41d4-a716-446655440000",
  "error_code": "REAL_TIME_CONFIG_INVALID_SCHEMA",
  "error_message": "JSON Schema definition is invalid.",
  "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>"
}

{
  "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

clientEnv · string · required

Body

application/json

The JSON Schema definition to apply to a config page.

schema · object · required

JSON Schema (Draft 7) definition

Response

200

application/json

Successful response

A single config page for one environment.

clientEnv · string · required

Environment (sandbox, pre-release, live)

variables · object

Config key-value pairs

schema · object

JSON Schema (Draft 7) definition

lastUpdated · string

ISO 8601 timestamp of last update