{ "openapi": "3.1.1", "info": { "title": "Pdfly.Api | v1", "version": "1.0.0" }, "servers": [ { "url": "https://api.paperwright.dev/" } ], "paths": { "/health": { "get": { "tags": [ "Pdfly.Api" ], "operationId": "Health", "responses": { "200": { "description": "OK" } } } }, "/api/render": { "post": { "tags": [ "Templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenderInlineBody" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/invites/{token}": { "get": { "tags": [ "Invites" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/invites/{token}/accept": { "post": { "tags": [ "Invites" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/auth/signup": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignUpBody" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/auth/login": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginBody" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/auth/verify-email": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyEmailBody" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/auth/resend-verification": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailBody" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/auth/forgot-password": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailBody" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/auth/reset-password": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResetPasswordBody" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/auth/refresh": { "post": { "tags": [ "Auth" ], "responses": { "200": { "description": "OK" } } } }, "/api/auth/logout": { "post": { "tags": [ "Auth" ], "responses": { "200": { "description": "OK" } } } }, "/api/auth/logout-all": { "post": { "tags": [ "Auth" ], "responses": { "200": { "description": "OK" } } } }, "/api/auth/change-password": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordBody" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/auth/me": { "get": { "tags": [ "Auth" ], "responses": { "200": { "description": "OK" } } } }, "/api/auth/session": { "get": { "tags": [ "Auth" ], "responses": { "200": { "description": "OK" } } } }, "/api/auth/switch-workspace/{workspaceId}": { "post": { "tags": [ "Auth" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/auth/oauth/{provider}/start": { "get": { "tags": [ "Auth" ], "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "redirect", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/auth/oauth/{provider}/callback": { "get": { "tags": [ "Auth" ], "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "code", "in": "query", "schema": { "type": "string" } }, { "name": "state", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/templates": { "get": { "tags": [ "Templates" ], "parameters": [ { "name": "name", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTemplateBody" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/templates/import-html": { "post": { "tags": [ "Templates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportHtmlBody" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/templates/{id}": { "get": { "tags": [ "Templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTemplateBody" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/templates/{id}/upgrade-to-report": { "post": { "tags": [ "Templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/templates/{id}/render": { "post": { "tags": [ "Templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenderTemplateBody" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/templates/{id}/base-pdf": { "post": { "tags": [ "Templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "$ref": "#/components/schemas/IFormFile" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "Templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/templates/{id}/base-pdf/pages/{index}": { "get": { "tags": [ "Templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "index", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/templates/{id}/send-email": { "post": { "tags": [ "Templates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendTemplateEmailBody" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/templates/{templateId}/versions": { "get": { "tags": [ "Template versions" ], "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "before", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Template versions" ], "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVersionBody" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/templates/{templateId}/versions/{versionId}": { "get": { "tags": [ "Template versions" ], "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "patch": { "tags": [ "Template versions" ], "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenameVersionBody" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/api-keys": { "get": { "tags": [ "ApiKeys" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "ApiKeys" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyBody" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/api-keys/{id}": { "delete": { "tags": [ "ApiKeys" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/usage": { "get": { "tags": [ "Usage" ], "responses": { "200": { "description": "OK" } } } }, "/api/usage/daily": { "get": { "tags": [ "Usage" ], "responses": { "200": { "description": "OK" } } } }, "/api/workspaces": { "get": { "tags": [ "Workspaces" ], "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/current/members": { "get": { "tags": [ "Workspaces" ], "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/current/invites": { "post": { "tags": [ "Workspaces" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InviteMemberBody" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/workspaces/current/members/{userId}": { "delete": { "tags": [ "Workspaces" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "patch": { "tags": [ "Workspaces" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMemberRoleBody" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/presence": { "post": { "tags": [ "Presence" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HeartbeatBody" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/presence/{resourceType}/{resourceId}": { "get": { "tags": [ "Presence" ], "parameters": [ { "name": "resourceType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Presence" ], "parameters": [ { "name": "resourceType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/templates/{templateId}/comments": { "get": { "tags": [ "Comments" ], "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Comments" ], "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCommentBody" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/templates/{templateId}/comments/{commentId}": { "delete": { "tags": [ "Comments" ], "parameters": [ { "name": "commentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/ai/generate-template": { "post": { "tags": [ "AI" ], "responses": { "200": { "description": "OK" } } } }, "/api/ai/generate-band-template": { "post": { "tags": [ "AI" ], "responses": { "200": { "description": "OK" } } } }, "/api/ai/refine-band": { "post": { "tags": [ "AI" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefineBandRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/ai/revise-document": { "post": { "tags": [ "AI" ], "responses": { "200": { "description": "OK" } } } }, "/api/admin/workspaces": { "get": { "tags": [ "Admin" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/admin/workspaces/{workspaceId}/plan": { "post": { "tags": [ "Admin" ], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetWorkspacePlanRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/templates/{id}/render-batch": { "post": { "tags": [ "Batch" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBatchJsonBody" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/templates/{id}/render-batch/upload": { "post": { "tags": [ "Batch" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/templates/{id}/render-batch/template": { "get": { "tags": [ "Batch" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/templates/{id}/render-batch/jobs/{jobId}": { "get": { "tags": [ "Batch" ], "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/templates/{id}/render-batch/jobs": { "get": { "tags": [ "Batch" ], "responses": { "200": { "description": "OK" } } } }, "/api/templates/{id}/render-batch/jobs/{jobId}/result": { "get": { "tags": [ "Batch" ], "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "ChangePasswordBody": { "required": [ "currentPassword", "newPassword" ], "type": "object", "properties": { "currentPassword": { "type": "string" }, "newPassword": { "type": "string" } } }, "CreateApiKeyBody": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" } } }, "CreateBatchJsonBody": { "required": [ "rows", "output", "fileNamePattern", "emailColumn" ], "type": "object", "properties": { "rows": { "type": "array" }, "output": { "type": [ "null", "string" ] }, "fileNamePattern": { "type": [ "null", "string" ] }, "emailColumn": { "type": [ "null", "string" ] }, "theme": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RenderTheme" } ] } } }, "CreateCommentBody": { "required": [ "body" ], "type": "object", "properties": { "body": { "type": "string" } } }, "CreateTemplateBody": { "required": [ "name", "content" ], "type": "object", "properties": { "name": { "type": "string" }, "content": { "type": "string" }, "editorMode": { "type": [ "null", "string" ] } } }, "CreateVersionBody": { "required": [ "label" ], "type": "object", "properties": { "label": { "type": [ "null", "string" ] } } }, "EmailBody": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string" } } }, "GeneratedBand": { "required": [ "id", "parentId", "kind", "name", "height" ], "type": "object", "properties": { "id": { "type": "string" }, "parentId": { "type": [ "null", "string" ] }, "kind": { "type": "string" }, "name": { "type": [ "null", "string" ] }, "height": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "bindingField": { "type": [ "null", "string" ] }, "keepTogether": { "type": [ "null", "boolean" ] }, "pageBreakBefore": { "type": [ "null", "boolean" ] }, "pageBreakPerRow": { "type": [ "null", "boolean" ] }, "elements": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/GeneratedElement" } }, "failed": { "type": "boolean", "default": false } } }, "GeneratedBandTemplate": { "required": [ "name", "bands", "schema" ], "type": "object", "properties": { "name": { "type": "string" }, "bands": { "type": "array", "items": { "$ref": "#/components/schemas/GeneratedBand" } }, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GeneratedField" } }, "direction": { "type": "string", "default": "ltr" }, "bodyFont": { "type": [ "null", "string" ] }, "headingFont": { "type": [ "null", "string" ] }, "pageSize": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/GeneratedPageSize" } ] } } }, "GeneratedColumn": { "required": [ "key", "header", "width", "align" ], "type": "object", "properties": { "key": { "type": "string" }, "header": { "type": "string" }, "width": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "align": { "type": "string" } } }, "GeneratedCrop": { "required": [ "x", "y", "width", "height" ], "type": "object", "properties": { "x": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "y": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "width": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "height": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "GeneratedElement": { "required": [ "type", "x", "y", "width", "height" ], "type": "object", "properties": { "type": { "type": "string" }, "x": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "y": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "width": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "height": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "text": { "type": [ "null", "string" ] }, "role": { "type": [ "null", "string" ] }, "color": { "type": [ "null", "string" ] }, "align": { "type": [ "null", "string" ] }, "fontSize": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "fontWeight": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "bindingField": { "type": [ "null", "string" ] }, "columns": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/GeneratedColumn" } }, "lineHeight": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "fontFamily": { "type": [ "null", "string" ] }, "id": { "type": [ "null", "string" ] }, "crop": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/GeneratedCrop" } ] }, "src": { "type": [ "null", "string" ] } } }, "GeneratedField": { "required": [ "name", "type" ], "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "sampleValue": { "type": [ "null", "string" ] }, "itemFields": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/GeneratedItemField" } } } }, "GeneratedItemField": { "required": [ "name", "type" ], "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "sampleValue": { "type": [ "null", "string" ] }, "itemFields": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/GeneratedItemField" } }, "header": { "type": [ "null", "string" ] } } }, "GeneratedPageSize": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string" }, "orientation": { "type": [ "null", "string" ] }, "width": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "height": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "HeartbeatBody": { "required": [ "resourceType", "resourceId" ], "type": "object", "properties": { "resourceType": { "type": "string" }, "resourceId": { "type": "string", "format": "uuid" } } }, "IFormFile": { "type": "string", "format": "binary" }, "ImportHtmlBody": { "required": [ "name", "html" ], "type": "object", "properties": { "name": { "type": "string" }, "html": { "type": "string" }, "css": { "type": [ "null", "string" ] }, "pageSizeId": { "type": [ "null", "string" ] } } }, "InviteMemberBody": { "required": [ "email", "role" ], "type": "object", "properties": { "email": { "type": "string" }, "role": { "type": "string" } } }, "JsonElement": { }, "LoginBody": { "required": [ "email", "password" ], "type": "object", "properties": { "email": { "type": "string" }, "password": { "type": "string" } } }, "RefineBandRequest": { "required": [ "document", "bandId", "instruction" ], "type": "object", "properties": { "document": { "$ref": "#/components/schemas/GeneratedBandTemplate" }, "bandId": { "type": "string" }, "instruction": { "type": "string" } } }, "RenameVersionBody": { "required": [ "label" ], "type": "object", "properties": { "label": { "type": [ "null", "string" ] } } }, "RenderInlineBody": { "required": [ "content", "data" ], "type": "object", "properties": { "content": { "type": "string" }, "data": { "$ref": "#/components/schemas/JsonElement" }, "baseTemplateId": { "type": [ "null", "string" ], "format": "uuid" }, "theme": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RenderTheme" } ] } } }, "RenderTemplateBody": { "required": [ "data" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/JsonElement" }, "theme": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RenderTheme" } ] } } }, "RenderTheme": { "type": "object", "properties": { "primary": { "type": [ "null", "string" ] }, "accent": { "type": [ "null", "string" ] } } }, "ResetPasswordBody": { "required": [ "token", "newPassword" ], "type": "object", "properties": { "token": { "type": "string" }, "newPassword": { "type": "string" } } }, "SendTemplateEmailBody": { "required": [ "recipients", "data" ], "type": "object", "properties": { "recipients": { "type": "array", "items": { "type": "string" } }, "data": { "$ref": "#/components/schemas/JsonElement" }, "subject": { "type": [ "null", "string" ] }, "message": { "type": [ "null", "string" ] } } }, "SetWorkspacePlanRequest": { "required": [ "tier" ], "type": "object", "properties": { "tier": { "type": "string" } } }, "SignUpBody": { "required": [ "email", "password" ], "type": "object", "properties": { "email": { "type": "string" }, "password": { "type": "string" } } }, "UpdateMemberRoleBody": { "required": [ "role" ], "type": "object", "properties": { "role": { "type": "string" } } }, "UpdateTemplateBody": { "required": [ "name", "content" ], "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "content": { "type": "string" }, "expectedUpdatedAt": { "type": [ "null", "string" ] }, "yState": { "type": [ "null", "string" ] }, "yStateSeq": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" }, "versionKind": { "type": [ "null", "string" ] }, "restoredFromVersionId": { "type": [ "null", "string" ], "format": "uuid" } } }, "VerifyEmailBody": { "required": [ "token" ], "type": "object", "properties": { "token": { "type": "string" } } } } }, "tags": [ { "name": "Pdfly.Api" }, { "name": "Templates" }, { "name": "Invites" }, { "name": "Auth" }, { "name": "Template versions" }, { "name": "ApiKeys" }, { "name": "Usage" }, { "name": "Workspaces" }, { "name": "Presence" }, { "name": "Comments" }, { "name": "AI" }, { "name": "Admin" }, { "name": "Batch" } ] }