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

Upload Job Instruction Image

Upload one image for a TipTap image node without changing a page.

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

Uploads a JPEG, PNG, WebP, GIF, or AVIF image up to 5 MB. Requires instructions:write, employer access, and an Idempotency-Key header.

Send multipart/form-data with one file field. The response returns the job ID, content type, byte size, and URL to place in a TipTap image node. Uploading the image does not edit any instruction page.

With CLI 0.5.2 or later, use opentrain instructions image upload to run the matching no-write plan and verified upload workflow. Pass the previewed digest back as --expected-sha256 on the confirmed upload so changed local bytes fail before the request. Use capability discovery to inspect the image host patterns accepted by the renderer.