Skip to main content
GET
Get guidelines
This returns the draft: what you see in the Guidelines editor in Studio, and what Talk and the test Chat use. On a published agent, live calls, website chats and emails use the published guidelines until the next Publish, needs_publish is true when the agent has any unpublished change, not only to its guidelines, and it can stay true after an edit is changed back: it says a publish may be needed, not what is in it. live_version names the version that is live. Guidelines refer to actions and variables with {{...}} placeholders, and the API returns them by ID, such as {{action.<id>}}, where Studio shows names. Keep them exactly as returned when you send the text back with Replace guidelines.

Authorizations

X-API-Key
string
header
required

An API key from Manage → API Keys in Studio. See Authentication.

Path Parameters

assistantId
string<uuid>
required

The agent's ID. Open the agent in Studio and select Copy ID in its header.

Response

The agent's guidelines.

success
boolean
required
data
object
required