mcp

Wait For Status

Block until the job reaches target/until (or timeout).

Covers story writes, revisions, assets, articles, and chat operations via kind. On timeout returns current status with timed_out=true — not an error.

post/api/mcp/wait_for_status

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/wait_for_status
  • Auth: none declared

Request body

job_idstring required

The story job ID.

kindstring

Which job family to probe: story | revision | chat_operation | asset | chapter_cover | cover_image | article. job_id is the id of that family (story id, asset job id, cover_job_id, operation_id, or article id).

include_debugboolean

Include noisy revision debug fields when kind=revision.

targetstring

Which status to wait for. 'terminal' (default) returns when the job reaches completed/failed/cancelled. 'reviewing' returns as soon as the planner + characterizer finish so callers can edit the outline/cast before writing. 'progress_tick' returns as soon as chapters_done advances OR current_step text changes — use it in a short loop to stream progress to the user during a long generation instead of going silent for minutes. Any other literal status string is matched exactly.

timeout_secondsnumber

Maximum seconds to wait before returning. On timeout the current status is returned with timed_out=true — no error.

untilstring nullable

Alias for target. Prefer this name in new clients.

Response

Successful Response

job_idstring nullable
kindstring nullable
idstring nullable
statusstring nullable
current_stepstring nullable
revision_statusstring nullable
chapters_doneinteger nullable
chapter_countinteger nullable
is_terminalboolean nullable
timed_outboolean nullable
requested_timeout_secondsnumber nullable
effective_timeout_secondsnumber nullable
created_atstring nullable
updated_atstring nullable
story_urlstring nullable
article_urlstring nullable
resultunknown
errorunknown
progressunknown
current_segmentunknown

Changes

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