Skip to content
OpenTrain AIOpenTrain AIOpenTrain AIDocs

Ask OpenTrain

Answers from the documentation, with sources.

What would you like to do with OpenTrain?

AI answers can be mistaken. Check the linked sources. Don’t include private account information.

Open app

DEVELOPER DOCUMENTATION

Replace Job Instruction Page

Replace a complete canonical TipTap document with concurrency and live-write guards.

Use with AI
View as MarkdownOpen in ChatGPTOpen in ClaudeOpen in PerplexityAdd to CursorAdd to VS Code
PUT/api/public/v1/instructions/jobs/{jobId}/pages/{pageId}

Replaces the complete page document. Requires instructions:write and employer access. Preview the content first.

contentobjectbodyrequired

The complete TipTap doc node.

expectedChecksumstringbodyrequired

The SHA-256 checksum from the last page read.

confirmReplacetruebodyrequired

Confirms the whole-document replacement.

preflightTokenstringbodyrequired

The short-lived token returned by preflighting this exact replacement.

confirmLivetruebodyrequired

Confirms immediate worker visibility.

A stale checksum returns 409 instead of overwriting a concurrent edit.