The editor and MCP tools share these endpoints. Checkout requires configured Stripe payments. Fulfillment is manual.
OpenAPI JSON · MCP tool schemas
Auth Status
{
"parameters": [],
"requestBody": {}
}Auth Code
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthEmail"
}
}
},
"required": true
}
}Auth Verify
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthVerify"
}
}
},
"required": true
}
}Auth Logout
{
"parameters": [],
"requestBody": {}
}Account
{
"parameters": [],
"requestBody": {}
}Export Records
{
"parameters": [],
"requestBody": {}
}Archive Draft
{
"parameters": [
{
"name": "draft_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Draft Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Version"
}
}
}
}
}Site Information
{
"parameters": [],
"requestBody": {}
}Backup Status
{
"parameters": [],
"requestBody": {}
}Create Backup
{
"parameters": [],
"requestBody": {}
}Health
{
"parameters": [],
"requestBody": {}
}Catalog
{
"parameters": [],
"requestBody": {}
}Original Hand Browser Font
{
"parameters": [
{
"name": "revision",
"in": "query",
"required": false,
"schema": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Revision"
}
}
],
"requestBody": {}
}Render Markdown
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MarkdownBody"
}
}
},
"required": true
}
}List Drafts
{
"parameters": [],
"requestBody": {}
}Create Draft
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateDraft"
}
}
},
"required": true
}
}Copy Draft
{
"parameters": [
{
"name": "draft_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Draft Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateDraft"
}
}
}
}
}Read Draft
{
"parameters": [
{
"name": "draft_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Draft Id"
}
}
],
"requestBody": {}
}Update Draft
{
"parameters": [
{
"name": "draft_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Draft Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateDraft"
}
}
}
}
}Library Artwork
{
"parameters": [
{
"name": "draft_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Draft Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LibraryArtwork"
}
}
}
}
}Upload Attachment
{
"parameters": [
{
"name": "draft_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Draft Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/Body_upload_attachment_api_drafts__draft_id__attachments_post"
}
}
}
}
}Upload Base64
{
"parameters": [
{
"name": "draft_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Draft Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileUpload"
}
}
}
}
}Delete Attachment
{
"parameters": [
{
"name": "draft_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Draft Id"
}
},
{
"name": "file_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "File Id"
}
},
{
"name": "version",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"title": "Version"
}
}
],
"requestBody": {}
}Download File
{
"parameters": [
{
"name": "file_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "File Id"
}
}
],
"requestBody": {}
}Address References
{
"parameters": [],
"requestBody": {}
}Confirm Address References
{
"parameters": [
{
"name": "draft_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Draft Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddressConsent"
}
}
}
}
}Create Preview
{
"parameters": [
{
"name": "draft_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Draft Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Version"
}
}
}
}
}Artwork Preview
{
"parameters": [
{
"name": "draft_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Draft Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Version"
}
}
}
}
}Preview File
{
"parameters": [
{
"name": "preview_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Preview Id"
}
},
{
"name": "filename",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Filename"
}
}
],
"requestBody": {}
}Create Quote
{
"parameters": [
{
"name": "draft_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Draft Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Version"
}
}
}
}
}Checkout
{
"parameters": [
{
"name": "draft_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Draft Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Checkout"
}
}
}
}
}List Orders
{
"parameters": [],
"requestBody": {}
}Read Order
{
"parameters": [
{
"name": "order_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Order Id"
}
}
],
"requestBody": {}
}Payment Webhook
{
"parameters": [],
"requestBody": {}
}Sync Payment
{
"parameters": [
{
"name": "order_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Order Id"
}
}
],
"requestBody": {}
}Cancel Order
{
"parameters": [
{
"name": "order_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Order Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CancelOrder"
}
}
}
}
}Refund Order
{
"parameters": [
{
"name": "order_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Order Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RefundOrder"
}
}
}
}
}Payment Status
{
"parameters": [],
"requestBody": {}
}Sync Refund
{
"parameters": [
{
"name": "order_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Order Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RefundSync"
}
}
}
}
}Operator Orders
{
"parameters": [],
"requestBody": {}
}Archived Records
{
"parameters": [],
"requestBody": {}
}Update Status
{
"parameters": [
{
"name": "order_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"title": "Order Id"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StatusUpdate"
}
}
}
}
}Agent Tools
{
"parameters": [],
"requestBody": {}
}Mcp
{
"parameters": [],
"requestBody": {}
}Status
{
"parameters": [],
"requestBody": {}
}Issue
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IssueRecovery"
}
}
},
"required": true
}
}Claim
{
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClaimRecovery"
}
}
},
"required": true
}
}{
"Address": {
"properties": {
"name": {
"type": "string",
"maxLength": 100,
"title": "Name",
"default": ""
},
"line1": {
"type": "string",
"maxLength": 120,
"title": "Line1",
"default": ""
},
"line2": {
"type": "string",
"maxLength": 100,
"title": "Line2",
"default": ""
},
"city": {
"type": "string",
"maxLength": 80,
"title": "City",
"default": ""
},
"state": {
"type": "string",
"maxLength": 2,
"title": "State",
"default": ""
},
"postal_code": {
"type": "string",
"maxLength": 10,
"title": "Postal Code",
"default": ""
},
"country": {
"type": "string",
"const": "US",
"title": "Country",
"default": "US"
}
},
"additionalProperties": false,
"type": "object",
"title": "Address"
},
"AddressConsent": {
"properties": {
"version": {
"type": "integer",
"minimum": 1.0,
"title": "Version"
},
"approved": {
"type": "boolean",
"title": "Approved"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"version",
"approved"
],
"title": "AddressConsent"
},
"AuthEmail": {
"properties": {
"email": {
"type": "string",
"maxLength": 254,
"minLength": 3,
"title": "Email"
},
"signup": {
"type": "boolean",
"title": "Signup",
"default": false
}
},
"additionalProperties": false,
"type": "object",
"required": [
"email"
],
"title": "AuthEmail"
},
"AuthVerify": {
"properties": {
"email": {
"type": "string",
"maxLength": 254,
"minLength": 3,
"title": "Email"
},
"code": {
"type": "string",
"maxLength": 10,
"minLength": 6,
"title": "Code"
},
"claim_guest_drafts": {
"type": "boolean",
"title": "Claim Guest Drafts",
"default": false
}
},
"additionalProperties": false,
"type": "object",
"required": [
"email",
"code"
],
"title": "AuthVerify"
},
"Body_upload_attachment_api_drafts__draft_id__attachments_post": {
"properties": {
"file": {
"type": "string",
"contentMediaType": "application/octet-stream",
"title": "File"
},
"kind": {
"type": "string",
"enum": [
"pdf",
"photo",
"decoration"
],
"title": "Kind"
},
"version": {
"type": "integer",
"title": "Version"
}
},
"type": "object",
"required": [
"file",
"kind",
"version"
],
"title": "Body_upload_attachment_api_drafts__draft_id__attachments_post"
},
"CancelOrder": {
"properties": {
"approved": {
"type": "boolean",
"title": "Approved"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"approved"
],
"title": "CancelOrder"
},
"Checkout": {
"properties": {
"version": {
"type": "integer",
"minimum": 1.0,
"title": "Version"
},
"quote_id": {
"type": "string",
"title": "Quote Id"
},
"preview_id": {
"type": "string",
"title": "Preview Id"
},
"approved": {
"type": "boolean",
"title": "Approved"
},
"idempotency_key": {
"type": "string",
"maxLength": 150,
"minLength": 8,
"title": "Idempotency Key"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"version",
"quote_id",
"preview_id",
"approved",
"idempotency_key"
],
"title": "Checkout"
},
"ClaimRecovery": {
"properties": {
"approved": {
"type": "boolean",
"title": "Approved"
},
"code": {
"type": "string",
"maxLength": 47,
"minLength": 47,
"title": "Code"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"approved",
"code"
],
"title": "ClaimRecovery"
},
"CreateDraft": {
"properties": {
"title": {
"type": "string",
"maxLength": 150,
"title": "Title",
"default": "Untitled letter"
},
"text": {
"type": "string",
"maxLength": 30000,
"title": "Text",
"default": ""
},
"content_type": {
"type": "string",
"enum": [
"text",
"markdown",
"pdf"
],
"title": "Content Type",
"default": "text"
},
"paper": {
"type": "string",
"enum": [
"classic",
"ivory"
],
"title": "Paper",
"default": "classic"
},
"envelope": {
"type": "string",
"enum": [
"white",
"kraft"
],
"title": "Envelope",
"default": "white"
},
"style": {
"type": "string",
"enum": [
"serif",
"sans",
"handwritten",
"typewriter",
"original_hand"
],
"title": "Style",
"default": "serif"
},
"recipient": {
"$ref": "#/components/schemas/Address"
},
"sender": {
"$ref": "#/components/schemas/Address"
},
"decorations": {
"items": {
"$ref": "#/components/schemas/Decoration"
},
"type": "array",
"maxItems": 20,
"title": "Decorations"
},
"pages": {
"items": {
"$ref": "#/components/schemas/PageContent"
},
"type": "array",
"maxItems": 20,
"title": "Pages"
},
"handwriting": {
"anyOf": [
{
"$ref": "#/components/schemas/HandwritingConfig"
},
{
"type": "null"
}
]
},
"original_hand": {
"anyOf": [
{
"$ref": "#/components/schemas/OriginalHandConfig"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false,
"type": "object",
"title": "CreateDraft"
},
"Decoration": {
"properties": {
"id": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"pattern": "^[A-Za-z0-9_-]+$",
"title": "Id"
},
"file_id": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"pattern": "^[A-Za-z0-9_-]+$",
"title": "File Id"
},
"page": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Page",
"default": 1
},
"page_id": {
"anyOf": [
{
"type": "string",
"maxLength": 100,
"minLength": 1,
"pattern": "^[A-Za-z0-9_-]+$"
},
{
"type": "null"
}
],
"title": "Page Id"
},
"page_offset": {
"type": "integer",
"maximum": 99.0,
"minimum": 0.0,
"title": "Page Offset",
"default": 0
},
"x": {
"type": "number",
"maximum": 1.0,
"minimum": 0.0,
"title": "X"
},
"y": {
"type": "number",
"maximum": 1.0,
"minimum": 0.0,
"title": "Y"
},
"width": {
"type": "number",
"maximum": 1.0,
"minimum": 0.02,
"title": "Width"
},
"height": {
"type": "number",
"maximum": 1.0,
"minimum": 0.02,
"title": "Height"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"id",
"file_id",
"x",
"y",
"width",
"height"
],
"title": "Decoration"
},
"FileUpload": {
"properties": {
"version": {
"type": "integer",
"minimum": 1.0,
"title": "Version"
},
"kind": {
"type": "string",
"enum": [
"pdf",
"photo",
"decoration"
],
"title": "Kind"
},
"name": {
"type": "string",
"maxLength": 150,
"title": "Name"
},
"content_base64": {
"type": "string",
"maxLength": 14000000,
"title": "Content Base64"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"version",
"kind",
"name",
"content_base64"
],
"title": "FileUpload"
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"HandwritingConfig": {
"properties": {
"seed": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"pattern": "^[A-Za-z0-9_-]+$",
"title": "Seed"
},
"engine_version": {
"type": "string",
"const": "joined-1",
"title": "Engine Version",
"default": "joined-1"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"seed"
],
"title": "HandwritingConfig"
},
"IssueRecovery": {
"properties": {
"approved": {
"type": "boolean",
"title": "Approved"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"approved"
],
"title": "IssueRecovery"
},
"LibraryArtwork": {
"properties": {
"version": {
"type": "integer",
"minimum": 1.0,
"title": "Version"
},
"artwork_id": {
"type": "string",
"const": "bird_stamp",
"title": "Artwork Id"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"version",
"artwork_id"
],
"title": "LibraryArtwork"
},
"MarkdownBody": {
"properties": {
"text": {
"type": "string",
"maxLength": 30000,
"title": "Text"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"text"
],
"title": "MarkdownBody"
},
"OriginalHandConfig": {
"properties": {
"seed": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"pattern": "^[A-Za-z0-9_-]+$",
"title": "Seed"
},
"engine_version": {
"type": "string",
"const": "original-1",
"title": "Engine Version",
"default": "original-1"
},
"foundation_version": {
"type": "string",
"const": "study01-v1",
"title": "Foundation Version",
"default": "study01-v1"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"seed"
],
"title": "OriginalHandConfig"
},
"PageContent": {
"properties": {
"id": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"pattern": "^[A-Za-z0-9_-]+$",
"title": "Id"
},
"text": {
"type": "string",
"maxLength": 30000,
"title": "Text",
"default": ""
},
"content_type": {
"type": "string",
"enum": [
"text",
"markdown"
],
"title": "Content Type",
"default": "text"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"id"
],
"title": "PageContent"
},
"RefundOrder": {
"properties": {
"approved": {
"type": "boolean",
"title": "Approved"
},
"amount_cents": {
"type": "integer",
"exclusiveMinimum": 0.0,
"title": "Amount Cents"
},
"idempotency_key": {
"type": "string",
"maxLength": 150,
"minLength": 8,
"title": "Idempotency Key"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"approved",
"amount_cents",
"idempotency_key"
],
"title": "RefundOrder"
},
"RefundSync": {
"properties": {
"refund_id": {
"type": "string",
"maxLength": 150,
"minLength": 4,
"pattern": "^re_[A-Za-z0-9_]+$",
"title": "Refund Id"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"refund_id"
],
"title": "RefundSync"
},
"StatusUpdate": {
"properties": {
"status": {
"type": "string",
"enum": [
"preparing",
"printed",
"mailed",
"action_needed",
"cancelled",
"failed"
],
"title": "Status"
},
"mailing_confirmed": {
"type": "boolean",
"title": "Mailing Confirmed",
"default": false
},
"note": {
"type": "string",
"maxLength": 2000,
"title": "Note",
"default": ""
}
},
"additionalProperties": false,
"type": "object",
"required": [
"status"
],
"title": "StatusUpdate"
},
"UpdateDraft": {
"properties": {
"version": {
"type": "integer",
"minimum": 1.0,
"title": "Version"
},
"title": {
"anyOf": [
{
"type": "string",
"maxLength": 150
},
{
"type": "null"
}
],
"title": "Title"
},
"text": {
"anyOf": [
{
"type": "string",
"maxLength": 30000
},
{
"type": "null"
}
],
"title": "Text"
},
"content_type": {
"anyOf": [
{
"type": "string",
"enum": [
"text",
"markdown",
"pdf"
]
},
{
"type": "null"
}
],
"title": "Content Type"
},
"paper": {
"anyOf": [
{
"type": "string",
"enum": [
"classic",
"ivory"
]
},
{
"type": "null"
}
],
"title": "Paper"
},
"envelope": {
"anyOf": [
{
"type": "string",
"enum": [
"white",
"kraft"
]
},
{
"type": "null"
}
],
"title": "Envelope"
},
"style": {
"anyOf": [
{
"type": "string",
"enum": [
"serif",
"sans",
"handwritten",
"typewriter",
"original_hand"
]
},
{
"type": "null"
}
],
"title": "Style"
},
"recipient": {
"anyOf": [
{
"$ref": "#/components/schemas/Address"
},
{
"type": "null"
}
]
},
"sender": {
"anyOf": [
{
"$ref": "#/components/schemas/Address"
},
{
"type": "null"
}
]
},
"decorations": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Decoration"
},
"type": "array",
"maxItems": 20
},
{
"type": "null"
}
],
"title": "Decorations"
},
"pages": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/PageContent"
},
"type": "array",
"maxItems": 20
},
{
"type": "null"
}
],
"title": "Pages"
},
"handwriting": {
"anyOf": [
{
"$ref": "#/components/schemas/HandwritingConfig"
},
{
"type": "null"
}
]
},
"original_hand": {
"anyOf": [
{
"$ref": "#/components/schemas/OriginalHandConfig"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false,
"type": "object",
"required": [
"version"
],
"title": "UpdateDraft"
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"Version": {
"properties": {
"version": {
"type": "integer",
"minimum": 1.0,
"title": "Version"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"version"
],
"title": "Version"
}
}