Skip to content

Improve Step Instruction

POST
/sequencer/content/instructions/improve

Rewrite a step’s drafting instruction with a model. RUNS A MODEL per call.

Returns the improved instruction; nothing is saved. Send the current instruction as old_instruction so the rewrite keeps its intent.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Rewrite a step’s drafting instruction. Mirrors PromptImprovementPayload.

object
old_instruction
Any of:
string
user_instruction
required

What the drafting agent should do, in the author’s own words.

string
>= 1 characters

Responses

200

Successful Response

object
data
required

An open envelope around one sequencer record.

Open because templates, schedules and channels carry nested step data and configuration that grows as channels are added.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string