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

Preflight a Job Instruction Tree

Validate and sign a complete desired page tree without changing live instructions.

Use with AI
View as MarkdownOpen in ChatGPTOpen in ClaudeOpen in PerplexityAdd to CursorAdd to VS Code
POST/api/public/v1/instructions/jobs/{jobId}/tree/preflight

Validates a complete desired root-and-subpage tree without writing. Requires instructions:write and employer access.

Send the current expectedTreeChecksum, a stable ref for each desired page, existing pageId and expectedChecksum values where applicable, each page’s parentRef, zero-based position, TipTap content, confirmTreeReplace: true, and an idempotencyKey.

The response returns normalized pages, semantic findings, the exact archive set, resulting tree checksum, plan digest, short-lived preflightToken, and atomicVisibility: true. Review and preserve the returned archive set for apply.