Skip to main content
PATCH
Edit a phase (prose, tools and tool settings)

Authorizations

Authorization
string
header
required

Your secret key (pep_sk_…) from Settings → API. Keys are org-scoped; treat them like passwords.

Path Parameters

agent_slug
string
required
id
integer
required

Body

application/json
title
string
objective
string
exit_criteria
string
max_turns
integer
Required range: x >= 1
tools
enum<string>[]

Full replacement set of the phase's tools. Known tools: consult_knowledge (ground replies in activated knowledge), capture_slots (record configured answers), suggest_replies (one-tap answer buttons under the agent's questions — configured options and agent-named choices), offer_navigation (buttons that open the organization's own pages; tune with tool_settings), offer_deliverable (promise + trigger the wrap-up document). Removing capture_slots is refused while the phase has required answers; a tool switched off loses its settings.

Available options:
consult_knowledge,
capture_slots,
suggest_replies,
offer_navigation,
offer_deliverable
tool_settings
object

Settings for tools that are ON in this phase, merged per key: {offer_navigation: {max_links: 1..3}}. Refused (422 flow_invalid) when the tool is off in the phase or a value is out of range.

Response

The updated phase.

object
string
required
Allowed value: "flow_state"
id
integer
required
key
string
required
title
string
required
position
integer
required
kind
enum<string>
required
Available options:
step,
loop,
terminal
objective
string
required
exit_criteria
string
required
max_turns
integer
required
tool_settings
object
required

Effective settings of the tools that are on, keyed by tool, defaults filled: {offer_navigation: {max_links: 1..3}} (page buttons one reply may carry, default 1). Tools without settings do not appear.

archived
boolean
required
slots
object[]
required
tools
string[]