Schemas
Artifact SchemasLast updated on
Last updated on
The four artifact types in Paradoc
Paradoc has 4 basic artifacts:
| Artifact | Description |
|---|---|
| Document | Static documents (e.g., disclosures, pamphlets) |
| Form | Dynamic documents that have parties, fields, annexes, and/or logic (e.g., contracts, applications, certificates) |
| Checklist | Compliance documents that track the completion of tasks or requirements (e.g., closing checklist) |
| Bundle | Containers for Documents, Forms, Checklists and even other Bundles (e.g., loan application packet) |
Base properties
All artifacts share the same base properties:
$schema?: string
Current dated schema URL. Required in artifact files and optional for in-memory objects
name: string
Slug shared by every edition of one artifact. An artifact is identified by its name and, when it has one, its edition key.
version?: string
Artifact version (semantic versioning). Required for publishing to registry. Counts only the publisher's own changes, never the issuer's edition
title?: string
Human-friendly name presented to end users. Recommended for published/shared artifacts and directory browsing
description?: string
Long-form description or context
code?: string
The form number as printed by its issuer (e.g. W-9, ACORD 25), or a self-issued form's own number
language?: string
BCP 47-style source language tag. Defaults to en when omitted
issuer?: string
Organization that issues the form (e.g. U.S. Internal Revenue Service)
edition?: Edition
The issuer's edition this artifact encodes, for artifacts the issuer reissues. Every edition of one artifact shares the same name and has its own version line
metadata?: Metadata
Custom metadata map
instructions?: ContentRef
Domain or compliance reference content (e.g., IRS instructions, regulatory guidance)
agentInstructions?: ContentRef
LLM/agent prompts for field ordering, grouping, tone, and presentation guidance