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

Discover Job Instructions Capabilities

Discover the canonical Instructions schema, limits, imports, and mutation guarantees.

Use with AI
View as MarkdownOpen in ChatGPTOpen in ClaudeOpen in PerplexityAdd to CursorAdd to VS Code
GET/api/public/v1/instructions/capabilities

Returns the machine-readable contract for canonical job Instructions. Use it before generating TipTap JSON or planning a mutation.

The response includes supported node and mark types, node types that need stable IDs, patch operations, document and image limits, maximum tree depth, DOCX support, and guarantees for preflight, canonical readback, and atomic tree apply. Local bundles are explicitly reported as non-authoritative.

image.allowedHostPatterns lists the hostname patterns accepted by the job Instructions content-security policy. If an existing image URL does not match, upload its bytes through the canonical image endpoint and use the returned URL instead.