mcp

Upsert Chapter Note

Add or update a review note on a generated story chapter.

Notes can come from Codex or the website reader UI. They stay visible on the chapter and can be consumed by revise_chapter_from_notes.

post/api/mcp/upsert_chapter_note

Request

Base URL: https://writer.swapp1990.org (the document declares no server; this is the origin it was published from)
URL: https://writer.swapp1990.org/api/mcp/upsert_chapter_note
Auth: none declared

job_idstring required

The story job ID.

chapterinteger required

Chapter number the review note belongs to.

initial_plan_idstring nullable

Optional initial chapter plan id when the note targets an unwritten chapter plan.

note_idstring nullable

Existing note id to update. Omit to create a new note.

textstring required

Review note to apply to this story chapter. Notes stay visible on the chapter and can be consumed by revise_chapter_from_notes.

paragraph_indexinteger nullable

0-based displayed paragraph index the note refers to.

selected_textstring nullable

Optional text span the note is anchored to.

revisioninteger nullable

Chapter revision number this note belongs to. Omit to attach the note to the latest revision.

scopestring

Note scope: paragraph, beat, or chapter. Beat notes may include beat_index/range metadata.

beat_indexinteger nullable

0-based beat index when scope is beat.

beat_numinteger nullable

1-based beat number when scope is beat.

beat_summarystring nullable

Beat summary shown to the writer when applying beat-level notes.

range_startinteger nullable

0-based first paragraph covered by the beat note.

range_endinteger nullable

0-based last paragraph covered by the beat note.

originstring

Where the note came from, such as Codex session or website review.

Successful Response

story_urlstring nullable

article_urlstring nullable

job_idstring nullable

statusstring nullable

is_terminalboolean nullable

No recorded changes to this operation across all 1 revision of this API.