Skip to main content
GET
Get guidelines

Authorizations

Authorization
string
header
required

An org API key: Authorization: Bearer phk_…

Headers

Phonely-Organization
string | null

Optional. Must be the key's org.

Path Parameters

id
string
required

The agent's ID.

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.