Skip to main content
POST
Say what should change in a contact's messages, and have them rewritten

Authorizations

X-API-Key
string
header
required

Path Parameters

sequence_id
string<uuid>
required
session_id
string<uuid>
required
record_id
string<uuid>
required

Body

application/json

One note on a contact's thread: what should change, in the person's words.

expected_revision
integer
required
Required range: x >= 1
note
string
required

What should change in this contact's messages. The agent works out the change to its instructions the note asks for and writes the contact's whole thread again with it; nothing about the agent changes until the rewrite is kept.

Required string length: 1 - 4000

Response

Successful Response

agent_id
string<uuid>
required
applied_version
integer | null
required
base_version
integer
required
contacts
SequenceTrainingContactReadSchema · object[]
required
created_at
string<date-time>
required
error
string | null
required
id
string<uuid>
required
progress
SequenceTrainingProgressSchema · object
required

How training on this sequence is going, counted across the run.

proposal
ContactTrainingProposal · object | null
required

The session's candidate prompt update, kept pending until applied.

revision
integer
required
status
enum<string>
required

A session's phase, also used to resume its review screen.

Available options:
running,
reviewing,
proposing,
proposed,
completed,
abandoned
note_waiting
boolean
default:false

A note was given while another contact was being written: its rewrite is worked out as soon as that write lands.

reviewed_ids
string<uuid>[]

Every contact given Looks good or a note in this run, including ones that left the run to make room.

steps
AiStep · object[]