Workflow
- Read
capabilities. - Create a session with exactly one draft revision or one published version.
- Optionally select one question using the current state revision.
- Render desktop, mobile, or both.
- Inspect the returned artifacts directly, or create a short-lived human review link.
- Revoke the link or expire the session.
Endpoints
Pin an exact form
Draft:--out.
Zero-write and privacy guarantees
Preview never creates or changes:- Native Forms attempts, answers, grades, or result releases;
- Project To-do assignments or transitions;
- worker progress or completion;
- notifications; or
- audit completion events.
Authorization and retry behavior
- Capability, session, artifact, and link reads require
project_todos:read. - Session control, rendering, and link mutations require
project_todos:writeand anIdempotency-Key. - State-changing operations require the current
expectedStateRevision. - Reuse the same idempotency key after an uncertain or retryable
503. - Retrieve an artifact again when its signed URL expires.
SDK
@opentrain-ai/sdk 0.21.0 or later exposes
getNativeFormPreviewCapabilities, createNativeFormPreviewSession,
getNativeFormPreviewSession, manageNativeFormPreviewSession,
renderNativeFormPreview, artifact list/get, and link create/list/revoke.
Use the machine-readable OpenAPI document
for complete request, response, and error schemas.