Update guidelines

PATCH

agents

{id}

guidelines

Update guidelines

curl --request PATCH \
  --url https://api.us.phonely.ai/v1/agents/{id}/guidelines \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "is_speech_humanized": true,
  "personality": "<string>",
  "sections": [
    {
      "type": "<string>",
      "content": "<string>",
      "name": "<string>"
    }
  ]
}
'

import requests

url = "https://api.us.phonely.ai/v1/agents/{id}/guidelines"

payload = {
    "is_speech_humanized": True,
    "personality": "<string>",
    "sections": [
        {
            "type": "<string>",
            "content": "<string>",
            "name": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    is_speech_humanized: true,
    personality: '<string>',
    sections: [{type: '<string>', content: '<string>', name: '<string>'}]
  })
};

fetch('https://api.us.phonely.ai/v1/agents/{id}/guidelines', 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.phonely.ai/v1/agents/{id}/guidelines",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'is_speech_humanized' => true,
    'personality' => '<string>',
    'sections' => [
        [
                'type' => '<string>',
                'content' => '<string>',
                'name' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.phonely.ai/v1/agents/{id}/guidelines"

	payload := strings.NewReader("{\n  \"is_speech_humanized\": true,\n  \"personality\": \"<string>\",\n  \"sections\": [\n    {\n      \"type\": \"<string>\",\n      \"content\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.patch("https://api.us.phonely.ai/v1/agents/{id}/guidelines")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"is_speech_humanized\": true,\n  \"personality\": \"<string>\",\n  \"sections\": [\n    {\n      \"type\": \"<string>\",\n      \"content\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.us.phonely.ai/v1/agents/{id}/guidelines")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"is_speech_humanized\": true,\n  \"personality\": \"<string>\",\n  \"sections\": [\n    {\n      \"type\": \"<string>\",\n      \"content\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ]\n}"

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

{
  "agent_id": "<string>",
  "is_speech_humanized": true,
  "object": "agent_guidelines",
  "personality": "<string>",
  "sections": [
    {
      "content": "<string>",
      "name": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "error": {
    "code": "<string>",
    "details": [
      {
        "field": "<string>",
        "issue": "<string>",
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": [
      {
        "field": "<string>",
        "issue": "<string>",
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": [
      {
        "field": "<string>",
        "issue": "<string>",
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": [
      {
        "field": "<string>",
        "issue": "<string>",
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": [
      {
        "field": "<string>",
        "issue": "<string>",
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": [
      {
        "field": "<string>",
        "issue": "<string>",
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": [
      {
        "field": "<string>",
        "issue": "<string>",
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": [
      {
        "field": "<string>",
        "issue": "<string>",
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": [
      {
        "field": "<string>",
        "issue": "<string>",
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "request_id": "<string>"
  }
}

Authorizations

Authorization

string

header

required

An org API key: Authorization: Bearer phk_…

Headers

If-Match

string | null

The ETag from your last read: the change is made only if the resource still has it, otherwise 412. Optional, except that a change replacing a list needs it (428 without it).

Phonely-Organization

string | null

Optional. Must be the key's org.

Path Parameters

string

required

The agent's ID.

Body

application/json

What to change. Only the fields sent change; sections is the whole set, so send If-Match.

is_speech_humanized

boolean | null

Whether the agent adds natural speech habits, such as short pauses and filler words.

personality

string | null

Known values: casual, humorous, direct, formal, persuasive, friendly. More can be added, so handle values you don't recognize.

sections

GuidelineSectionUpdate · object[] | null

All the guideline sections the agent has, in any order. A section left out is deleted, a new type is added, and a section sent as it is stays as it is.

Maximum array length: 7

Show child attributes

Response

Successful Response

How an agent behaves in conversation: its guideline sections and response style.

agent_id

string

required

The agent's ID.

is_speech_humanized

boolean

required

Whether the agent adds natural speech habits, such as short pauses and filler words.

object

string

default:agent_guidelines

required

The type of this object, always agent_guidelines.

Allowed value: "agent_guidelines"

personality

string

required

The tone the agent takes with callers. Known values: casual, humorous, direct, formal, persuasive, friendly. More can be added, so handle values you don't recognize.

sections

GuidelineSection · object[]

required

The guideline sections the agent has, in the order the web app shows them. Each type appears at most once.

Show child attributes

⌘I

Update guidelines

curl --request PATCH \
  --url https://api.us.phonely.ai/v1/agents/{id}/guidelines \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "is_speech_humanized": true,
  "personality": "<string>",
  "sections": [
    {
      "type": "<string>",
      "content": "<string>",
      "name": "<string>"
    }
  ]
}
'

import requests

url = "https://api.us.phonely.ai/v1/agents/{id}/guidelines"

payload = {
    "is_speech_humanized": True,
    "personality": "<string>",
    "sections": [
        {
            "type": "<string>",
            "content": "<string>",
            "name": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    is_speech_humanized: true,
    personality: '<string>',
    sections: [{type: '<string>', content: '<string>', name: '<string>'}]
  })
};

fetch('https://api.us.phonely.ai/v1/agents/{id}/guidelines', 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.phonely.ai/v1/agents/{id}/guidelines",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'is_speech_humanized' => true,
    'personality' => '<string>',
    'sections' => [
        [
                'type' => '<string>',
                'content' => '<string>',
                'name' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.phonely.ai/v1/agents/{id}/guidelines"

	payload := strings.NewReader("{\n  \"is_speech_humanized\": true,\n  \"personality\": \"<string>\",\n  \"sections\": [\n    {\n      \"type\": \"<string>\",\n      \"content\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.patch("https://api.us.phonely.ai/v1/agents/{id}/guidelines")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"is_speech_humanized\": true,\n  \"personality\": \"<string>\",\n  \"sections\": [\n    {\n      \"type\": \"<string>\",\n      \"content\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.us.phonely.ai/v1/agents/{id}/guidelines")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"is_speech_humanized\": true,\n  \"personality\": \"<string>\",\n  \"sections\": [\n    {\n      \"type\": \"<string>\",\n      \"content\": \"<string>\",\n      \"name\": \"<string>\"\n    }\n  ]\n}"

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

{
  "agent_id": "<string>",
  "is_speech_humanized": true,
  "object": "agent_guidelines",
  "personality": "<string>",
  "sections": [
    {
      "content": "<string>",
      "name": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "error": {
    "code": "<string>",
    "details": [
      {
        "field": "<string>",
        "issue": "<string>",
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": [
      {
        "field": "<string>",
        "issue": "<string>",
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": [
      {
        "field": "<string>",
        "issue": "<string>",
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": [
      {
        "field": "<string>",
        "issue": "<string>",
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": [
      {
        "field": "<string>",
        "issue": "<string>",
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": [
      {
        "field": "<string>",
        "issue": "<string>",
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": [
      {
        "field": "<string>",
        "issue": "<string>",
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": [
      {
        "field": "<string>",
        "issue": "<string>",
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "details": [
      {
        "field": "<string>",
        "issue": "<string>",
        "message": "<string>"
      }
    ],
    "message": "<string>",
    "request_id": "<string>"
  }
}

API v1

API v1 endpoints

Legacy API

Web SDK

Authorizations

Headers

Path Parameters

Body

Response