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 Mutation

Validate and sign one exact page mutation 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}/preflight

Validates a complete create, replace, patch, metadata, or archive operation without writing. Requires instructions:write and employer access to the job.

operationobjectbodyrequired

The exact operation you intend to apply, including target IDs, concurrency checks, content, placement, and confirmation fields.

The response includes findings, normalized content when applicable, rendered HTML, the current and resulting tree checksums, a plan digest, and writesApplied: false. When canApply is true, it also returns a short-lived preflightToken. Submit the unchanged operation and that token to its mutation endpoint. Changed input requires a new preflight.