Skip to main content
POST
Author a phase

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

Body

application/json
title
string
objective
string
exit_criteria
string
max_turns
integer
Required range: x >= 1
tools
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 option chips), offer_deliverable (promise + trigger the wrap-up document). Removing capture_slots is refused while the phase has required answers.

Response

The created 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
archived
boolean
required
slots
object[]
required
tools
string[]