{"openapi":"3.1.0","info":{"title":"Typefold API","version":"0.0.0","description":"Every endpoint with its request and response schemas. Send an API key in the `x-api-key` header. The rules all requests share are in [HTTP API](/clients/http/)."},"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"x-api-key","description":"An API key, created in Studio under **Manage → API keys**."},"session":{"type":"apiKey","in":"cookie","name":"better-auth.session_token","description":"A signed-in Studio session."}},"schemas":{"JsonValue":{"anyOf":[{"type":"null"},{"type":"boolean"},{"type":"number"},{"type":"string"},{"type":"array","items":{"$ref":"#/components/schemas/JsonValue"}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/JsonValue"}}]},"DataSchema":{"description":"A JSON Schema describing the report's data.","type":"object","properties":{"type":{"anyOf":[{"type":"string","enum":["null","boolean","number","string","array","object"]},{"type":"array","items":{"type":"string","enum":["null","boolean","number","string","array","object"]}}]},"properties":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/DataSchema"}},"required":{"type":"array","items":{"type":"string"}},"items":{"$ref":"#/components/schemas/DataSchema"},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/DataSchema"}},"const":{"type":"string"}},"additionalProperties":false},"CompositionNode":{"anyOf":[{"type":"object","properties":{"className":{"type":"string","maxLength":1000},"style":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":["string","number"]}},"visibleWhen":{"type":"object","properties":{"path":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":128}},"scope":{"type":"string","enum":["root","current"]},"operator":{"type":"string","enum":["truthy","falsy","equals","notEquals","exists","notExists"]},"value":{"anyOf":[{"type":"string","maxLength":100000},{"type":"number"},{"type":"boolean"}]}},"required":["path","operator"],"additionalProperties":false},"type":{"type":"string","const":"container"},"children":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/CompositionNode"}}},"required":["type","children"],"additionalProperties":false},{"type":"object","properties":{"className":{"type":"string","maxLength":1000},"style":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":["string","number"]}},"visibleWhen":{"type":"object","properties":{"path":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":128}},"scope":{"type":"string","enum":["root","current"]},"operator":{"type":"string","enum":["truthy","falsy","equals","notEquals","exists","notExists"]},"value":{"anyOf":[{"type":"string","maxLength":100000},{"type":"number"},{"type":"boolean"}]}},"required":["path","operator"],"additionalProperties":false},"type":{"type":"string","const":"text"},"text":{"anyOf":[{"anyOf":[{"anyOf":[{"type":"string","maxLength":100000},{"type":"number"},{"type":"boolean"}]},{"type":"object","properties":{"path":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":128}},"scope":{"type":"string","enum":["root","current"]},"fallback":{"anyOf":[{"type":"string","maxLength":100000},{"type":"number"},{"type":"boolean"}]},"format":{"type":"object","properties":{"type":{"type":"string","enum":["number","currency","percent","date"]},"locale":{"type":"string","minLength":2,"maxLength":64},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"minimumFractionDigits":{"type":"integer","minimum":0,"maximum":20},"maximumFractionDigits":{"type":"integer","minimum":0,"maximum":20},"dateStyle":{"type":"string","enum":["short","medium","long","full"]},"timeZone":{"type":"string","minLength":1,"maxLength":64}},"required":["type"],"additionalProperties":false},"prefix":{"type":"string","maxLength":1000},"suffix":{"type":"string","maxLength":1000}},"required":["path"],"additionalProperties":false}]},{"type":"object","properties":{"parts":{"minItems":1,"maxItems":100,"type":"array","items":{"anyOf":[{"anyOf":[{"type":"string","maxLength":100000},{"type":"number"},{"type":"boolean"}]},{"type":"object","properties":{"path":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":128}},"scope":{"type":"string","enum":["root","current"]},"fallback":{"anyOf":[{"type":"string","maxLength":100000},{"type":"number"},{"type":"boolean"}]},"format":{"type":"object","properties":{"type":{"type":"string","enum":["number","currency","percent","date"]},"locale":{"type":"string","minLength":2,"maxLength":64},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"minimumFractionDigits":{"type":"integer","minimum":0,"maximum":20},"maximumFractionDigits":{"type":"integer","minimum":0,"maximum":20},"dateStyle":{"type":"string","enum":["short","medium","long","full"]},"timeZone":{"type":"string","minLength":1,"maxLength":64}},"required":["type"],"additionalProperties":false},"prefix":{"type":"string","maxLength":1000},"suffix":{"type":"string","maxLength":1000}},"required":["path"],"additionalProperties":false}]}}},"required":["parts"],"additionalProperties":false}]}},"required":["type","text"],"additionalProperties":false},{"type":"object","properties":{"className":{"type":"string","maxLength":1000},"style":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":["string","number"]}},"visibleWhen":{"type":"object","properties":{"path":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":128}},"scope":{"type":"string","enum":["root","current"]},"operator":{"type":"string","enum":["truthy","falsy","equals","notEquals","exists","notExists"]},"value":{"anyOf":[{"type":"string","maxLength":100000},{"type":"number"},{"type":"boolean"}]}},"required":["path","operator"],"additionalProperties":false},"type":{"type":"string","const":"image"},"assetId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"object","properties":{"path":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":128}},"scope":{"type":"string","enum":["root","current"]},"fallback":{"anyOf":[{"type":"string","maxLength":100000},{"type":"number"},{"type":"boolean"}]},"format":{"type":"object","properties":{"type":{"type":"string","enum":["number","currency","percent","date"]},"locale":{"type":"string","minLength":2,"maxLength":64},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"minimumFractionDigits":{"type":"integer","minimum":0,"maximum":20},"maximumFractionDigits":{"type":"integer","minimum":0,"maximum":20},"dateStyle":{"type":"string","enum":["short","medium","long","full"]},"timeZone":{"type":"string","minLength":1,"maxLength":64}},"required":["type"],"additionalProperties":false},"prefix":{"type":"string","maxLength":1000},"suffix":{"type":"string","maxLength":1000}},"required":["path"],"additionalProperties":false}]},"width":{"type":"number","exclusiveMinimum":0},"height":{"type":"number","exclusiveMinimum":0}},"required":["type","assetId"],"additionalProperties":false},{"type":"object","properties":{"className":{"type":"string","maxLength":1000},"style":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":["string","number"]}},"visibleWhen":{"type":"object","properties":{"path":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":128}},"scope":{"type":"string","enum":["root","current"]},"operator":{"type":"string","enum":["truthy","falsy","equals","notEquals","exists","notExists"]},"value":{"anyOf":[{"type":"string","maxLength":100000},{"type":"number"},{"type":"boolean"}]}},"required":["path","operator"],"additionalProperties":false},"type":{"type":"string","const":"repeat"},"source":{"type":"object","properties":{"path":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":128}},"scope":{"type":"string","enum":["root","current"]}},"required":["path"],"additionalProperties":false},"children":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/CompositionNode"}},"empty":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/CompositionNode"}}},"required":["type","source","children"],"additionalProperties":false},{"type":"object","properties":{"className":{"type":"string","maxLength":1000},"style":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":["string","number"]}},"visibleWhen":{"type":"object","properties":{"path":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":128}},"scope":{"type":"string","enum":["root","current"]},"operator":{"type":"string","enum":["truthy","falsy","equals","notEquals","exists","notExists"]},"value":{"anyOf":[{"type":"string","maxLength":100000},{"type":"number"},{"type":"boolean"}]}},"required":["path","operator"],"additionalProperties":false},"type":{"type":"string","const":"table"},"source":{"type":"object","properties":{"path":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":128}},"scope":{"type":"string","enum":["root","current"]}},"required":["path"],"additionalProperties":false},"columns":{"minItems":1,"maxItems":30,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"header":{"type":"string","maxLength":1000},"value":{"anyOf":[{"anyOf":[{"anyOf":[{"type":"string","maxLength":100000},{"type":"number"},{"type":"boolean"}]},{"type":"object","properties":{"path":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":128}},"scope":{"type":"string","enum":["root","current"]},"fallback":{"anyOf":[{"type":"string","maxLength":100000},{"type":"number"},{"type":"boolean"}]},"format":{"type":"object","properties":{"type":{"type":"string","enum":["number","currency","percent","date"]},"locale":{"type":"string","minLength":2,"maxLength":64},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"minimumFractionDigits":{"type":"integer","minimum":0,"maximum":20},"maximumFractionDigits":{"type":"integer","minimum":0,"maximum":20},"dateStyle":{"type":"string","enum":["short","medium","long","full"]},"timeZone":{"type":"string","minLength":1,"maxLength":64}},"required":["type"],"additionalProperties":false},"prefix":{"type":"string","maxLength":1000},"suffix":{"type":"string","maxLength":1000}},"required":["path"],"additionalProperties":false}]},{"type":"object","properties":{"parts":{"minItems":1,"maxItems":100,"type":"array","items":{"anyOf":[{"anyOf":[{"type":"string","maxLength":100000},{"type":"number"},{"type":"boolean"}]},{"type":"object","properties":{"path":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":128}},"scope":{"type":"string","enum":["root","current"]},"fallback":{"anyOf":[{"type":"string","maxLength":100000},{"type":"number"},{"type":"boolean"}]},"format":{"type":"object","properties":{"type":{"type":"string","enum":["number","currency","percent","date"]},"locale":{"type":"string","minLength":2,"maxLength":64},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"minimumFractionDigits":{"type":"integer","minimum":0,"maximum":20},"maximumFractionDigits":{"type":"integer","minimum":0,"maximum":20},"dateStyle":{"type":"string","enum":["short","medium","long","full"]},"timeZone":{"type":"string","minLength":1,"maxLength":64}},"required":["type"],"additionalProperties":false},"prefix":{"type":"string","maxLength":1000},"suffix":{"type":"string","maxLength":1000}},"required":["path"],"additionalProperties":false}]}}},"required":["parts"],"additionalProperties":false}]},"width":{"type":"number","exclusiveMinimum":0,"maximum":2000},"style":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":["string","number"]}}},"required":["id","header","value"],"additionalProperties":false}},"showHeader":{"type":"boolean"},"headerStyle":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":["string","number"]}},"cellStyle":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":["string","number"]}},"emptyText":{"type":"string","maxLength":10000}},"required":["type","source","columns"],"additionalProperties":false},{"type":"object","properties":{"className":{"type":"string","maxLength":1000},"style":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":["string","number"]}},"visibleWhen":{"type":"object","properties":{"path":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":128}},"scope":{"type":"string","enum":["root","current"]},"operator":{"type":"string","enum":["truthy","falsy","equals","notEquals","exists","notExists"]},"value":{"anyOf":[{"type":"string","maxLength":100000},{"type":"number"},{"type":"boolean"}]}},"required":["path","operator"],"additionalProperties":false},"type":{"type":"string","const":"component"},"componentId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"data":{"type":"object","properties":{"path":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":128}},"scope":{"type":"string","enum":["root","current"]}},"required":["path"],"additionalProperties":false}},"required":["type","componentId"],"additionalProperties":false}]},"DocumentNode":{"anyOf":[{"type":"object","properties":{"tagName":{"type":"string"},"className":{"type":"string"},"id":{"type":"string"},"dir":{"type":"string","enum":["ltr","rtl"]},"lang":{"type":"string"},"attributes":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"tw":{"type":"string"},"style":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":["string","number"]}},"preset":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":["string","number"]}},"type":{"type":"string","const":"container"},"children":{"maxItems":1000,"type":"array","items":{"$ref":"#/components/schemas/DocumentNode"}}},"required":["type"],"additionalProperties":false},{"type":"object","properties":{"tagName":{"type":"string"},"className":{"type":"string"},"id":{"type":"string"},"dir":{"type":"string","enum":["ltr","rtl"]},"lang":{"type":"string"},"attributes":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"tw":{"type":"string"},"style":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":["string","number"]}},"preset":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":["string","number"]}},"type":{"type":"string","const":"text"},"text":{"type":"string"}},"required":["type","text"],"additionalProperties":false},{"type":"object","properties":{"tagName":{"type":"string"},"className":{"type":"string"},"id":{"type":"string"},"dir":{"type":"string","enum":["ltr","rtl"]},"lang":{"type":"string"},"attributes":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"tw":{"type":"string"},"style":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":["string","number"]}},"preset":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":["string","number"]}},"type":{"type":"string","const":"image"},"src":{"type":"string","minLength":1,"maxLength":2048},"width":{"type":"number","exclusiveMinimum":0},"height":{"type":"number","exclusiveMinimum":0}},"required":["type","src"],"additionalProperties":false}]}}},"paths":{"/health":{"get":{"operationId":"getHealth","summary":"Readiness check","tags":["Status"],"description":"Answers `200` when the API can reach its database and Redis, and `503` naming what it cannot reach.","security":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]}},"required":["status"],"additionalProperties":false,"title":"HealthResponse"}}}},"503":{"description":"Unavailable","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["unavailable"]},"unavailable":{"type":"array","items":{"type":"string","enum":["database","redis"]}}},"required":["status","unavailable"],"additionalProperties":false,"title":"HealthUnavailableResponse"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/health/live":{"get":{"operationId":"getLiveness","summary":"Liveness check","tags":["Status"],"description":"Answers `200` whenever the API process is up. Self-hosted, it is served only on the API's internal port.","security":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]}},"required":["status"],"additionalProperties":false,"title":"HealthResponse"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/render-limits":{"get":{"operationId":"getRenderLimits","summary":"Get the workspace's render allowances","tags":["Workspace administration"],"description":"Needs `render:read`.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"maxActiveRenders":{"type":"integer","minimum":1,"maximum":100000},"rendersPerMinute":{"type":"integer","minimum":1,"maximum":10000000},"documentsPerMonth":{"anyOf":[{"type":"integer","minimum":0,"maximum":1000000000},{"type":"null"}],"description":"Real documents the workspace may produce per calendar month (UTC): renders that are not test renders, and XLSX outputs. While it is set, previews are test renders. Null is unlimited."},"maxStorageBytes":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"Bytes of uploaded files the workspace may keep. Null is unlimited."},"testRendersPerDay":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000000},{"type":"null"}],"description":"Test renders the workspace may create per day (UTC). Null is unlimited."},"templateConversionsPerMonth":{"anyOf":[{"type":"integer","minimum":0,"maximum":1000000},{"type":"null"}],"description":"Templates the workspace may create from a PDF with AI per calendar month (UTC). Null is unlimited."},"suspended":{"type":"boolean","description":"A suspended workspace renders nothing and refuses its API keys; its members can still read and export its data."},"documentsThisMonth":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Real documents produced this calendar month (UTC), including those in progress."},"storageBytes":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Bytes of uploaded files the workspace keeps."},"testRendersToday":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Test renders created today (UTC)."},"templateConversionsThisMonth":{"type":"integer","minimum":0,"maximum":9007199254740991,"description":"Templates created from a PDF this calendar month (UTC), including one in progress."}},"required":["maxActiveRenders","rendersPerMinute","documentsPerMonth","maxStorageBytes","testRendersPerDay","templateConversionsPerMonth","suspended","documentsThisMonth","storageBytes","testRendersToday","templateConversionsThisMonth"],"additionalProperties":false,"title":"RenderLimits"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/companies/{id}/allowances":{"put":{"operationId":"updateCompanyAllowances","summary":"Replace a workspace's allowances","tags":["Platform administration"],"description":"`id` is the workspace ID. Needs a platform administrator's Studio session.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"maxActiveRenders":{"type":"integer","minimum":1,"maximum":100000},"rendersPerMinute":{"type":"integer","minimum":1,"maximum":10000000},"documentsPerMonth":{"anyOf":[{"type":"integer","minimum":0,"maximum":1000000000},{"type":"null"}],"description":"Real documents the workspace may produce per calendar month (UTC): renders that are not test renders, and XLSX outputs. While it is set, previews are test renders. Null is unlimited."},"maxStorageBytes":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"Bytes of uploaded files the workspace may keep. Null is unlimited."},"testRendersPerDay":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000000},{"type":"null"}],"description":"Test renders the workspace may create per day (UTC). Null is unlimited."},"templateConversionsPerMonth":{"anyOf":[{"type":"integer","minimum":0,"maximum":1000000},{"type":"null"}],"description":"Templates the workspace may create from a PDF with AI per calendar month (UTC). Null is unlimited."},"suspended":{"type":"boolean","description":"A suspended workspace renders nothing and refuses its API keys; its members can still read and export its data."}},"required":["maxActiveRenders","rendersPerMinute"],"additionalProperties":false,"title":"UpdateCompanyAllowances"}}}},"parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"security":[{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"maxActiveRenders":{"type":"integer","minimum":1,"maximum":100000},"rendersPerMinute":{"type":"integer","minimum":1,"maximum":10000000},"documentsPerMonth":{"anyOf":[{"type":"integer","minimum":0,"maximum":1000000000},{"type":"null"}],"description":"Real documents the workspace may produce per calendar month (UTC): renders that are not test renders, and XLSX outputs. While it is set, previews are test renders. Null is unlimited."},"maxStorageBytes":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"Bytes of uploaded files the workspace may keep. Null is unlimited."},"testRendersPerDay":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000000},{"type":"null"}],"description":"Test renders the workspace may create per day (UTC). Null is unlimited."},"templateConversionsPerMonth":{"anyOf":[{"type":"integer","minimum":0,"maximum":1000000},{"type":"null"}],"description":"Templates the workspace may create from a PDF with AI per calendar month (UTC). Null is unlimited."},"suspended":{"type":"boolean","description":"A suspended workspace renders nothing and refuses its API keys; its members can still read and export its data."}},"required":["maxActiveRenders","rendersPerMinute","documentsPerMonth","maxStorageBytes","testRendersPerDay","templateConversionsPerMonth","suspended"],"additionalProperties":false,"title":"CompanyAllowances"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/platform/workspaces":{"get":{"operationId":"listPlatformWorkspaces","summary":"List workspaces with their allowances","tags":["Platform administration"],"description":"Needs a platform administrator's Studio session.","parameters":[{"schema":{"type":"string"},"in":"query","name":"limit","required":false},{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"query","name":"cursor","required":false},{"schema":{"type":"string","maxLength":128},"in":"query","name":"search","required":false}],"security":[{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string"},"slug":{"type":"string"},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"maxActiveRenders":{"type":"integer","minimum":1,"maximum":100000},"rendersPerMinute":{"type":"integer","minimum":1,"maximum":10000000},"documentsPerMonth":{"anyOf":[{"type":"integer","minimum":0,"maximum":1000000000},{"type":"null"}],"description":"Real documents the workspace may produce per calendar month (UTC): renders that are not test renders, and XLSX outputs. While it is set, previews are test renders. Null is unlimited."},"maxStorageBytes":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"Bytes of uploaded files the workspace may keep. Null is unlimited."},"testRendersPerDay":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000000},{"type":"null"}],"description":"Test renders the workspace may create per day (UTC). Null is unlimited."},"templateConversionsPerMonth":{"anyOf":[{"type":"integer","minimum":0,"maximum":1000000},{"type":"null"}],"description":"Templates the workspace may create from a PDF with AI per calendar month (UTC). Null is unlimited."},"suspended":{"type":"boolean","description":"A suspended workspace renders nothing and refuses its API keys; its members can still read and export its data."}},"required":["id","name","slug","createdAt","maxActiveRenders","rendersPerMinute","documentsPerMonth","maxStorageBytes","testRendersPerDay","templateConversionsPerMonth","suspended"],"additionalProperties":false,"title":"PlatformWorkspace"}},"nextCursor":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"}},"required":["items"],"additionalProperties":false,"title":"PlatformWorkspaceList"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/platform/workspaces/{id}":{"get":{"operationId":"getPlatformWorkspace","summary":"Get a workspace and its allowances","tags":["Platform administration"],"description":"Needs a platform administrator's Studio session.","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"security":[{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string"},"slug":{"type":"string"},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"maxActiveRenders":{"type":"integer","minimum":1,"maximum":100000},"rendersPerMinute":{"type":"integer","minimum":1,"maximum":10000000},"documentsPerMonth":{"anyOf":[{"type":"integer","minimum":0,"maximum":1000000000},{"type":"null"}],"description":"Real documents the workspace may produce per calendar month (UTC): renders that are not test renders, and XLSX outputs. While it is set, previews are test renders. Null is unlimited."},"maxStorageBytes":{"anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}],"description":"Bytes of uploaded files the workspace may keep. Null is unlimited."},"testRendersPerDay":{"anyOf":[{"type":"integer","minimum":0,"maximum":10000000},{"type":"null"}],"description":"Test renders the workspace may create per day (UTC). Null is unlimited."},"templateConversionsPerMonth":{"anyOf":[{"type":"integer","minimum":0,"maximum":1000000},{"type":"null"}],"description":"Templates the workspace may create from a PDF with AI per calendar month (UTC). Null is unlimited."},"suspended":{"type":"boolean","description":"A suspended workspace renders nothing and refuses its API keys; its members can still read and export its data."}},"required":["id","name","slug","createdAt","maxActiveRenders","rendersPerMinute","documentsPerMonth","maxStorageBytes","testRendersPerDay","templateConversionsPerMonth","suspended"],"additionalProperties":false,"title":"PlatformWorkspace"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/api-keys":{"post":{"operationId":"createApiKey","summary":"Create an API key","tags":["Workspace administration"],"description":"The response holds the secret, shown only once. Needs a signed-in Studio session with `admin:manage`; API keys are refused.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64},"scopes":{"maxItems":14,"type":"array","items":{"type":"string","enum":["template:read","template:write","template:publish","template:content","render:create","render:read","render:cancel","asset:manage","audit:read","usage:read","webhook:manage","certificate:manage","destination:manage","admin:manage"]}},"expiresInDays":{"type":"integer","minimum":1,"maximum":365}},"required":["name","scopes"],"additionalProperties":false,"title":"CreateApiKeyBody"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string","minLength":1,"maxLength":64},"prefix":{"type":"string","minLength":1},"start":{"type":"string","minLength":1},"scopes":{"type":"array","items":{"type":"string","enum":["template:read","template:write","template:publish","template:content","render:create","render:read","render:cancel","asset:manage","audit:read","usage:read","webhook:manage","certificate:manage","destination:manage","admin:manage"]}},"enabled":{"type":"boolean"},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"lastUsedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"expiresAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"managed":{"type":"boolean","enum":[true]},"secret":{"type":"string","minLength":1}},"required":["id","name","prefix","start","scopes","enabled","createdAt","secret"],"additionalProperties":false,"title":"ApiKeyCreated"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}},"get":{"operationId":"listApiKeys","summary":"List API keys","tags":["Workspace administration"],"description":"Never their secrets. Needs `admin:manage`.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string","minLength":1,"maxLength":64},"prefix":{"type":"string","minLength":1},"start":{"type":"string","minLength":1},"scopes":{"type":"array","items":{"type":"string","enum":["template:read","template:write","template:publish","template:content","render:create","render:read","render:cancel","asset:manage","audit:read","usage:read","webhook:manage","certificate:manage","destination:manage","admin:manage"]}},"enabled":{"type":"boolean"},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"lastUsedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"expiresAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"managed":{"type":"boolean","enum":[true]}},"required":["id","name","prefix","start","scopes","enabled","createdAt"],"additionalProperties":false,"title":"ApiKey"}}},"required":["items"],"additionalProperties":false,"title":"ApiKeyList"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/api-keys/{id}":{"delete":{"operationId":"deleteApiKey","summary":"Delete an API key","tags":["Workspace administration"],"description":"Needs a signed-in Studio session with `admin:manage`; API keys are refused.","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"deleted":{"type":"boolean","enum":[true]}},"required":["id","deleted"],"additionalProperties":false,"title":"ApiKeyDeleted"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/api-keys/{id}/rotate":{"post":{"operationId":"rotateApiKey","summary":"Replace an API key's secret","tags":["Workspace administration"],"description":"Needs a signed-in Studio session with `admin:manage`; API keys are refused.","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string","minLength":1,"maxLength":64},"prefix":{"type":"string","minLength":1},"start":{"type":"string","minLength":1},"scopes":{"type":"array","items":{"type":"string","enum":["template:read","template:write","template:publish","template:content","render:create","render:read","render:cancel","asset:manage","audit:read","usage:read","webhook:manage","certificate:manage","destination:manage","admin:manage"]}},"enabled":{"type":"boolean"},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"lastUsedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"expiresAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"managed":{"type":"boolean","enum":[true]},"secret":{"type":"string","minLength":1}},"required":["id","name","prefix","start","scopes","enabled","createdAt","secret"],"additionalProperties":false,"title":"ApiKeyCreated"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/api-keys/{id}/revoke":{"post":{"operationId":"revokeApiKey","summary":"Disable an API key","tags":["Workspace administration"],"description":"Needs a signed-in Studio session with `admin:manage`; API keys are refused.","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"revoked":{"type":"boolean","enum":[true]}},"required":["id","revoked"],"additionalProperties":false,"title":"ApiKeyRevoked"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/assets":{"get":{"operationId":"listAssets","summary":"List assets","tags":["Assets"],"description":"Newest first; filter with `kind`. Needs `asset:manage`.","parameters":[{"schema":{"type":"string","enum":["image","svg","font","stylesheet","workbook","pdf"]},"in":"query","name":"kind","required":false},{"schema":{"type":"string"},"in":"query","name":"limit","required":false},{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"query","name":"cursor","required":false}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","enum":["image","svg","font","stylesheet","workbook","pdf"]},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/svg+xml","font/woff2","font/ttf","font/otf","text/css","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/pdf"]},"size":{"type":"integer","exclusiveMinimum":0,"maximum":50000000},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"},"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["kind","filename","mediaType","size","sha256","id","createdAt"],"additionalProperties":false,"title":"Asset"}},"nextCursor":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"}},"required":["items"],"additionalProperties":false,"title":"AssetList"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}},"post":{"operationId":"createAsset","summary":"Register an asset and get an upload URL","tags":["Assets"],"description":"Needs `asset:manage`. A credential with `template:content` can upload images for content fields.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["image","svg","font","stylesheet","workbook","pdf"]},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/svg+xml","font/woff2","font/ttf","font/otf","text/css","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/pdf"]},"size":{"type":"integer","exclusiveMinimum":0,"maximum":50000000},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"}},"required":["kind","filename","mediaType","size","sha256"],"additionalProperties":false,"title":"CreateAssetBody"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["image","svg","font","stylesheet","workbook","pdf"]},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/svg+xml","font/woff2","font/ttf","font/otf","text/css","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/pdf"]},"size":{"type":"integer","exclusiveMinimum":0,"maximum":50000000},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"},"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"uploadMethod":{"type":"string","enum":["PUT"]},"uploadUrl":{"type":"string"},"uploadHeaders":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"uploadExpiresAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["kind","filename","mediaType","size","sha256","id","createdAt","uploadMethod","uploadUrl","uploadHeaders","uploadExpiresAt"],"additionalProperties":false,"title":"AssetCreated"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/assets/{id}":{"get":{"operationId":"getAsset","summary":"Get an asset and a download URL","tags":["Assets"],"description":"Needs `asset:manage`.","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"kind":{"type":"string","enum":["image","svg","font","stylesheet","workbook","pdf"]},"filename":{"type":"string","minLength":1,"maxLength":255},"mediaType":{"type":"string","enum":["image/png","image/jpeg","image/svg+xml","font/woff2","font/ttf","font/otf","text/css","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/pdf"]},"size":{"type":"integer","exclusiveMinimum":0,"maximum":50000000},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"},"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"downloadUrl":{"type":"string"},"expiresAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["kind","filename","mediaType","size","sha256","id","createdAt","downloadUrl","expiresAt"],"additionalProperties":false,"title":"AssetDetail"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}},"delete":{"operationId":"deleteAsset","summary":"Delete an asset","tags":["Assets"],"description":"Needs `asset:manage`.","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"deleted":{"type":"boolean","enum":[true]}},"required":["id","deleted"],"additionalProperties":false,"title":"AssetDeleted"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/audit-events":{"get":{"operationId":"listAuditEvents","summary":"List audit events","tags":["Workspace administration"],"description":"Newest first. Needs `audit:read`.","parameters":[{"schema":{"type":"string"},"in":"query","name":"limit","required":false},{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"query","name":"cursor","required":false},{"schema":{"type":"string","minLength":1,"maxLength":128},"in":"query","name":"action","required":false},{"schema":{"type":"string","enum":["user","api_key","system"]},"in":"query","name":"actorType","required":false},{"schema":{"type":"string","minLength":1,"maxLength":128},"in":"query","name":"actorId","required":false},{"schema":{"type":"string","minLength":1,"maxLength":128},"in":"query","name":"resourceType","required":false},{"schema":{"type":"string","minLength":1,"maxLength":128},"in":"query","name":"resourceId","required":false},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"in":"query","name":"from","required":false},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"in":"query","name":"to","required":false}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"actorType":{"type":"string","enum":["user","api_key","system"]},"actorId":{"type":"string","minLength":1,"maxLength":128},"actorName":{"type":"string","minLength":1},"actorEmail":{"type":"string","minLength":1},"action":{"type":"string","minLength":1,"maxLength":128},"resourceType":{"type":"string","minLength":1,"maxLength":128},"resourceId":{"type":"string","minLength":1,"maxLength":128},"resourceName":{"type":"string","minLength":1},"resourceDeleted":{"type":"boolean"},"requestId":{"type":"string","minLength":1,"maxLength":128},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":["string","number","boolean","null"]}},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["id","actorType","actorId","action","resourceType","resourceId","requestId","metadata","createdAt"],"additionalProperties":false,"title":"AuditEvent"}},"nextCursor":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"}},"required":["items"],"additionalProperties":false,"title":"AuditEventList"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/audit-events/{id}":{"get":{"operationId":"getAuditEvent","summary":"Get an audit event","tags":["Workspace administration"],"description":"Needs `audit:read`.","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"actorType":{"type":"string","enum":["user","api_key","system"]},"actorId":{"type":"string","minLength":1,"maxLength":128},"actorName":{"type":"string","minLength":1},"actorEmail":{"type":"string","minLength":1},"action":{"type":"string","minLength":1,"maxLength":128},"resourceType":{"type":"string","minLength":1,"maxLength":128},"resourceId":{"type":"string","minLength":1,"maxLength":128},"resourceName":{"type":"string","minLength":1},"resourceDeleted":{"type":"boolean"},"requestId":{"type":"string","minLength":1,"maxLength":128},"metadata":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":["string","number","boolean","null"]}},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["id","actorType","actorId","action","resourceType","resourceId","requestId","metadata","createdAt"],"additionalProperties":false,"title":"AuditEvent"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/reports":{"get":{"operationId":"listReports","summary":"List published templates and the formats each renders","tags":["Reports"],"description":"Needs `template:read`.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"shortid":{"type":"string"},"name":{"type":"string"},"formats":{"type":"array","items":{"type":"string","enum":["pdf","xlsx"]}},"published":{"type":"boolean"},"folderPath":{"type":"string"}},"required":["id","name","formats","published"],"additionalProperties":false}}},"required":["items"],"additionalProperties":false,"title":"ReportList"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/reports/render":{"post":{"operationId":"renderReport","summary":"Render a published template and get the file","tags":["Reports"],"description":"Needs `render:create` and `template:read`. A PDF or image also needs `render:read`. See [Reports API](/guides/reports/).","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"format":{"type":"string","enum":["pdf","xlsx","png","jpeg","webp"]},"template":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"}},"required":["id"],"additionalProperties":false},{"type":"object","properties":{"shortid":{"type":"string","minLength":1,"maxLength":128}},"required":["shortid"],"additionalProperties":false},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120}},"required":["name"],"additionalProperties":false}]},"data":{"$ref":"#/components/schemas/JsonValue"},"locale":{"default":"en-US","type":"string","minLength":2,"maxLength":64},"pdf":{"type":"object","properties":{"pageSize":{"anyOf":[{"type":"string","enum":["A3","A4","A5","Letter","Legal"]},{"type":"object","properties":{"widthMm":{"type":"number","minimum":0.1,"maximum":2000},"heightMm":{"type":"number","minimum":0.1,"maximum":2000}},"required":["widthMm","heightMm"],"additionalProperties":false}]},"orientation":{"type":"string","enum":["portrait","landscape"]},"margins":{"type":"object","properties":{"topMm":{"type":"number","minimum":0,"maximum":500},"rightMm":{"type":"number","minimum":0,"maximum":500},"bottomMm":{"type":"number","minimum":0,"maximum":500},"leftMm":{"type":"number","minimum":0,"maximum":500}},"additionalProperties":false},"pageRanges":{"type":"string","maxLength":200},"metadata":{"type":"object","properties":{"title":{"type":"string","maxLength":500},"author":{"type":"string","maxLength":200},"subject":{"type":"string","maxLength":1000},"creator":{"type":"string","maxLength":200},"producer":{"type":"string","maxLength":200},"language":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","pattern":"^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3}$"}]},"keywords":{"maxItems":32,"type":"array","items":{"type":"string","maxLength":100}},"xmp":{"maxItems":4,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"prefix":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"namespace":{"type":"string","minLength":1,"maxLength":500,"pattern":"^[a-z][\\w+.-]*:\\S+$"},"properties":{"minItems":1,"maxItems":32,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"value":{"type":"string","maxLength":1000},"description":{"type":"string","minLength":1,"maxLength":1000}},"required":["name","value","description"],"additionalProperties":false}}},"required":["name","prefix","namespace","properties"],"additionalProperties":false,"title":"XmpSchema"}}},"additionalProperties":false,"title":"PdfMetadata"},"pdfa":{"type":"string","enum":["4","2b","2u","2a","3b","3u","3a","4f"],"title":"PdfaLevel"},"pdfua":{"type":"string","enum":["1","2"],"title":"PdfuaPart"},"opaqueFills":{"type":"boolean"},"preferCssPageSize":{"type":"boolean"},"attachments":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[^/\\\\\\p{Cc}]+$"},"mimeType":{"type":"string","maxLength":127,"pattern":"^[\\w.+-]+\\/[\\w.+-]+$"},"description":{"type":"string","minLength":1,"maxLength":1000},"relationship":{"type":"string","enum":["source","data","alternative","supplement","unspecified"]},"content":{"type":"string"},"contentBase64":{"type":"string","pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"}},"required":["name"],"additionalProperties":false,"title":"PdfAttachment"}},"encryption":{"type":"object","properties":{"openPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"ownerPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"permissions":{"type":"object","properties":{"printing":{"type":"string","enum":["none","lowResolution","highResolution"]},"modifying":{"type":"boolean"},"copying":{"type":"boolean"},"annotating":{"type":"boolean"},"fillingForms":{"type":"boolean"},"contentAccessibility":{"type":"boolean"},"documentAssembly":{"type":"boolean"}},"additionalProperties":false,"title":"PdfPermissions"}},"additionalProperties":false,"title":"PdfEncryption"},"signature":{"type":"object","properties":{"certificate":{"type":"string","maxLength":120},"reason":{"type":"string","maxLength":200},"location":{"type":"string","maxLength":200},"contactInfo":{"type":"string","maxLength":200},"field":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"maximum":100000},"xMm":{"type":"number","minimum":0,"maximum":2000},"yMm":{"type":"number","minimum":0,"maximum":2000},"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["xMm","yMm","widthMm","heightMm"],"additionalProperties":false,"title":"PdfSignatureField"}},"additionalProperties":false,"title":"PdfSignatureOverride"},"operations":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["append","prepend","merge"]},"template":{"type":"string","minLength":1,"maxLength":120},"pdf":{"type":"string","minLength":1,"maxLength":255},"mergeWholeDocument":{"type":"boolean"},"mergeToFront":{"type":"boolean"},"renderForEveryPage":{"type":"boolean"}},"required":["type"],"additionalProperties":false,"title":"PdfOperation"}},"watermark":{"type":"object","properties":{"text":{"type":"string","maxLength":200,"pattern":"^(?=.*\\S)[^\\p{Cc}]+$","description":"The text, such as `DRAFT` or `CONFIDENTIAL`. One line."},"opacity":{"type":"number","minimum":0,"maximum":1,"description":"From 0 (invisible) to 1 (solid). Default 0.3."},"rotation":{"type":"number","minimum":-360,"maximum":360,"description":"Angle in degrees, counter-clockwise; 0 is horizontal. Default: along the page's diagonal from the bottom left."},"fontSize":{"type":"number","exclusiveMinimum":0,"maximum":500,"description":"Size in points. Default: the text spans 60% of the page along its angle, at most 144 pt."},"color":{"type":"string","pattern":"^#(?:[0-9a-f]{3}|[0-9a-f]{6})$","description":"Hex colour such as `#c00000`. Default `#808080` (gray)."}},"required":["text"],"additionalProperties":false,"title":"PdfWatermark"}},"additionalProperties":false,"title":"ReportPdfOptions"},"image":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"maximum":200,"description":"The page to draw, from 1. Default 1."},"width":{"type":"integer","minimum":16,"maximum":4096,"description":"The image's width in pixels; the height follows the page's shape. Default: the page's width in CSS pixels, so a page of 1200 × 630 px gives a 1200 × 630 image."},"quality":{"type":"integer","minimum":1,"maximum":100,"description":"JPEG quality from 1 to 100. Default 90. JPEG only."}},"additionalProperties":false,"title":"ImageOptions"},"test":{"type":"boolean","description":"Render a free test document with a diagonal \"TEST\" watermark on every page. It does not count against the workspace's render allowances. PDF and images only."}},"required":["format","template"],"additionalProperties":false,"title":"RenderReportBody"}}}},"parameters":[{"schema":{"type":"string","minLength":1,"maxLength":255},"in":"header","name":"idempotency-key","required":false,"description":"Repeating a request with the same key returns the first result instead of rendering twice. See [idempotency keys](/guides/rendering/#idempotency-keys)."}],"responses":{"200":{"description":"OK"}}}},"/v1/reports/data-schema":{"get":{"operationId":"getReportDataSchema","summary":"Get the JSON Schema of the data a template renders","tags":["Reports"],"description":"Needs `template:read`.","parameters":[{"schema":{"type":"string","enum":["pdf","xlsx"]},"in":"query","name":"format","required":true},{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"query","name":"id","required":false},{"schema":{"type":"string","minLength":1,"maxLength":128},"in":"query","name":"shortid","required":false},{"schema":{"type":"string","minLength":1,"maxLength":120},"in":"query","name":"name","required":false}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataSchema"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/reports/import":{"post":{"operationId":"importReportArchive","summary":"Import a report archive into the workspace","tags":["Migrating"],"description":"Needs `template:write`. The archive's fonts, images and workbooks come in only when the key also has `asset:manage`, and the templates are published only with `template:publish`; otherwise they stay drafts.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"archiveBase64":{"type":"string","maxLength":28000000,"pattern":"^[A-Za-z0-9+/]*={0,2}$"},"folderPath":{"type":"string","maxLength":1000}},"required":["archiveBase64"],"additionalProperties":false,"title":"ReportArchiveBody"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"imported":{"type":"number"},"updated":{"type":"number"},"skipped":{"type":"number"},"unpublished":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"],"additionalProperties":false}}},"required":["imported","updated","skipped"],"additionalProperties":false,"title":"ReportImportResult"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/reports/import/inspect":{"post":{"operationId":"inspectReportArchive","summary":"Check what a report archive would import","tags":["Migrating"],"description":"Needs `template:read`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"archiveBase64":{"type":"string","maxLength":28000000,"pattern":"^[A-Za-z0-9+/]*={0,2}$"},"folderPath":{"type":"string","maxLength":1000}},"required":["archiveBase64"],"additionalProperties":false,"title":"ReportArchiveBody"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"format":{"type":"string","enum":["pdf","xlsx"]},"assets":{"type":"number"},"folderPath":{"type":"string"},"changes":{"type":"array","items":{"type":"string"}}},"required":["name","format","assets"],"additionalProperties":false}},"unsupported":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"recipe":{"type":"string"},"engine":{"type":"string"},"reason":{"type":"string"}},"required":["name","recipe"],"additionalProperties":false}}},"required":["items","unsupported"],"additionalProperties":false,"title":"ReportArchiveInspection"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/templates/{id}/preview":{"post":{"operationId":"previewTemplate","summary":"Download a draft as PDF, XLSX or HTML","tags":["Templates"],"description":"Needs `render:create` and `template:read`. A PDF also needs `render:read`. See [preview](/templates/overview/#preview).","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"draft":{"type":"object","properties":{"composition":{"type":"object","properties":{"root":{"anyOf":[{"$ref":"#/components/schemas/CompositionNode"},{"type":"object","properties":{"type":{"type":"string","enum":["html"]},"html":{"type":"string","minLength":1,"maxLength":2000000},"helpers":{"type":"string","maxLength":500000}},"required":["type","html"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["sheets"]},"sheets":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":31,"pattern":"^[^[\\]*?:/\\\\]+$"},"sections":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"title":{"anyOf":[{"type":"string","maxLength":200},{"type":"object","propertyNames":{"type":"string","pattern":"^(?:default|[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3})$"},"additionalProperties":{"type":"string","maxLength":200}}]},"source":{"type":"string","maxLength":200,"pattern":"^[A-Za-z_$][\\w$]*(?:\\.(?:[A-Za-z_$][\\w$]*|0|[1-9]\\d*))*$"},"columns":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"header":{"anyOf":[{"type":"string","maxLength":200},{"type":"object","propertyNames":{"type":"string","pattern":"^(?:default|[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3})$"},"additionalProperties":{"type":"string","maxLength":200}}]},"value":{"type":"string","maxLength":200,"pattern":"^[A-Za-z_$][\\w$]*(?:\\.(?:[A-Za-z_$][\\w$]*|0|[1-9]\\d*))*$"},"format":{"type":"string","enum":["text","number","decimal","date"]},"width":{"type":"number","minimum":5,"maximum":100}},"required":["header","value","format"],"additionalProperties":false}}},"required":["source","columns"],"additionalProperties":false}}},"required":["name","sections"],"additionalProperties":false}}},"required":["type","sheets"],"additionalProperties":false}]},"header":{"type":"string","maxLength":100000},"footer":{"type":"string","maxLength":100000},"components":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"additionalProperties":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"root":{"$ref":"#/components/schemas/CompositionNode"},"source":{"type":"object","properties":{"templateId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"componentId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["templateId","componentId","revision"],"additionalProperties":false}},"required":["name","root"],"additionalProperties":false}},"stylesheets":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":255}}},"required":["root"],"additionalProperties":false,"title":"DraftComposition"},"scripts":{"maxItems":10,"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},"sampleDataFile":{"type":"string","minLength":1,"maxLength":255},"workbook":{"type":"string","minLength":1,"maxLength":255},"settings":{"type":"object","properties":{"pageSize":{"type":"object","properties":{"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["widthMm","heightMm"],"additionalProperties":false},"orientation":{"default":"portrait","type":"string","enum":["portrait","landscape"]},"margins":{"type":"object","properties":{"topMm":{"type":"number","minimum":0,"maximum":500},"rightMm":{"type":"number","minimum":0,"maximum":500},"bottomMm":{"type":"number","minimum":0,"maximum":500},"leftMm":{"type":"number","minimum":0,"maximum":500}},"required":["topMm","rightMm","bottomMm","leftMm"],"additionalProperties":false},"locale":{"default":"en-US","type":"string","minLength":2,"maxLength":64},"pageRanges":{"type":"string","maxLength":200},"metadata":{"type":"object","properties":{"title":{"type":"string","maxLength":500},"author":{"type":"string","maxLength":200},"subject":{"type":"string","maxLength":1000},"creator":{"type":"string","maxLength":200},"producer":{"type":"string","maxLength":200},"language":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","pattern":"^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3}$"}]},"keywords":{"maxItems":32,"type":"array","items":{"type":"string","maxLength":100}},"xmp":{"maxItems":4,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"prefix":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"namespace":{"type":"string","minLength":1,"maxLength":500,"pattern":"^[a-z][\\w+.-]*:\\S+$"},"properties":{"minItems":1,"maxItems":32,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"value":{"type":"string","maxLength":1000},"description":{"type":"string","minLength":1,"maxLength":1000}},"required":["name","value","description"],"additionalProperties":false}}},"required":["name","prefix","namespace","properties"],"additionalProperties":false,"title":"XmpSchema"}}},"additionalProperties":false,"title":"PdfMetadata"},"encryption":{"type":"object","properties":{"openPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"ownerPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"permissions":{"type":"object","properties":{"printing":{"type":"string","enum":["none","lowResolution","highResolution"]},"modifying":{"type":"boolean"},"copying":{"type":"boolean"},"annotating":{"type":"boolean"},"fillingForms":{"type":"boolean"},"contentAccessibility":{"type":"boolean"},"documentAssembly":{"type":"boolean"}},"additionalProperties":false,"title":"PdfPermissions"}},"additionalProperties":false,"title":"PdfEncryption"},"signature":{"type":"object","properties":{"certificate":{"type":"string","maxLength":120},"reason":{"type":"string","maxLength":200},"location":{"type":"string","maxLength":200},"contactInfo":{"type":"string","maxLength":200},"field":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"maximum":100000},"xMm":{"type":"number","minimum":0,"maximum":2000},"yMm":{"type":"number","minimum":0,"maximum":2000},"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["xMm","yMm","widthMm","heightMm"],"additionalProperties":false,"title":"PdfSignatureField"}},"required":["certificate"],"additionalProperties":false,"title":"PdfSignature"},"operations":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["append","prepend","merge"]},"template":{"type":"string","minLength":1,"maxLength":120},"pdf":{"type":"string","minLength":1,"maxLength":255},"mergeWholeDocument":{"type":"boolean"},"mergeToFront":{"type":"boolean"},"renderForEveryPage":{"type":"boolean"}},"required":["type"],"additionalProperties":false,"title":"PdfOperation"}},"pdfa":{"type":"string","enum":["4","2b","2u","2a","3b","3u","3a","4f"],"title":"PdfaLevel"},"pdfua":{"type":"string","enum":["1","2"],"title":"PdfuaPart"},"opaqueFills":{"type":"boolean"},"preferCssPageSize":{"type":"boolean"}},"required":["pageSize","margins"],"additionalProperties":false,"title":"TemplateSettings"},"contentFields":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_]{0,63}$","title":"ContentFieldKey"},"label":{"type":"string","minLength":1,"maxLength":120},"type":{"type":"string","enum":["text","richText","image","colour","toggle","choice","number","date"]},"group":{"type":"string","minLength":1,"maxLength":80},"help":{"type":"string","maxLength":500},"multiline":{"type":"boolean"},"maxLength":{"type":"integer","minimum":1,"maximum":65536},"options":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}}},"required":["key","label","type"],"additionalProperties":false,"title":"ContentField"},"title":"ContentFields"},"contentValues":{"type":"object","propertyNames":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_]{0,63}$","title":"ContentFieldKey"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":65536},{"type":"number"},{"type":"boolean"}],"title":"ContentValue"},"title":"ContentValues"}},"required":["composition","settings"],"additionalProperties":false,"title":"TemplateDraftContent"},"data":{"$ref":"#/components/schemas/JsonValue"},"locale":{"type":"string","minLength":2,"maxLength":64},"format":{"type":"string","enum":["pdf","xlsx","html"]},"pdf":{"type":"object","properties":{"pageSize":{"anyOf":[{"type":"string","enum":["A3","A4","A5","Letter","Legal"]},{"type":"object","properties":{"widthMm":{"type":"number","minimum":0.1,"maximum":2000},"heightMm":{"type":"number","minimum":0.1,"maximum":2000}},"required":["widthMm","heightMm"],"additionalProperties":false}]},"orientation":{"type":"string","enum":["portrait","landscape"]},"margins":{"type":"object","properties":{"topMm":{"type":"number","minimum":0,"maximum":500},"rightMm":{"type":"number","minimum":0,"maximum":500},"bottomMm":{"type":"number","minimum":0,"maximum":500},"leftMm":{"type":"number","minimum":0,"maximum":500}},"additionalProperties":false},"pageRanges":{"type":"string","maxLength":200},"metadata":{"type":"object","properties":{"title":{"type":"string","maxLength":500},"author":{"type":"string","maxLength":200},"subject":{"type":"string","maxLength":1000},"creator":{"type":"string","maxLength":200},"producer":{"type":"string","maxLength":200},"language":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","pattern":"^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3}$"}]},"keywords":{"maxItems":32,"type":"array","items":{"type":"string","maxLength":100}},"xmp":{"maxItems":4,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"prefix":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"namespace":{"type":"string","minLength":1,"maxLength":500,"pattern":"^[a-z][\\w+.-]*:\\S+$"},"properties":{"minItems":1,"maxItems":32,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"value":{"type":"string","maxLength":1000},"description":{"type":"string","minLength":1,"maxLength":1000}},"required":["name","value","description"],"additionalProperties":false}}},"required":["name","prefix","namespace","properties"],"additionalProperties":false,"title":"XmpSchema"}}},"additionalProperties":false,"title":"PdfMetadata"},"pdfa":{"type":"string","enum":["4","2b","2u","2a","3b","3u","3a","4f"],"title":"PdfaLevel"},"pdfua":{"type":"string","enum":["1","2"],"title":"PdfuaPart"},"opaqueFills":{"type":"boolean"},"preferCssPageSize":{"type":"boolean"},"attachments":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[^/\\\\\\p{Cc}]+$"},"mimeType":{"type":"string","maxLength":127,"pattern":"^[\\w.+-]+\\/[\\w.+-]+$"},"description":{"type":"string","minLength":1,"maxLength":1000},"relationship":{"type":"string","enum":["source","data","alternative","supplement","unspecified"]},"content":{"type":"string"},"contentBase64":{"type":"string","pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"}},"required":["name"],"additionalProperties":false,"title":"PdfAttachment"}},"encryption":{"type":"object","properties":{"openPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"ownerPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"permissions":{"type":"object","properties":{"printing":{"type":"string","enum":["none","lowResolution","highResolution"]},"modifying":{"type":"boolean"},"copying":{"type":"boolean"},"annotating":{"type":"boolean"},"fillingForms":{"type":"boolean"},"contentAccessibility":{"type":"boolean"},"documentAssembly":{"type":"boolean"}},"additionalProperties":false,"title":"PdfPermissions"}},"additionalProperties":false,"title":"PdfEncryption"},"signature":{"type":"object","properties":{"certificate":{"type":"string","maxLength":120},"reason":{"type":"string","maxLength":200},"location":{"type":"string","maxLength":200},"contactInfo":{"type":"string","maxLength":200},"field":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"maximum":100000},"xMm":{"type":"number","minimum":0,"maximum":2000},"yMm":{"type":"number","minimum":0,"maximum":2000},"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["xMm","yMm","widthMm","heightMm"],"additionalProperties":false,"title":"PdfSignatureField"}},"additionalProperties":false,"title":"PdfSignatureOverride"},"operations":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["append","prepend","merge"]},"template":{"type":"string","minLength":1,"maxLength":120},"pdf":{"type":"string","minLength":1,"maxLength":255},"mergeWholeDocument":{"type":"boolean"},"mergeToFront":{"type":"boolean"},"renderForEveryPage":{"type":"boolean"}},"required":["type"],"additionalProperties":false,"title":"PdfOperation"}},"watermark":{"type":"object","properties":{"text":{"type":"string","maxLength":200,"pattern":"^(?=.*\\S)[^\\p{Cc}]+$","description":"The text, such as `DRAFT` or `CONFIDENTIAL`. One line."},"opacity":{"type":"number","minimum":0,"maximum":1,"description":"From 0 (invisible) to 1 (solid). Default 0.3."},"rotation":{"type":"number","minimum":-360,"maximum":360,"description":"Angle in degrees, counter-clockwise; 0 is horizontal. Default: along the page's diagonal from the bottom left."},"fontSize":{"type":"number","exclusiveMinimum":0,"maximum":500,"description":"Size in points. Default: the text spans 60% of the page along its angle, at most 144 pt."},"color":{"type":"string","pattern":"^#(?:[0-9a-f]{3}|[0-9a-f]{6})$","description":"Hex colour such as `#c00000`. Default `#808080` (gray)."}},"required":["text"],"additionalProperties":false,"title":"PdfWatermark"}},"additionalProperties":false,"title":"ReportPdfOptions"},"checkConformance":{"type":"boolean"}},"additionalProperties":false,"title":"PreviewTemplateBody"}}}},"parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK"}}}},"/v1/instance":{"get":{"operationId":"getInstanceStatus","summary":"Get the installation's setup state","tags":["Status"],"description":"Includes the license when self-hosted, and the enabled sign-in methods.","security":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"deploymentMode":{"type":"string","enum":["saas","self-hosted"]},"setupRequired":{"type":"boolean"},"signInMethods":{"type":"object","properties":{"emailCode":{"type":"boolean"},"password":{"type":"boolean"},"microsoft":{"type":"boolean"},"turnstileSiteKey":{"description":"Cloudflare Turnstile's site key, when sign-in code requests need its check.","type":"string"}},"required":["emailCode","password","microsoft"],"additionalProperties":false,"title":"SignInMethods"},"userWorkspaces":{"type":"boolean"},"templateConversions":{"type":"boolean"},"license":{"type":"object","properties":{"state":{"type":"string","enum":["missing","pending","trial","active","grace","expired","invalid"]},"expiresAt":{"type":"string"},"renewBy":{"type":"string"}},"required":["state"],"additionalProperties":false,"title":"LicenseStatus"}},"required":["deploymentMode","setupRequired","signInMethods","userWorkspaces","templateConversions"],"additionalProperties":false,"title":"InstanceStatus"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/renders/string":{"post":{"operationId":"renderString","summary":"Fill placeholders in a string","tags":["Renders"],"description":"Returns text or HTML in the response. Needs `render:create`. See [email and SMS text](/guides/string-rendering/).","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"template":{"type":"string","maxLength":1000000},"data":{"$ref":"#/components/schemas/JsonValue"},"format":{"default":"text","type":"string","enum":["text","html"]},"engine":{"default":"placeholders","type":"string","enum":["placeholders","handlebars"]},"helpers":{"type":"string","maxLength":500000}},"required":["template","data"],"additionalProperties":false,"title":"RenderStringBody"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"content":{"type":"string"},"format":{"type":"string","enum":["text","html"]}},"required":["content","format"],"additionalProperties":false,"title":"StringRenderResult"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/renders/batch":{"post":{"operationId":"createRenderBatch","summary":"Create a batch of up to 100 renders","tags":["Renders"],"description":"The renders are admitted together. Needs `render:create`. Items that render a draft also need `template:read`. See [batches](/guides/batch-rendering/).","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"minItems":1,"maxItems":100,"type":"array","items":{"anyOf":[{"type":"object","properties":{"document":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["html"]},"html":{"type":"string","minLength":1,"maxLength":5000000},"css":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","maxLength":1000000}},"assetIds":{"default":[],"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"}}},"required":["kind","html"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","enum":["node"]},"node":{"$ref":"#/components/schemas/DocumentNode"},"css":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","maxLength":1000000}},"assetIds":{"default":[],"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"}}},"required":["kind","node"],"additionalProperties":false}],"title":"RenderDocument"},"settings":{"type":"object","properties":{"pageSize":{"type":"object","properties":{"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["widthMm","heightMm"],"additionalProperties":false},"orientation":{"default":"portrait","type":"string","enum":["portrait","landscape"]},"margins":{"type":"object","properties":{"topMm":{"type":"number","minimum":0,"maximum":500},"rightMm":{"type":"number","minimum":0,"maximum":500},"bottomMm":{"type":"number","minimum":0,"maximum":500},"leftMm":{"type":"number","minimum":0,"maximum":500}},"required":["topMm","rightMm","bottomMm","leftMm"],"additionalProperties":false},"locale":{"default":"en-US","type":"string","minLength":2,"maxLength":64},"pageRanges":{"type":"string","maxLength":200},"metadata":{"type":"object","properties":{"title":{"type":"string","maxLength":500},"author":{"type":"string","maxLength":200},"subject":{"type":"string","maxLength":1000},"creator":{"type":"string","maxLength":200},"producer":{"type":"string","maxLength":200},"language":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","pattern":"^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3}$"}]},"keywords":{"maxItems":32,"type":"array","items":{"type":"string","maxLength":100}},"xmp":{"maxItems":4,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"prefix":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"namespace":{"type":"string","minLength":1,"maxLength":500,"pattern":"^[a-z][\\w+.-]*:\\S+$"},"properties":{"minItems":1,"maxItems":32,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"value":{"type":"string","maxLength":1000},"description":{"type":"string","minLength":1,"maxLength":1000}},"required":["name","value","description"],"additionalProperties":false}}},"required":["name","prefix","namespace","properties"],"additionalProperties":false,"title":"XmpSchema"}}},"additionalProperties":false,"title":"PdfMetadata"},"encryption":{"type":"object","properties":{"openPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"ownerPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"permissions":{"type":"object","properties":{"printing":{"type":"string","enum":["none","lowResolution","highResolution"]},"modifying":{"type":"boolean"},"copying":{"type":"boolean"},"annotating":{"type":"boolean"},"fillingForms":{"type":"boolean"},"contentAccessibility":{"type":"boolean"},"documentAssembly":{"type":"boolean"}},"additionalProperties":false,"title":"PdfPermissions"}},"additionalProperties":false,"title":"PdfEncryption"},"signature":{"type":"object","properties":{"certificate":{"type":"string","maxLength":120},"reason":{"type":"string","maxLength":200},"location":{"type":"string","maxLength":200},"contactInfo":{"type":"string","maxLength":200},"field":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"maximum":100000},"xMm":{"type":"number","minimum":0,"maximum":2000},"yMm":{"type":"number","minimum":0,"maximum":2000},"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["xMm","yMm","widthMm","heightMm"],"additionalProperties":false,"title":"PdfSignatureField"}},"required":["certificate"],"additionalProperties":false,"title":"PdfSignature"},"operations":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["append","prepend","merge"]},"template":{"type":"string","minLength":1,"maxLength":120},"pdf":{"type":"string","minLength":1,"maxLength":255},"mergeWholeDocument":{"type":"boolean"},"mergeToFront":{"type":"boolean"},"renderForEveryPage":{"type":"boolean"}},"required":["type"],"additionalProperties":false,"title":"PdfOperation"}},"pdfa":{"type":"string","enum":["4","2b","2u","2a","3b","3u","3a","4f"],"title":"PdfaLevel"},"pdfua":{"type":"string","enum":["1","2"],"title":"PdfuaPart"},"opaqueFills":{"type":"boolean"},"preferCssPageSize":{"type":"boolean"}},"required":["pageSize","margins"],"additionalProperties":false,"title":"TemplateSettings"},"metadata":{"type":"object","properties":{"title":{"type":"string","maxLength":500},"author":{"type":"string","maxLength":200},"subject":{"type":"string","maxLength":1000},"creator":{"type":"string","maxLength":200},"producer":{"type":"string","maxLength":200},"language":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","pattern":"^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3}$"}]},"keywords":{"maxItems":32,"type":"array","items":{"type":"string","maxLength":100}},"xmp":{"maxItems":4,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"prefix":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"namespace":{"type":"string","minLength":1,"maxLength":500,"pattern":"^[a-z][\\w+.-]*:\\S+$"},"properties":{"minItems":1,"maxItems":32,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"value":{"type":"string","maxLength":1000},"description":{"type":"string","minLength":1,"maxLength":1000}},"required":["name","value","description"],"additionalProperties":false}}},"required":["name","prefix","namespace","properties"],"additionalProperties":false,"title":"XmpSchema"}}},"additionalProperties":false,"title":"PdfMetadata"},"attachments":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[^/\\\\\\p{Cc}]+$"},"mimeType":{"type":"string","maxLength":127,"pattern":"^[\\w.+-]+\\/[\\w.+-]+$"},"description":{"type":"string","minLength":1,"maxLength":1000},"relationship":{"type":"string","enum":["source","data","alternative","supplement","unspecified"]},"content":{"type":"string"},"contentBase64":{"type":"string","pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"}},"required":["name"],"additionalProperties":false,"title":"PdfAttachment"}},"encryption":{"type":"object","properties":{"openPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"ownerPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"permissions":{"type":"object","properties":{"printing":{"type":"string","enum":["none","lowResolution","highResolution"]},"modifying":{"type":"boolean"},"copying":{"type":"boolean"},"annotating":{"type":"boolean"},"fillingForms":{"type":"boolean"},"contentAccessibility":{"type":"boolean"},"documentAssembly":{"type":"boolean"}},"additionalProperties":false,"title":"PdfPermissions"}},"additionalProperties":false,"title":"PdfEncryption"},"signature":{"type":"object","properties":{"certificate":{"type":"string","maxLength":120},"reason":{"type":"string","maxLength":200},"location":{"type":"string","maxLength":200},"contactInfo":{"type":"string","maxLength":200},"field":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"maximum":100000},"xMm":{"type":"number","minimum":0,"maximum":2000},"yMm":{"type":"number","minimum":0,"maximum":2000},"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["xMm","yMm","widthMm","heightMm"],"additionalProperties":false,"title":"PdfSignatureField"}},"additionalProperties":false,"title":"PdfSignatureOverride"},"watermark":{"type":"object","properties":{"text":{"type":"string","maxLength":200,"pattern":"^(?=.*\\S)[^\\p{Cc}]+$","description":"The text, such as `DRAFT` or `CONFIDENTIAL`. One line."},"opacity":{"type":"number","minimum":0,"maximum":1,"description":"From 0 (invisible) to 1 (solid). Default 0.3."},"rotation":{"type":"number","minimum":-360,"maximum":360,"description":"Angle in degrees, counter-clockwise; 0 is horizontal. Default: along the page's diagonal from the bottom left."},"fontSize":{"type":"number","exclusiveMinimum":0,"maximum":500,"description":"Size in points. Default: the text spans 60% of the page along its angle, at most 144 pt."},"color":{"type":"string","pattern":"^#(?:[0-9a-f]{3}|[0-9a-f]{6})$","description":"Hex colour such as `#c00000`. Default `#808080` (gray)."}},"required":["text"],"additionalProperties":false,"title":"PdfWatermark"},"format":{"type":"string","enum":["pdf","png","jpeg","webp"],"description":"`pdf` (the default), or `png`, `jpeg` or `webp` for one page of the PDF drawn as an image. See [images](/guides/rendering/#render-an-image)."},"image":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"maximum":200,"description":"The page to draw, from 1. Default 1."},"width":{"type":"integer","minimum":16,"maximum":4096,"description":"The image's width in pixels; the height follows the page's shape. Default: the page's width in CSS pixels, so a page of 1200 × 630 px gives a 1200 × 630 image."},"quality":{"type":"integer","minimum":1,"maximum":100,"description":"JPEG quality from 1 to 100. Default 90. JPEG only."}},"additionalProperties":false,"title":"ImageOptions"},"destination":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120,"description":"A storage destination's name."},"path":{"type":"string","minLength":1,"maxLength":512,"description":"The object's key after the destination's prefix; `{renderId}` is replaced with the render's ID. Defaults to `{renderId}.pdf`, or the image's extension, such as `.png`. An object already at the key is replaced."},"keepCopy":{"type":"boolean","description":"`false` keeps no copy: the render then has no `downloadUrl`, and its batch cannot be merged. Defaults to `true`."}},"required":["name"],"additionalProperties":false,"title":"RenderDestination"},"test":{"type":"boolean","description":"Render a free test document with a diagonal \"TEST\" watermark on every page. Test renders do not count against the workspace's render allowances; they have their own of 10 outstanding and 10 per minute, or the workspace's own if lower. See [test renders](/guides/rendering/#test-renders)."}},"required":["document","settings"],"additionalProperties":false},{"type":"object","properties":{"preview":{"type":"object","properties":{"composition":{"type":"object","properties":{"root":{"anyOf":[{"$ref":"#/components/schemas/CompositionNode"},{"type":"object","properties":{"type":{"type":"string","enum":["html"]},"html":{"type":"string","minLength":1,"maxLength":2000000},"helpers":{"type":"string","maxLength":500000}},"required":["type","html"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["sheets"]},"sheets":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":31,"pattern":"^[^[\\]*?:/\\\\]+$"},"sections":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"title":{"anyOf":[{"type":"string","maxLength":200},{"type":"object","propertyNames":{"type":"string","pattern":"^(?:default|[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3})$"},"additionalProperties":{"type":"string","maxLength":200}}]},"source":{"type":"string","maxLength":200,"pattern":"^[A-Za-z_$][\\w$]*(?:\\.(?:[A-Za-z_$][\\w$]*|0|[1-9]\\d*))*$"},"columns":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"header":{"anyOf":[{"type":"string","maxLength":200},{"type":"object","propertyNames":{"type":"string","pattern":"^(?:default|[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3})$"},"additionalProperties":{"type":"string","maxLength":200}}]},"value":{"type":"string","maxLength":200,"pattern":"^[A-Za-z_$][\\w$]*(?:\\.(?:[A-Za-z_$][\\w$]*|0|[1-9]\\d*))*$"},"format":{"type":"string","enum":["text","number","decimal","date"]},"width":{"type":"number","minimum":5,"maximum":100}},"required":["header","value","format"],"additionalProperties":false}}},"required":["source","columns"],"additionalProperties":false}}},"required":["name","sections"],"additionalProperties":false}}},"required":["type","sheets"],"additionalProperties":false}]},"header":{"type":"string","maxLength":100000},"footer":{"type":"string","maxLength":100000},"components":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"additionalProperties":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"root":{"$ref":"#/components/schemas/CompositionNode"},"source":{"type":"object","properties":{"templateId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"componentId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["templateId","componentId","revision"],"additionalProperties":false}},"required":["name","root"],"additionalProperties":false}},"stylesheets":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":255}}},"required":["root"],"additionalProperties":false,"title":"DraftComposition"},"scripts":{"maxItems":10,"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},"sampleDataFile":{"type":"string","minLength":1,"maxLength":255},"workbook":{"type":"string","minLength":1,"maxLength":255},"settings":{"type":"object","properties":{"pageSize":{"type":"object","properties":{"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["widthMm","heightMm"],"additionalProperties":false},"orientation":{"default":"portrait","type":"string","enum":["portrait","landscape"]},"margins":{"type":"object","properties":{"topMm":{"type":"number","minimum":0,"maximum":500},"rightMm":{"type":"number","minimum":0,"maximum":500},"bottomMm":{"type":"number","minimum":0,"maximum":500},"leftMm":{"type":"number","minimum":0,"maximum":500}},"required":["topMm","rightMm","bottomMm","leftMm"],"additionalProperties":false},"locale":{"default":"en-US","type":"string","minLength":2,"maxLength":64},"pageRanges":{"type":"string","maxLength":200},"metadata":{"type":"object","properties":{"title":{"type":"string","maxLength":500},"author":{"type":"string","maxLength":200},"subject":{"type":"string","maxLength":1000},"creator":{"type":"string","maxLength":200},"producer":{"type":"string","maxLength":200},"language":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","pattern":"^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3}$"}]},"keywords":{"maxItems":32,"type":"array","items":{"type":"string","maxLength":100}},"xmp":{"maxItems":4,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"prefix":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"namespace":{"type":"string","minLength":1,"maxLength":500,"pattern":"^[a-z][\\w+.-]*:\\S+$"},"properties":{"minItems":1,"maxItems":32,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"value":{"type":"string","maxLength":1000},"description":{"type":"string","minLength":1,"maxLength":1000}},"required":["name","value","description"],"additionalProperties":false}}},"required":["name","prefix","namespace","properties"],"additionalProperties":false,"title":"XmpSchema"}}},"additionalProperties":false,"title":"PdfMetadata"},"encryption":{"type":"object","properties":{"openPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"ownerPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"permissions":{"type":"object","properties":{"printing":{"type":"string","enum":["none","lowResolution","highResolution"]},"modifying":{"type":"boolean"},"copying":{"type":"boolean"},"annotating":{"type":"boolean"},"fillingForms":{"type":"boolean"},"contentAccessibility":{"type":"boolean"},"documentAssembly":{"type":"boolean"}},"additionalProperties":false,"title":"PdfPermissions"}},"additionalProperties":false,"title":"PdfEncryption"},"signature":{"type":"object","properties":{"certificate":{"type":"string","maxLength":120},"reason":{"type":"string","maxLength":200},"location":{"type":"string","maxLength":200},"contactInfo":{"type":"string","maxLength":200},"field":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"maximum":100000},"xMm":{"type":"number","minimum":0,"maximum":2000},"yMm":{"type":"number","minimum":0,"maximum":2000},"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["xMm","yMm","widthMm","heightMm"],"additionalProperties":false,"title":"PdfSignatureField"}},"required":["certificate"],"additionalProperties":false,"title":"PdfSignature"},"operations":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["append","prepend","merge"]},"template":{"type":"string","minLength":1,"maxLength":120},"pdf":{"type":"string","minLength":1,"maxLength":255},"mergeWholeDocument":{"type":"boolean"},"mergeToFront":{"type":"boolean"},"renderForEveryPage":{"type":"boolean"}},"required":["type"],"additionalProperties":false,"title":"PdfOperation"}},"pdfa":{"type":"string","enum":["4","2b","2u","2a","3b","3u","3a","4f"],"title":"PdfaLevel"},"pdfua":{"type":"string","enum":["1","2"],"title":"PdfuaPart"},"opaqueFills":{"type":"boolean"},"preferCssPageSize":{"type":"boolean"}},"required":["pageSize","margins"],"additionalProperties":false,"title":"TemplateSettings"},"contentFields":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_]{0,63}$","title":"ContentFieldKey"},"label":{"type":"string","minLength":1,"maxLength":120},"type":{"type":"string","enum":["text","richText","image","colour","toggle","choice","number","date"]},"group":{"type":"string","minLength":1,"maxLength":80},"help":{"type":"string","maxLength":500},"multiline":{"type":"boolean"},"maxLength":{"type":"integer","minimum":1,"maximum":65536},"options":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}}},"required":["key","label","type"],"additionalProperties":false,"title":"ContentField"},"title":"ContentFields"},"contentValues":{"type":"object","propertyNames":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_]{0,63}$","title":"ContentFieldKey"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":65536},{"type":"number"},{"type":"boolean"}],"title":"ContentValue"},"title":"ContentValues"}},"required":["composition","settings"],"additionalProperties":false,"title":"TemplateDraftContent"},"templateId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"data":{"$ref":"#/components/schemas/JsonValue"},"metadata":{"type":"object","properties":{"title":{"type":"string","maxLength":500},"author":{"type":"string","maxLength":200},"subject":{"type":"string","maxLength":1000},"creator":{"type":"string","maxLength":200},"producer":{"type":"string","maxLength":200},"language":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","pattern":"^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3}$"}]},"keywords":{"maxItems":32,"type":"array","items":{"type":"string","maxLength":100}},"xmp":{"maxItems":4,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"prefix":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"namespace":{"type":"string","minLength":1,"maxLength":500,"pattern":"^[a-z][\\w+.-]*:\\S+$"},"properties":{"minItems":1,"maxItems":32,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"value":{"type":"string","maxLength":1000},"description":{"type":"string","minLength":1,"maxLength":1000}},"required":["name","value","description"],"additionalProperties":false}}},"required":["name","prefix","namespace","properties"],"additionalProperties":false,"title":"XmpSchema"}}},"additionalProperties":false,"title":"PdfMetadata"},"attachments":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[^/\\\\\\p{Cc}]+$"},"mimeType":{"type":"string","maxLength":127,"pattern":"^[\\w.+-]+\\/[\\w.+-]+$"},"description":{"type":"string","minLength":1,"maxLength":1000},"relationship":{"type":"string","enum":["source","data","alternative","supplement","unspecified"]},"content":{"type":"string"},"contentBase64":{"type":"string","pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"}},"required":["name"],"additionalProperties":false,"title":"PdfAttachment"}},"encryption":{"type":"object","properties":{"openPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"ownerPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"permissions":{"type":"object","properties":{"printing":{"type":"string","enum":["none","lowResolution","highResolution"]},"modifying":{"type":"boolean"},"copying":{"type":"boolean"},"annotating":{"type":"boolean"},"fillingForms":{"type":"boolean"},"contentAccessibility":{"type":"boolean"},"documentAssembly":{"type":"boolean"}},"additionalProperties":false,"title":"PdfPermissions"}},"additionalProperties":false,"title":"PdfEncryption"},"signature":{"type":"object","properties":{"certificate":{"type":"string","maxLength":120},"reason":{"type":"string","maxLength":200},"location":{"type":"string","maxLength":200},"contactInfo":{"type":"string","maxLength":200},"field":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"maximum":100000},"xMm":{"type":"number","minimum":0,"maximum":2000},"yMm":{"type":"number","minimum":0,"maximum":2000},"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["xMm","yMm","widthMm","heightMm"],"additionalProperties":false,"title":"PdfSignatureField"}},"additionalProperties":false,"title":"PdfSignatureOverride"},"checkConformance":{"type":"boolean"},"watermark":{"type":"object","properties":{"text":{"type":"string","maxLength":200,"pattern":"^(?=.*\\S)[^\\p{Cc}]+$","description":"The text, such as `DRAFT` or `CONFIDENTIAL`. One line."},"opacity":{"type":"number","minimum":0,"maximum":1,"description":"From 0 (invisible) to 1 (solid). Default 0.3."},"rotation":{"type":"number","minimum":-360,"maximum":360,"description":"Angle in degrees, counter-clockwise; 0 is horizontal. Default: along the page's diagonal from the bottom left."},"fontSize":{"type":"number","exclusiveMinimum":0,"maximum":500,"description":"Size in points. Default: the text spans 60% of the page along its angle, at most 144 pt."},"color":{"type":"string","pattern":"^#(?:[0-9a-f]{3}|[0-9a-f]{6})$","description":"Hex colour such as `#c00000`. Default `#808080` (gray)."}},"required":["text"],"additionalProperties":false,"title":"PdfWatermark"},"format":{"type":"string","enum":["pdf","png","jpeg","webp"],"description":"`pdf` (the default), or `png`, `jpeg` or `webp` for one page of the PDF drawn as an image. See [images](/guides/rendering/#render-an-image)."},"image":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"maximum":200,"description":"The page to draw, from 1. Default 1."},"width":{"type":"integer","minimum":16,"maximum":4096,"description":"The image's width in pixels; the height follows the page's shape. Default: the page's width in CSS pixels, so a page of 1200 × 630 px gives a 1200 × 630 image."},"quality":{"type":"integer","minimum":1,"maximum":100,"description":"JPEG quality from 1 to 100. Default 90. JPEG only."}},"additionalProperties":false,"title":"ImageOptions"},"test":{"type":"boolean","description":"Render a free test document with a diagonal \"TEST\" watermark on every page. Test renders do not count against the workspace's render allowances; they have their own of 10 outstanding and 10 per minute, or the workspace's own if lower. See [test renders](/guides/rendering/#test-renders)."}},"required":["preview"],"additionalProperties":false},{"type":"object","properties":{"templateVersionId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"data":{"$ref":"#/components/schemas/JsonValue"},"locale":{"type":"string","maxLength":64,"pattern":"^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3}$","description":"Picks the template's translations, such as `de-DE`. Omitted, the template's own language is used."},"metadata":{"type":"object","properties":{"title":{"type":"string","maxLength":500},"author":{"type":"string","maxLength":200},"subject":{"type":"string","maxLength":1000},"creator":{"type":"string","maxLength":200},"producer":{"type":"string","maxLength":200},"language":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","pattern":"^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3}$"}]},"keywords":{"maxItems":32,"type":"array","items":{"type":"string","maxLength":100}},"xmp":{"maxItems":4,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"prefix":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"namespace":{"type":"string","minLength":1,"maxLength":500,"pattern":"^[a-z][\\w+.-]*:\\S+$"},"properties":{"minItems":1,"maxItems":32,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"value":{"type":"string","maxLength":1000},"description":{"type":"string","minLength":1,"maxLength":1000}},"required":["name","value","description"],"additionalProperties":false}}},"required":["name","prefix","namespace","properties"],"additionalProperties":false,"title":"XmpSchema"}}},"additionalProperties":false,"title":"PdfMetadata"},"attachments":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[^/\\\\\\p{Cc}]+$"},"mimeType":{"type":"string","maxLength":127,"pattern":"^[\\w.+-]+\\/[\\w.+-]+$"},"description":{"type":"string","minLength":1,"maxLength":1000},"relationship":{"type":"string","enum":["source","data","alternative","supplement","unspecified"]},"content":{"type":"string"},"contentBase64":{"type":"string","pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"}},"required":["name"],"additionalProperties":false,"title":"PdfAttachment"}},"encryption":{"type":"object","properties":{"openPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"ownerPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"permissions":{"type":"object","properties":{"printing":{"type":"string","enum":["none","lowResolution","highResolution"]},"modifying":{"type":"boolean"},"copying":{"type":"boolean"},"annotating":{"type":"boolean"},"fillingForms":{"type":"boolean"},"contentAccessibility":{"type":"boolean"},"documentAssembly":{"type":"boolean"}},"additionalProperties":false,"title":"PdfPermissions"}},"additionalProperties":false,"title":"PdfEncryption"},"signature":{"type":"object","properties":{"certificate":{"type":"string","maxLength":120},"reason":{"type":"string","maxLength":200},"location":{"type":"string","maxLength":200},"contactInfo":{"type":"string","maxLength":200},"field":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"maximum":100000},"xMm":{"type":"number","minimum":0,"maximum":2000},"yMm":{"type":"number","minimum":0,"maximum":2000},"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["xMm","yMm","widthMm","heightMm"],"additionalProperties":false,"title":"PdfSignatureField"}},"additionalProperties":false,"title":"PdfSignatureOverride"},"watermark":{"type":"object","properties":{"text":{"type":"string","maxLength":200,"pattern":"^(?=.*\\S)[^\\p{Cc}]+$","description":"The text, such as `DRAFT` or `CONFIDENTIAL`. One line."},"opacity":{"type":"number","minimum":0,"maximum":1,"description":"From 0 (invisible) to 1 (solid). Default 0.3."},"rotation":{"type":"number","minimum":-360,"maximum":360,"description":"Angle in degrees, counter-clockwise; 0 is horizontal. Default: along the page's diagonal from the bottom left."},"fontSize":{"type":"number","exclusiveMinimum":0,"maximum":500,"description":"Size in points. Default: the text spans 60% of the page along its angle, at most 144 pt."},"color":{"type":"string","pattern":"^#(?:[0-9a-f]{3}|[0-9a-f]{6})$","description":"Hex colour such as `#c00000`. Default `#808080` (gray)."}},"required":["text"],"additionalProperties":false,"title":"PdfWatermark"},"format":{"type":"string","enum":["pdf","png","jpeg","webp"],"description":"`pdf` (the default), or `png`, `jpeg` or `webp` for one page of the PDF drawn as an image. See [images](/guides/rendering/#render-an-image)."},"image":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"maximum":200,"description":"The page to draw, from 1. Default 1."},"width":{"type":"integer","minimum":16,"maximum":4096,"description":"The image's width in pixels; the height follows the page's shape. Default: the page's width in CSS pixels, so a page of 1200 × 630 px gives a 1200 × 630 image."},"quality":{"type":"integer","minimum":1,"maximum":100,"description":"JPEG quality from 1 to 100. Default 90. JPEG only."}},"additionalProperties":false,"title":"ImageOptions"},"destination":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120,"description":"A storage destination's name."},"path":{"type":"string","minLength":1,"maxLength":512,"description":"The object's key after the destination's prefix; `{renderId}` is replaced with the render's ID. Defaults to `{renderId}.pdf`, or the image's extension, such as `.png`. An object already at the key is replaced."},"keepCopy":{"type":"boolean","description":"`false` keeps no copy: the render then has no `downloadUrl`, and its batch cannot be merged. Defaults to `true`."}},"required":["name"],"additionalProperties":false,"title":"RenderDestination"},"test":{"type":"boolean","description":"Render a free test document with a diagonal \"TEST\" watermark on every page. Test renders do not count against the workspace's render allowances; they have their own of 10 outstanding and 10 per minute, or the workspace's own if lower. See [test renders](/guides/rendering/#test-renders)."}},"required":["templateVersionId","data"],"additionalProperties":false}],"title":"RenderBatchItem"}}},"required":["items"],"additionalProperties":false,"title":"CreateRenderBatchBody"}}}},"parameters":[{"schema":{"type":"string","minLength":1,"maxLength":255},"in":"header","name":"idempotency-key","required":false,"description":"Repeating a request with the same key returns the first result instead of rendering twice. See [idempotency keys](/guides/rendering/#idempotency-keys)."}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"counts":{"type":"object","properties":{"queued":{"type":"integer","minimum":0,"maximum":9007199254740991},"processing":{"type":"integer","minimum":0,"maximum":9007199254740991},"succeeded":{"type":"integer","minimum":0,"maximum":9007199254740991},"failed":{"type":"integer","minimum":0,"maximum":9007199254740991},"cancelled":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["queued","processing","succeeded","failed","cancelled"],"additionalProperties":false},"items":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer","minimum":0,"maximum":9007199254740991},"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"state":{"type":"string","enum":["queued","processing","succeeded","failed","cancelled"]},"templateVersionId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"test":{"type":"boolean","description":"Whether this is a free test render, whose PDF or image carries a diagonal \"TEST\" watermark. See [test renders](/guides/rendering/#test-renders)."},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["index","id","state","test","createdAt","updatedAt"],"additionalProperties":false}}},"required":["id","createdAt","total","counts","items"],"additionalProperties":false,"title":"RenderBatch"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/renders/batch/{id}":{"get":{"operationId":"getRenderBatch","summary":"Get a batch","tags":["Renders"],"description":"The batch's counts and the state of each item. Needs `render:read`.","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"total":{"type":"integer","minimum":0,"maximum":9007199254740991},"counts":{"type":"object","properties":{"queued":{"type":"integer","minimum":0,"maximum":9007199254740991},"processing":{"type":"integer","minimum":0,"maximum":9007199254740991},"succeeded":{"type":"integer","minimum":0,"maximum":9007199254740991},"failed":{"type":"integer","minimum":0,"maximum":9007199254740991},"cancelled":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["queued","processing","succeeded","failed","cancelled"],"additionalProperties":false},"items":{"type":"array","items":{"type":"object","properties":{"index":{"type":"integer","minimum":0,"maximum":9007199254740991},"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"state":{"type":"string","enum":["queued","processing","succeeded","failed","cancelled"]},"templateVersionId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"test":{"type":"boolean","description":"Whether this is a free test render, whose PDF or image carries a diagonal \"TEST\" watermark. See [test renders](/guides/rendering/#test-renders)."},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["index","id","state","test","createdAt","updatedAt"],"additionalProperties":false}}},"required":["id","createdAt","total","counts","items"],"additionalProperties":false,"title":"RenderBatch"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/renders/batch/{id}/pdf":{"get":{"operationId":"getRenderBatchPdf","summary":"Download a finished batch as one PDF","tags":["Renders"],"description":"Needs `render:read`.","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK"}}}},"/v1/renders":{"get":{"operationId":"listRenders","summary":"List renders","tags":["Renders"],"description":"Newest first; filter with `state`. Needs `render:read`.","parameters":[{"schema":{"type":"string"},"in":"query","name":"limit","required":false},{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"query","name":"cursor","required":false},{"schema":{"type":"string","enum":["queued","processing","succeeded","failed","cancelled"]},"in":"query","name":"state","required":false}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"templateVersionId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"test":{"type":"boolean","description":"Whether this is a free test render, whose PDF or image carries a diagonal \"TEST\" watermark. See [test renders](/guides/rendering/#test-renders)."},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"state":{"type":"string","enum":["queued","processing","succeeded","failed","cancelled"]},"durationMs":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["id","test","createdAt","updatedAt","state"],"additionalProperties":false}},"nextCursor":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"}},"required":["items"],"additionalProperties":false,"title":"RenderList"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}},"post":{"operationId":"createRender","summary":"Create a render","tags":["Renders"],"description":"Renders HTML, a node document, a template version or a draft. Answers `200` when the render finished within `waitMs`, otherwise `202`. Needs `render:create`. Rendering a draft also needs `template:read`. See [Renders API](/guides/rendering/).","requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"document":{"anyOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["html"]},"html":{"type":"string","minLength":1,"maxLength":5000000},"css":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","maxLength":1000000}},"assetIds":{"default":[],"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"}}},"required":["kind","html"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","enum":["node"]},"node":{"$ref":"#/components/schemas/DocumentNode"},"css":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","maxLength":1000000}},"assetIds":{"default":[],"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"}}},"required":["kind","node"],"additionalProperties":false}],"title":"RenderDocument"},"settings":{"type":"object","properties":{"pageSize":{"type":"object","properties":{"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["widthMm","heightMm"],"additionalProperties":false},"orientation":{"default":"portrait","type":"string","enum":["portrait","landscape"]},"margins":{"type":"object","properties":{"topMm":{"type":"number","minimum":0,"maximum":500},"rightMm":{"type":"number","minimum":0,"maximum":500},"bottomMm":{"type":"number","minimum":0,"maximum":500},"leftMm":{"type":"number","minimum":0,"maximum":500}},"required":["topMm","rightMm","bottomMm","leftMm"],"additionalProperties":false},"locale":{"default":"en-US","type":"string","minLength":2,"maxLength":64},"pageRanges":{"type":"string","maxLength":200},"metadata":{"type":"object","properties":{"title":{"type":"string","maxLength":500},"author":{"type":"string","maxLength":200},"subject":{"type":"string","maxLength":1000},"creator":{"type":"string","maxLength":200},"producer":{"type":"string","maxLength":200},"language":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","pattern":"^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3}$"}]},"keywords":{"maxItems":32,"type":"array","items":{"type":"string","maxLength":100}},"xmp":{"maxItems":4,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"prefix":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"namespace":{"type":"string","minLength":1,"maxLength":500,"pattern":"^[a-z][\\w+.-]*:\\S+$"},"properties":{"minItems":1,"maxItems":32,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"value":{"type":"string","maxLength":1000},"description":{"type":"string","minLength":1,"maxLength":1000}},"required":["name","value","description"],"additionalProperties":false}}},"required":["name","prefix","namespace","properties"],"additionalProperties":false,"title":"XmpSchema"}}},"additionalProperties":false,"title":"PdfMetadata"},"encryption":{"type":"object","properties":{"openPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"ownerPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"permissions":{"type":"object","properties":{"printing":{"type":"string","enum":["none","lowResolution","highResolution"]},"modifying":{"type":"boolean"},"copying":{"type":"boolean"},"annotating":{"type":"boolean"},"fillingForms":{"type":"boolean"},"contentAccessibility":{"type":"boolean"},"documentAssembly":{"type":"boolean"}},"additionalProperties":false,"title":"PdfPermissions"}},"additionalProperties":false,"title":"PdfEncryption"},"signature":{"type":"object","properties":{"certificate":{"type":"string","maxLength":120},"reason":{"type":"string","maxLength":200},"location":{"type":"string","maxLength":200},"contactInfo":{"type":"string","maxLength":200},"field":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"maximum":100000},"xMm":{"type":"number","minimum":0,"maximum":2000},"yMm":{"type":"number","minimum":0,"maximum":2000},"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["xMm","yMm","widthMm","heightMm"],"additionalProperties":false,"title":"PdfSignatureField"}},"required":["certificate"],"additionalProperties":false,"title":"PdfSignature"},"operations":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["append","prepend","merge"]},"template":{"type":"string","minLength":1,"maxLength":120},"pdf":{"type":"string","minLength":1,"maxLength":255},"mergeWholeDocument":{"type":"boolean"},"mergeToFront":{"type":"boolean"},"renderForEveryPage":{"type":"boolean"}},"required":["type"],"additionalProperties":false,"title":"PdfOperation"}},"pdfa":{"type":"string","enum":["4","2b","2u","2a","3b","3u","3a","4f"],"title":"PdfaLevel"},"pdfua":{"type":"string","enum":["1","2"],"title":"PdfuaPart"},"opaqueFills":{"type":"boolean"},"preferCssPageSize":{"type":"boolean"}},"required":["pageSize","margins"],"additionalProperties":false,"title":"TemplateSettings"},"metadata":{"type":"object","properties":{"title":{"type":"string","maxLength":500},"author":{"type":"string","maxLength":200},"subject":{"type":"string","maxLength":1000},"creator":{"type":"string","maxLength":200},"producer":{"type":"string","maxLength":200},"language":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","pattern":"^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3}$"}]},"keywords":{"maxItems":32,"type":"array","items":{"type":"string","maxLength":100}},"xmp":{"maxItems":4,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"prefix":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"namespace":{"type":"string","minLength":1,"maxLength":500,"pattern":"^[a-z][\\w+.-]*:\\S+$"},"properties":{"minItems":1,"maxItems":32,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"value":{"type":"string","maxLength":1000},"description":{"type":"string","minLength":1,"maxLength":1000}},"required":["name","value","description"],"additionalProperties":false}}},"required":["name","prefix","namespace","properties"],"additionalProperties":false,"title":"XmpSchema"}}},"additionalProperties":false,"title":"PdfMetadata"},"attachments":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[^/\\\\\\p{Cc}]+$"},"mimeType":{"type":"string","maxLength":127,"pattern":"^[\\w.+-]+\\/[\\w.+-]+$"},"description":{"type":"string","minLength":1,"maxLength":1000},"relationship":{"type":"string","enum":["source","data","alternative","supplement","unspecified"]},"content":{"type":"string"},"contentBase64":{"type":"string","pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"}},"required":["name"],"additionalProperties":false,"title":"PdfAttachment"}},"encryption":{"type":"object","properties":{"openPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"ownerPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"permissions":{"type":"object","properties":{"printing":{"type":"string","enum":["none","lowResolution","highResolution"]},"modifying":{"type":"boolean"},"copying":{"type":"boolean"},"annotating":{"type":"boolean"},"fillingForms":{"type":"boolean"},"contentAccessibility":{"type":"boolean"},"documentAssembly":{"type":"boolean"}},"additionalProperties":false,"title":"PdfPermissions"}},"additionalProperties":false,"title":"PdfEncryption"},"signature":{"type":"object","properties":{"certificate":{"type":"string","maxLength":120},"reason":{"type":"string","maxLength":200},"location":{"type":"string","maxLength":200},"contactInfo":{"type":"string","maxLength":200},"field":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"maximum":100000},"xMm":{"type":"number","minimum":0,"maximum":2000},"yMm":{"type":"number","minimum":0,"maximum":2000},"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["xMm","yMm","widthMm","heightMm"],"additionalProperties":false,"title":"PdfSignatureField"}},"additionalProperties":false,"title":"PdfSignatureOverride"},"watermark":{"type":"object","properties":{"text":{"type":"string","maxLength":200,"pattern":"^(?=.*\\S)[^\\p{Cc}]+$","description":"The text, such as `DRAFT` or `CONFIDENTIAL`. One line."},"opacity":{"type":"number","minimum":0,"maximum":1,"description":"From 0 (invisible) to 1 (solid). Default 0.3."},"rotation":{"type":"number","minimum":-360,"maximum":360,"description":"Angle in degrees, counter-clockwise; 0 is horizontal. Default: along the page's diagonal from the bottom left."},"fontSize":{"type":"number","exclusiveMinimum":0,"maximum":500,"description":"Size in points. Default: the text spans 60% of the page along its angle, at most 144 pt."},"color":{"type":"string","pattern":"^#(?:[0-9a-f]{3}|[0-9a-f]{6})$","description":"Hex colour such as `#c00000`. Default `#808080` (gray)."}},"required":["text"],"additionalProperties":false,"title":"PdfWatermark"},"format":{"type":"string","enum":["pdf","png","jpeg","webp"],"description":"`pdf` (the default), or `png`, `jpeg` or `webp` for one page of the PDF drawn as an image. See [images](/guides/rendering/#render-an-image)."},"image":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"maximum":200,"description":"The page to draw, from 1. Default 1."},"width":{"type":"integer","minimum":16,"maximum":4096,"description":"The image's width in pixels; the height follows the page's shape. Default: the page's width in CSS pixels, so a page of 1200 × 630 px gives a 1200 × 630 image."},"quality":{"type":"integer","minimum":1,"maximum":100,"description":"JPEG quality from 1 to 100. Default 90. JPEG only."}},"additionalProperties":false,"title":"ImageOptions"},"destination":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120,"description":"A storage destination's name."},"path":{"type":"string","minLength":1,"maxLength":512,"description":"The object's key after the destination's prefix; `{renderId}` is replaced with the render's ID. Defaults to `{renderId}.pdf`, or the image's extension, such as `.png`. An object already at the key is replaced."},"keepCopy":{"type":"boolean","description":"`false` keeps no copy: the render then has no `downloadUrl`, and its batch cannot be merged. Defaults to `true`."}},"required":["name"],"additionalProperties":false,"title":"RenderDestination"},"test":{"type":"boolean","description":"Render a free test document with a diagonal \"TEST\" watermark on every page. Test renders do not count against the workspace's render allowances; they have their own of 10 outstanding and 10 per minute, or the workspace's own if lower. See [test renders](/guides/rendering/#test-renders)."},"waitMs":{"default":0,"type":"integer","minimum":0,"maximum":10000}},"required":["document","settings"],"additionalProperties":false,"title":"DirectRenderBody"},{"type":"object","properties":{"preview":{"type":"object","properties":{"composition":{"type":"object","properties":{"root":{"anyOf":[{"$ref":"#/components/schemas/CompositionNode"},{"type":"object","properties":{"type":{"type":"string","enum":["html"]},"html":{"type":"string","minLength":1,"maxLength":2000000},"helpers":{"type":"string","maxLength":500000}},"required":["type","html"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["sheets"]},"sheets":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":31,"pattern":"^[^[\\]*?:/\\\\]+$"},"sections":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"title":{"anyOf":[{"type":"string","maxLength":200},{"type":"object","propertyNames":{"type":"string","pattern":"^(?:default|[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3})$"},"additionalProperties":{"type":"string","maxLength":200}}]},"source":{"type":"string","maxLength":200,"pattern":"^[A-Za-z_$][\\w$]*(?:\\.(?:[A-Za-z_$][\\w$]*|0|[1-9]\\d*))*$"},"columns":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"header":{"anyOf":[{"type":"string","maxLength":200},{"type":"object","propertyNames":{"type":"string","pattern":"^(?:default|[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3})$"},"additionalProperties":{"type":"string","maxLength":200}}]},"value":{"type":"string","maxLength":200,"pattern":"^[A-Za-z_$][\\w$]*(?:\\.(?:[A-Za-z_$][\\w$]*|0|[1-9]\\d*))*$"},"format":{"type":"string","enum":["text","number","decimal","date"]},"width":{"type":"number","minimum":5,"maximum":100}},"required":["header","value","format"],"additionalProperties":false}}},"required":["source","columns"],"additionalProperties":false}}},"required":["name","sections"],"additionalProperties":false}}},"required":["type","sheets"],"additionalProperties":false}]},"header":{"type":"string","maxLength":100000},"footer":{"type":"string","maxLength":100000},"components":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"additionalProperties":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"root":{"$ref":"#/components/schemas/CompositionNode"},"source":{"type":"object","properties":{"templateId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"componentId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["templateId","componentId","revision"],"additionalProperties":false}},"required":["name","root"],"additionalProperties":false}},"stylesheets":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":255}}},"required":["root"],"additionalProperties":false,"title":"DraftComposition"},"scripts":{"maxItems":10,"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},"sampleDataFile":{"type":"string","minLength":1,"maxLength":255},"workbook":{"type":"string","minLength":1,"maxLength":255},"settings":{"type":"object","properties":{"pageSize":{"type":"object","properties":{"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["widthMm","heightMm"],"additionalProperties":false},"orientation":{"default":"portrait","type":"string","enum":["portrait","landscape"]},"margins":{"type":"object","properties":{"topMm":{"type":"number","minimum":0,"maximum":500},"rightMm":{"type":"number","minimum":0,"maximum":500},"bottomMm":{"type":"number","minimum":0,"maximum":500},"leftMm":{"type":"number","minimum":0,"maximum":500}},"required":["topMm","rightMm","bottomMm","leftMm"],"additionalProperties":false},"locale":{"default":"en-US","type":"string","minLength":2,"maxLength":64},"pageRanges":{"type":"string","maxLength":200},"metadata":{"type":"object","properties":{"title":{"type":"string","maxLength":500},"author":{"type":"string","maxLength":200},"subject":{"type":"string","maxLength":1000},"creator":{"type":"string","maxLength":200},"producer":{"type":"string","maxLength":200},"language":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","pattern":"^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3}$"}]},"keywords":{"maxItems":32,"type":"array","items":{"type":"string","maxLength":100}},"xmp":{"maxItems":4,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"prefix":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"namespace":{"type":"string","minLength":1,"maxLength":500,"pattern":"^[a-z][\\w+.-]*:\\S+$"},"properties":{"minItems":1,"maxItems":32,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"value":{"type":"string","maxLength":1000},"description":{"type":"string","minLength":1,"maxLength":1000}},"required":["name","value","description"],"additionalProperties":false}}},"required":["name","prefix","namespace","properties"],"additionalProperties":false,"title":"XmpSchema"}}},"additionalProperties":false,"title":"PdfMetadata"},"encryption":{"type":"object","properties":{"openPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"ownerPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"permissions":{"type":"object","properties":{"printing":{"type":"string","enum":["none","lowResolution","highResolution"]},"modifying":{"type":"boolean"},"copying":{"type":"boolean"},"annotating":{"type":"boolean"},"fillingForms":{"type":"boolean"},"contentAccessibility":{"type":"boolean"},"documentAssembly":{"type":"boolean"}},"additionalProperties":false,"title":"PdfPermissions"}},"additionalProperties":false,"title":"PdfEncryption"},"signature":{"type":"object","properties":{"certificate":{"type":"string","maxLength":120},"reason":{"type":"string","maxLength":200},"location":{"type":"string","maxLength":200},"contactInfo":{"type":"string","maxLength":200},"field":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"maximum":100000},"xMm":{"type":"number","minimum":0,"maximum":2000},"yMm":{"type":"number","minimum":0,"maximum":2000},"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["xMm","yMm","widthMm","heightMm"],"additionalProperties":false,"title":"PdfSignatureField"}},"required":["certificate"],"additionalProperties":false,"title":"PdfSignature"},"operations":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["append","prepend","merge"]},"template":{"type":"string","minLength":1,"maxLength":120},"pdf":{"type":"string","minLength":1,"maxLength":255},"mergeWholeDocument":{"type":"boolean"},"mergeToFront":{"type":"boolean"},"renderForEveryPage":{"type":"boolean"}},"required":["type"],"additionalProperties":false,"title":"PdfOperation"}},"pdfa":{"type":"string","enum":["4","2b","2u","2a","3b","3u","3a","4f"],"title":"PdfaLevel"},"pdfua":{"type":"string","enum":["1","2"],"title":"PdfuaPart"},"opaqueFills":{"type":"boolean"},"preferCssPageSize":{"type":"boolean"}},"required":["pageSize","margins"],"additionalProperties":false,"title":"TemplateSettings"},"contentFields":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_]{0,63}$","title":"ContentFieldKey"},"label":{"type":"string","minLength":1,"maxLength":120},"type":{"type":"string","enum":["text","richText","image","colour","toggle","choice","number","date"]},"group":{"type":"string","minLength":1,"maxLength":80},"help":{"type":"string","maxLength":500},"multiline":{"type":"boolean"},"maxLength":{"type":"integer","minimum":1,"maximum":65536},"options":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}}},"required":["key","label","type"],"additionalProperties":false,"title":"ContentField"},"title":"ContentFields"},"contentValues":{"type":"object","propertyNames":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_]{0,63}$","title":"ContentFieldKey"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":65536},{"type":"number"},{"type":"boolean"}],"title":"ContentValue"},"title":"ContentValues"}},"required":["composition","settings"],"additionalProperties":false,"title":"TemplateDraftContent"},"templateId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"data":{"$ref":"#/components/schemas/JsonValue"},"metadata":{"type":"object","properties":{"title":{"type":"string","maxLength":500},"author":{"type":"string","maxLength":200},"subject":{"type":"string","maxLength":1000},"creator":{"type":"string","maxLength":200},"producer":{"type":"string","maxLength":200},"language":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","pattern":"^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3}$"}]},"keywords":{"maxItems":32,"type":"array","items":{"type":"string","maxLength":100}},"xmp":{"maxItems":4,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"prefix":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"namespace":{"type":"string","minLength":1,"maxLength":500,"pattern":"^[a-z][\\w+.-]*:\\S+$"},"properties":{"minItems":1,"maxItems":32,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"value":{"type":"string","maxLength":1000},"description":{"type":"string","minLength":1,"maxLength":1000}},"required":["name","value","description"],"additionalProperties":false}}},"required":["name","prefix","namespace","properties"],"additionalProperties":false,"title":"XmpSchema"}}},"additionalProperties":false,"title":"PdfMetadata"},"attachments":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[^/\\\\\\p{Cc}]+$"},"mimeType":{"type":"string","maxLength":127,"pattern":"^[\\w.+-]+\\/[\\w.+-]+$"},"description":{"type":"string","minLength":1,"maxLength":1000},"relationship":{"type":"string","enum":["source","data","alternative","supplement","unspecified"]},"content":{"type":"string"},"contentBase64":{"type":"string","pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"}},"required":["name"],"additionalProperties":false,"title":"PdfAttachment"}},"encryption":{"type":"object","properties":{"openPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"ownerPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"permissions":{"type":"object","properties":{"printing":{"type":"string","enum":["none","lowResolution","highResolution"]},"modifying":{"type":"boolean"},"copying":{"type":"boolean"},"annotating":{"type":"boolean"},"fillingForms":{"type":"boolean"},"contentAccessibility":{"type":"boolean"},"documentAssembly":{"type":"boolean"}},"additionalProperties":false,"title":"PdfPermissions"}},"additionalProperties":false,"title":"PdfEncryption"},"signature":{"type":"object","properties":{"certificate":{"type":"string","maxLength":120},"reason":{"type":"string","maxLength":200},"location":{"type":"string","maxLength":200},"contactInfo":{"type":"string","maxLength":200},"field":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"maximum":100000},"xMm":{"type":"number","minimum":0,"maximum":2000},"yMm":{"type":"number","minimum":0,"maximum":2000},"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["xMm","yMm","widthMm","heightMm"],"additionalProperties":false,"title":"PdfSignatureField"}},"additionalProperties":false,"title":"PdfSignatureOverride"},"checkConformance":{"type":"boolean"},"watermark":{"type":"object","properties":{"text":{"type":"string","maxLength":200,"pattern":"^(?=.*\\S)[^\\p{Cc}]+$","description":"The text, such as `DRAFT` or `CONFIDENTIAL`. One line."},"opacity":{"type":"number","minimum":0,"maximum":1,"description":"From 0 (invisible) to 1 (solid). Default 0.3."},"rotation":{"type":"number","minimum":-360,"maximum":360,"description":"Angle in degrees, counter-clockwise; 0 is horizontal. Default: along the page's diagonal from the bottom left."},"fontSize":{"type":"number","exclusiveMinimum":0,"maximum":500,"description":"Size in points. Default: the text spans 60% of the page along its angle, at most 144 pt."},"color":{"type":"string","pattern":"^#(?:[0-9a-f]{3}|[0-9a-f]{6})$","description":"Hex colour such as `#c00000`. Default `#808080` (gray)."}},"required":["text"],"additionalProperties":false,"title":"PdfWatermark"},"format":{"type":"string","enum":["pdf","png","jpeg","webp"],"description":"`pdf` (the default), or `png`, `jpeg` or `webp` for one page of the PDF drawn as an image. See [images](/guides/rendering/#render-an-image)."},"image":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"maximum":200,"description":"The page to draw, from 1. Default 1."},"width":{"type":"integer","minimum":16,"maximum":4096,"description":"The image's width in pixels; the height follows the page's shape. Default: the page's width in CSS pixels, so a page of 1200 × 630 px gives a 1200 × 630 image."},"quality":{"type":"integer","minimum":1,"maximum":100,"description":"JPEG quality from 1 to 100. Default 90. JPEG only."}},"additionalProperties":false,"title":"ImageOptions"},"test":{"type":"boolean","description":"Render a free test document with a diagonal \"TEST\" watermark on every page. Test renders do not count against the workspace's render allowances; they have their own of 10 outstanding and 10 per minute, or the workspace's own if lower. See [test renders](/guides/rendering/#test-renders)."},"waitMs":{"default":0,"type":"integer","minimum":0,"maximum":10000}},"required":["preview"],"additionalProperties":false,"title":"PreviewRenderBody"},{"type":"object","properties":{"templateVersionId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"data":{"$ref":"#/components/schemas/JsonValue"},"locale":{"type":"string","maxLength":64,"pattern":"^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3}$","description":"Picks the template's translations, such as `de-DE`. Omitted, the template's own language is used."},"metadata":{"type":"object","properties":{"title":{"type":"string","maxLength":500},"author":{"type":"string","maxLength":200},"subject":{"type":"string","maxLength":1000},"creator":{"type":"string","maxLength":200},"producer":{"type":"string","maxLength":200},"language":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","pattern":"^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3}$"}]},"keywords":{"maxItems":32,"type":"array","items":{"type":"string","maxLength":100}},"xmp":{"maxItems":4,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"prefix":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"namespace":{"type":"string","minLength":1,"maxLength":500,"pattern":"^[a-z][\\w+.-]*:\\S+$"},"properties":{"minItems":1,"maxItems":32,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"value":{"type":"string","maxLength":1000},"description":{"type":"string","minLength":1,"maxLength":1000}},"required":["name","value","description"],"additionalProperties":false}}},"required":["name","prefix","namespace","properties"],"additionalProperties":false,"title":"XmpSchema"}}},"additionalProperties":false,"title":"PdfMetadata"},"attachments":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[^/\\\\\\p{Cc}]+$"},"mimeType":{"type":"string","maxLength":127,"pattern":"^[\\w.+-]+\\/[\\w.+-]+$"},"description":{"type":"string","minLength":1,"maxLength":1000},"relationship":{"type":"string","enum":["source","data","alternative","supplement","unspecified"]},"content":{"type":"string"},"contentBase64":{"type":"string","pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"}},"required":["name"],"additionalProperties":false,"title":"PdfAttachment"}},"encryption":{"type":"object","properties":{"openPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"ownerPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"permissions":{"type":"object","properties":{"printing":{"type":"string","enum":["none","lowResolution","highResolution"]},"modifying":{"type":"boolean"},"copying":{"type":"boolean"},"annotating":{"type":"boolean"},"fillingForms":{"type":"boolean"},"contentAccessibility":{"type":"boolean"},"documentAssembly":{"type":"boolean"}},"additionalProperties":false,"title":"PdfPermissions"}},"additionalProperties":false,"title":"PdfEncryption"},"signature":{"type":"object","properties":{"certificate":{"type":"string","maxLength":120},"reason":{"type":"string","maxLength":200},"location":{"type":"string","maxLength":200},"contactInfo":{"type":"string","maxLength":200},"field":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"maximum":100000},"xMm":{"type":"number","minimum":0,"maximum":2000},"yMm":{"type":"number","minimum":0,"maximum":2000},"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["xMm","yMm","widthMm","heightMm"],"additionalProperties":false,"title":"PdfSignatureField"}},"additionalProperties":false,"title":"PdfSignatureOverride"},"watermark":{"type":"object","properties":{"text":{"type":"string","maxLength":200,"pattern":"^(?=.*\\S)[^\\p{Cc}]+$","description":"The text, such as `DRAFT` or `CONFIDENTIAL`. One line."},"opacity":{"type":"number","minimum":0,"maximum":1,"description":"From 0 (invisible) to 1 (solid). Default 0.3."},"rotation":{"type":"number","minimum":-360,"maximum":360,"description":"Angle in degrees, counter-clockwise; 0 is horizontal. Default: along the page's diagonal from the bottom left."},"fontSize":{"type":"number","exclusiveMinimum":0,"maximum":500,"description":"Size in points. Default: the text spans 60% of the page along its angle, at most 144 pt."},"color":{"type":"string","pattern":"^#(?:[0-9a-f]{3}|[0-9a-f]{6})$","description":"Hex colour such as `#c00000`. Default `#808080` (gray)."}},"required":["text"],"additionalProperties":false,"title":"PdfWatermark"},"format":{"type":"string","enum":["pdf","png","jpeg","webp"],"description":"`pdf` (the default), or `png`, `jpeg` or `webp` for one page of the PDF drawn as an image. See [images](/guides/rendering/#render-an-image)."},"image":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"maximum":200,"description":"The page to draw, from 1. Default 1."},"width":{"type":"integer","minimum":16,"maximum":4096,"description":"The image's width in pixels; the height follows the page's shape. Default: the page's width in CSS pixels, so a page of 1200 × 630 px gives a 1200 × 630 image."},"quality":{"type":"integer","minimum":1,"maximum":100,"description":"JPEG quality from 1 to 100. Default 90. JPEG only."}},"additionalProperties":false,"title":"ImageOptions"},"destination":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120,"description":"A storage destination's name."},"path":{"type":"string","minLength":1,"maxLength":512,"description":"The object's key after the destination's prefix; `{renderId}` is replaced with the render's ID. Defaults to `{renderId}.pdf`, or the image's extension, such as `.png`. An object already at the key is replaced."},"keepCopy":{"type":"boolean","description":"`false` keeps no copy: the render then has no `downloadUrl`, and its batch cannot be merged. Defaults to `true`."}},"required":["name"],"additionalProperties":false,"title":"RenderDestination"},"test":{"type":"boolean","description":"Render a free test document with a diagonal \"TEST\" watermark on every page. Test renders do not count against the workspace's render allowances; they have their own of 10 outstanding and 10 per minute, or the workspace's own if lower. See [test renders](/guides/rendering/#test-renders)."},"waitMs":{"default":0,"type":"integer","minimum":0,"maximum":10000}},"required":["templateVersionId","data"],"additionalProperties":false}],"title":"CreateRenderBody"}}}},"parameters":[{"schema":{"type":"string","minLength":1,"maxLength":255},"in":"header","name":"idempotency-key","required":false,"description":"Repeating a request with the same key returns the first result instead of rendering twice. See [idempotency keys](/guides/rendering/#idempotency-keys)."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"templateVersionId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"test":{"type":"boolean","description":"Whether this is a free test render, whose PDF or image carries a diagonal \"TEST\" watermark. See [test renders](/guides/rendering/#test-renders)."},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"state":{"type":"string","enum":["queued"]}},"required":["id","test","createdAt","updatedAt","state"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"templateVersionId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"test":{"type":"boolean","description":"Whether this is a free test render, whose PDF or image carries a diagonal \"TEST\" watermark. See [test renders](/guides/rendering/#test-renders)."},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"state":{"type":"string","enum":["processing"]}},"required":["id","test","createdAt","updatedAt","state"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"templateVersionId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"test":{"type":"boolean","description":"Whether this is a free test render, whose PDF or image carries a diagonal \"TEST\" watermark. See [test renders](/guides/rendering/#test-renders)."},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"state":{"type":"string","enum":["succeeded"]},"result":{"type":"object","properties":{"downloadUrl":{"type":"string"},"expiresAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"destination":{"type":"object","properties":{"name":{"type":"string","description":"The storage destination's name."},"key":{"type":"string","description":"The object's full key in the bucket."}},"required":["name","key"],"additionalProperties":false,"title":"RenderDelivery"},"mediaType":{"type":"string","enum":["application/pdf","image/png","image/jpeg","image/webp"],"description":"The file's type: `application/pdf`, or the image's."},"pageCount":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"outputBytes":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"durationMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"timing":{"type":"object","properties":{"preparationMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"renderMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"totalMs":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["preparationMs","renderMs","totalMs"],"additionalProperties":false,"title":"RenderTiming"},"engine":{"type":"object","properties":{"name":{"type":"string","enum":["typefold"]},"version":{"type":"string","pattern":"^\\d+\\.\\d+\\.\\d+(?:-[a-zA-Z0-9.-]+)?(?:\\+[a-zA-Z0-9.-]+)?$"},"buildId":{"type":"string","pattern":"^sha256:[a-f0-9]{64}$"}},"required":["name","version","buildId"],"additionalProperties":false,"title":"RenderEngine"},"conformance":{"type":"array","items":{"type":"object","properties":{"standard":{"type":"string"},"conforms":{"type":"boolean"},"issues":{"type":"array","items":{"type":"string"}}},"required":["standard","conforms"],"additionalProperties":false,"title":"PdfConformanceResult"}}},"required":["mediaType","pageCount","outputBytes","durationMs"],"additionalProperties":false,"title":"RenderResult"}},"required":["id","test","createdAt","updatedAt","state","result"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"templateVersionId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"test":{"type":"boolean","description":"Whether this is a free test render, whose PDF or image carries a diagonal \"TEST\" watermark. See [test renders](/guides/rendering/#test-renders)."},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"state":{"type":"string","enum":["failed"]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"stage":{"type":"string","enum":["load_request","validate_request","load_assets","prepare","render","validate_output","store_output","persist_result"]},"diagnostics":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["html_invalid","assets_invalid","max_input_bytes","asset_id_invalid","asset_bytes_invalid","asset_checksum_mismatch","asset_media_type_unsupported","stylesheet_utf8_invalid","document_invalid","asset_manifest_mismatch","limit_invalid","options_invalid","font_invalid","font_glyphs_missing","image_invalid","renderer_version_unavailable","renderer_closed","engine_failure","render_process_exited","render_memory_limit","pdf_magic_missing","pdf_page_count_missing","max_output_bytes","max_pages","pdfa_validation_failed","watermark_text_unsupported","pdf_postprocess_failed","image_page_missing","image_too_large","destination_upload_failed"]},"message":{"type":"string"},"path":{"type":"string","pattern":"^\\/(?:document(?:\\/(?:html|node|css|assetIds)(?:\\/\\d{1,6})?)?|assets(?:\\/\\d{1,6}\\/(?:id|bytes|sha256|mediaType))?|limits\\/(?:maxInputBytes|maxOutputBytes|maxPages)|options)$"}},"required":["code","message"],"additionalProperties":false,"title":"RenderDiagnostic"}},"engine":{"type":"object","properties":{"name":{"type":"string","enum":["typefold"]},"version":{"type":"string","pattern":"^\\d+\\.\\d+\\.\\d+(?:-[a-zA-Z0-9.-]+)?(?:\\+[a-zA-Z0-9.-]+)?$"},"buildId":{"type":"string","pattern":"^sha256:[a-f0-9]{64}$"}},"required":["name","version","buildId"],"additionalProperties":false,"title":"RenderEngine"}},"required":["code","message","retryable"],"additionalProperties":false,"title":"RenderError"}},"required":["id","test","createdAt","updatedAt","state","error"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"templateVersionId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"test":{"type":"boolean","description":"Whether this is a free test render, whose PDF or image carries a diagonal \"TEST\" watermark. See [test renders](/guides/rendering/#test-renders)."},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"state":{"type":"string","enum":["cancelled"]}},"required":["id","test","createdAt","updatedAt","state"],"additionalProperties":false}],"title":"Render"}}}},"202":{"description":"Accepted","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"templateVersionId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"test":{"type":"boolean","description":"Whether this is a free test render, whose PDF or image carries a diagonal \"TEST\" watermark. See [test renders](/guides/rendering/#test-renders)."},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"state":{"type":"string","enum":["queued"]}},"required":["id","test","createdAt","updatedAt","state"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"templateVersionId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"test":{"type":"boolean","description":"Whether this is a free test render, whose PDF or image carries a diagonal \"TEST\" watermark. See [test renders](/guides/rendering/#test-renders)."},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"state":{"type":"string","enum":["processing"]}},"required":["id","test","createdAt","updatedAt","state"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"templateVersionId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"test":{"type":"boolean","description":"Whether this is a free test render, whose PDF or image carries a diagonal \"TEST\" watermark. See [test renders](/guides/rendering/#test-renders)."},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"state":{"type":"string","enum":["succeeded"]},"result":{"type":"object","properties":{"downloadUrl":{"type":"string"},"expiresAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"destination":{"type":"object","properties":{"name":{"type":"string","description":"The storage destination's name."},"key":{"type":"string","description":"The object's full key in the bucket."}},"required":["name","key"],"additionalProperties":false,"title":"RenderDelivery"},"mediaType":{"type":"string","enum":["application/pdf","image/png","image/jpeg","image/webp"],"description":"The file's type: `application/pdf`, or the image's."},"pageCount":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"outputBytes":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"durationMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"timing":{"type":"object","properties":{"preparationMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"renderMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"totalMs":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["preparationMs","renderMs","totalMs"],"additionalProperties":false,"title":"RenderTiming"},"engine":{"type":"object","properties":{"name":{"type":"string","enum":["typefold"]},"version":{"type":"string","pattern":"^\\d+\\.\\d+\\.\\d+(?:-[a-zA-Z0-9.-]+)?(?:\\+[a-zA-Z0-9.-]+)?$"},"buildId":{"type":"string","pattern":"^sha256:[a-f0-9]{64}$"}},"required":["name","version","buildId"],"additionalProperties":false,"title":"RenderEngine"},"conformance":{"type":"array","items":{"type":"object","properties":{"standard":{"type":"string"},"conforms":{"type":"boolean"},"issues":{"type":"array","items":{"type":"string"}}},"required":["standard","conforms"],"additionalProperties":false,"title":"PdfConformanceResult"}}},"required":["mediaType","pageCount","outputBytes","durationMs"],"additionalProperties":false,"title":"RenderResult"}},"required":["id","test","createdAt","updatedAt","state","result"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"templateVersionId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"test":{"type":"boolean","description":"Whether this is a free test render, whose PDF or image carries a diagonal \"TEST\" watermark. See [test renders](/guides/rendering/#test-renders)."},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"state":{"type":"string","enum":["failed"]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"stage":{"type":"string","enum":["load_request","validate_request","load_assets","prepare","render","validate_output","store_output","persist_result"]},"diagnostics":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["html_invalid","assets_invalid","max_input_bytes","asset_id_invalid","asset_bytes_invalid","asset_checksum_mismatch","asset_media_type_unsupported","stylesheet_utf8_invalid","document_invalid","asset_manifest_mismatch","limit_invalid","options_invalid","font_invalid","font_glyphs_missing","image_invalid","renderer_version_unavailable","renderer_closed","engine_failure","render_process_exited","render_memory_limit","pdf_magic_missing","pdf_page_count_missing","max_output_bytes","max_pages","pdfa_validation_failed","watermark_text_unsupported","pdf_postprocess_failed","image_page_missing","image_too_large","destination_upload_failed"]},"message":{"type":"string"},"path":{"type":"string","pattern":"^\\/(?:document(?:\\/(?:html|node|css|assetIds)(?:\\/\\d{1,6})?)?|assets(?:\\/\\d{1,6}\\/(?:id|bytes|sha256|mediaType))?|limits\\/(?:maxInputBytes|maxOutputBytes|maxPages)|options)$"}},"required":["code","message"],"additionalProperties":false,"title":"RenderDiagnostic"}},"engine":{"type":"object","properties":{"name":{"type":"string","enum":["typefold"]},"version":{"type":"string","pattern":"^\\d+\\.\\d+\\.\\d+(?:-[a-zA-Z0-9.-]+)?(?:\\+[a-zA-Z0-9.-]+)?$"},"buildId":{"type":"string","pattern":"^sha256:[a-f0-9]{64}$"}},"required":["name","version","buildId"],"additionalProperties":false,"title":"RenderEngine"}},"required":["code","message","retryable"],"additionalProperties":false,"title":"RenderError"}},"required":["id","test","createdAt","updatedAt","state","error"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"templateVersionId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"test":{"type":"boolean","description":"Whether this is a free test render, whose PDF or image carries a diagonal \"TEST\" watermark. See [test renders](/guides/rendering/#test-renders)."},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"state":{"type":"string","enum":["cancelled"]}},"required":["id","test","createdAt","updatedAt","state"],"additionalProperties":false}],"title":"Render"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/renders/{id}":{"get":{"operationId":"getRender","summary":"Get a render","tags":["Renders"],"description":"The render's state and, once it succeeded, a download URL. See [render states](/guides/rendering/#render-states). Needs `render:read`.","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"templateVersionId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"test":{"type":"boolean","description":"Whether this is a free test render, whose PDF or image carries a diagonal \"TEST\" watermark. See [test renders](/guides/rendering/#test-renders)."},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"state":{"type":"string","enum":["queued"]}},"required":["id","test","createdAt","updatedAt","state"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"templateVersionId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"test":{"type":"boolean","description":"Whether this is a free test render, whose PDF or image carries a diagonal \"TEST\" watermark. See [test renders](/guides/rendering/#test-renders)."},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"state":{"type":"string","enum":["processing"]}},"required":["id","test","createdAt","updatedAt","state"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"templateVersionId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"test":{"type":"boolean","description":"Whether this is a free test render, whose PDF or image carries a diagonal \"TEST\" watermark. See [test renders](/guides/rendering/#test-renders)."},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"state":{"type":"string","enum":["succeeded"]},"result":{"type":"object","properties":{"downloadUrl":{"type":"string"},"expiresAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"destination":{"type":"object","properties":{"name":{"type":"string","description":"The storage destination's name."},"key":{"type":"string","description":"The object's full key in the bucket."}},"required":["name","key"],"additionalProperties":false,"title":"RenderDelivery"},"mediaType":{"type":"string","enum":["application/pdf","image/png","image/jpeg","image/webp"],"description":"The file's type: `application/pdf`, or the image's."},"pageCount":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"outputBytes":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"durationMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"timing":{"type":"object","properties":{"preparationMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"renderMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"totalMs":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["preparationMs","renderMs","totalMs"],"additionalProperties":false,"title":"RenderTiming"},"engine":{"type":"object","properties":{"name":{"type":"string","enum":["typefold"]},"version":{"type":"string","pattern":"^\\d+\\.\\d+\\.\\d+(?:-[a-zA-Z0-9.-]+)?(?:\\+[a-zA-Z0-9.-]+)?$"},"buildId":{"type":"string","pattern":"^sha256:[a-f0-9]{64}$"}},"required":["name","version","buildId"],"additionalProperties":false,"title":"RenderEngine"},"conformance":{"type":"array","items":{"type":"object","properties":{"standard":{"type":"string"},"conforms":{"type":"boolean"},"issues":{"type":"array","items":{"type":"string"}}},"required":["standard","conforms"],"additionalProperties":false,"title":"PdfConformanceResult"}}},"required":["mediaType","pageCount","outputBytes","durationMs"],"additionalProperties":false,"title":"RenderResult"}},"required":["id","test","createdAt","updatedAt","state","result"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"templateVersionId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"test":{"type":"boolean","description":"Whether this is a free test render, whose PDF or image carries a diagonal \"TEST\" watermark. See [test renders](/guides/rendering/#test-renders)."},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"state":{"type":"string","enum":["failed"]},"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"stage":{"type":"string","enum":["load_request","validate_request","load_assets","prepare","render","validate_output","store_output","persist_result"]},"diagnostics":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["html_invalid","assets_invalid","max_input_bytes","asset_id_invalid","asset_bytes_invalid","asset_checksum_mismatch","asset_media_type_unsupported","stylesheet_utf8_invalid","document_invalid","asset_manifest_mismatch","limit_invalid","options_invalid","font_invalid","font_glyphs_missing","image_invalid","renderer_version_unavailable","renderer_closed","engine_failure","render_process_exited","render_memory_limit","pdf_magic_missing","pdf_page_count_missing","max_output_bytes","max_pages","pdfa_validation_failed","watermark_text_unsupported","pdf_postprocess_failed","image_page_missing","image_too_large","destination_upload_failed"]},"message":{"type":"string"},"path":{"type":"string","pattern":"^\\/(?:document(?:\\/(?:html|node|css|assetIds)(?:\\/\\d{1,6})?)?|assets(?:\\/\\d{1,6}\\/(?:id|bytes|sha256|mediaType))?|limits\\/(?:maxInputBytes|maxOutputBytes|maxPages)|options)$"}},"required":["code","message"],"additionalProperties":false,"title":"RenderDiagnostic"}},"engine":{"type":"object","properties":{"name":{"type":"string","enum":["typefold"]},"version":{"type":"string","pattern":"^\\d+\\.\\d+\\.\\d+(?:-[a-zA-Z0-9.-]+)?(?:\\+[a-zA-Z0-9.-]+)?$"},"buildId":{"type":"string","pattern":"^sha256:[a-f0-9]{64}$"}},"required":["name","version","buildId"],"additionalProperties":false,"title":"RenderEngine"}},"required":["code","message","retryable"],"additionalProperties":false,"title":"RenderError"}},"required":["id","test","createdAt","updatedAt","state","error"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"templateVersionId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"test":{"type":"boolean","description":"Whether this is a free test render, whose PDF or image carries a diagonal \"TEST\" watermark. See [test renders](/guides/rendering/#test-renders)."},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"state":{"type":"string","enum":["cancelled"]}},"required":["id","test","createdAt","updatedAt","state"],"additionalProperties":false}],"title":"Render"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/renders/{id}/cancel":{"post":{"operationId":"cancelRender","summary":"Cancel a render","tags":["Renders"],"description":"Cancels a queued or processing render. Needs `render:cancel`.","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"state":{"type":"string","enum":["cancelled"]}},"required":["id","state"],"additionalProperties":false,"title":"RenderCancelled"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/signing-certificates":{"post":{"operationId":"createSigningCertificate","summary":"Upload a signing certificate","tags":["Signing certificates"],"description":"A `.p12` or `.pfx` file of at most 64 KiB, base64-encoded; at most 50 per workspace. Its key can never be downloaded again. Needs `certificate:manage`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"pkcs12Base64":{"type":"string","maxLength":87384,"format":"byte","pattern":"^$|^(?:[0-9a-zA-Z+/]{4})*(?:(?:[0-9a-zA-Z+/]{2}==)|(?:[0-9a-zA-Z+/]{3}=))?$"},"password":{"type":"string","maxLength":1000}},"required":["name","pkcs12Base64","password"],"additionalProperties":false,"title":"CreateSigningCertificateBody"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string","minLength":1,"maxLength":120},"subject":{"type":"string"},"issuer":{"type":"string"},"serialNumber":{"type":"string"},"fingerprint":{"type":"string"},"keyType":{"type":"string","enum":["rsa","ec"]},"notBefore":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"notAfter":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["id","name","subject","issuer","serialNumber","fingerprint","keyType","notBefore","notAfter","createdAt"],"additionalProperties":false,"title":"SigningCertificate"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}},"get":{"operationId":"listSigningCertificates","summary":"List signing certificates","tags":["Signing certificates"],"description":"Without their keys. Needs `template:read`.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string","minLength":1,"maxLength":120},"subject":{"type":"string"},"issuer":{"type":"string"},"serialNumber":{"type":"string"},"fingerprint":{"type":"string"},"keyType":{"type":"string","enum":["rsa","ec"]},"notBefore":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"notAfter":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["id","name","subject","issuer","serialNumber","fingerprint","keyType","notBefore","notAfter","createdAt"],"additionalProperties":false,"title":"SigningCertificate"}}},"required":["items"],"additionalProperties":false,"title":"SigningCertificateList"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/signing-certificates/{id}":{"get":{"operationId":"getSigningCertificate","summary":"Get a signing certificate","tags":["Signing certificates"],"description":"Its name, subject, issuer and validity. Needs `template:read`.","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string","minLength":1,"maxLength":120},"subject":{"type":"string"},"issuer":{"type":"string"},"serialNumber":{"type":"string"},"fingerprint":{"type":"string"},"keyType":{"type":"string","enum":["rsa","ec"]},"notBefore":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"notAfter":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["id","name","subject","issuer","serialNumber","fingerprint","keyType","notBefore","notAfter","createdAt"],"additionalProperties":false,"title":"SigningCertificate"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}},"delete":{"operationId":"deleteSigningCertificate","summary":"Delete a signing certificate","tags":["Signing certificates"],"description":"Templates that name it stop rendering. Needs `certificate:manage`.","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"deleted":{"type":"boolean","enum":[true]}},"required":["id","deleted"],"additionalProperties":false,"title":"SigningCertificateDeleted"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/storage-destinations":{"post":{"operationId":"createStorageDestination","summary":"Add a storage destination","tags":["Storage destinations"],"description":"Saving uploads a small test object and deletes it again, and fails with the reason when the upload does. At most 10 per workspace. The secret access key can never be read back.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"endpoint":{"type":"string","maxLength":2048,"format":"uri","description":"The service's S3 endpoint, such as `https://<account>.r2.cloudflarestorage.com`. Omit it for Amazon S3."},"region":{"default":"us-east-1","type":"string","pattern":"^[a-z0-9-]{1,64}$","description":"The bucket's region; `auto` for Cloudflare R2."},"bucket":{"type":"string","pattern":"^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$"},"prefix":{"type":"string","minLength":1,"maxLength":512,"description":"Prepended to every render's path, such as `invoices`."},"forcePathStyle":{"default":false,"type":"boolean","description":"Address the bucket in the URL's path instead of its host name, as some self-hosted services need."},"accessKeyId":{"type":"string","minLength":1,"maxLength":256},"secretAccessKey":{"type":"string","minLength":1,"maxLength":1024,"description":"Stored encrypted and never returned."}},"required":["name","bucket","accessKeyId","secretAccessKey"],"additionalProperties":false,"title":"CreateStorageDestinationBody"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string","minLength":1,"maxLength":120},"endpoint":{"type":"string"},"region":{"type":"string"},"bucket":{"type":"string"},"prefix":{"type":"string"},"forcePathStyle":{"type":"boolean"},"accessKeyId":{"type":"string"},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["id","name","region","bucket","forcePathStyle","accessKeyId","createdAt","updatedAt"],"additionalProperties":false,"title":"StorageDestination"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}},"get":{"operationId":"listStorageDestinations","summary":"List storage destinations","tags":["Storage destinations"],"description":"Without their secret access keys.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string","minLength":1,"maxLength":120},"endpoint":{"type":"string"},"region":{"type":"string"},"bucket":{"type":"string"},"prefix":{"type":"string"},"forcePathStyle":{"type":"boolean"},"accessKeyId":{"type":"string"},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["id","name","region","bucket","forcePathStyle","accessKeyId","createdAt","updatedAt"],"additionalProperties":false,"title":"StorageDestination"}}},"required":["items"],"additionalProperties":false,"title":"StorageDestinationList"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/storage-destinations/{id}":{"get":{"operationId":"getStorageDestination","summary":"Get a storage destination","tags":["Storage destinations"],"parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string","minLength":1,"maxLength":120},"endpoint":{"type":"string"},"region":{"type":"string"},"bucket":{"type":"string"},"prefix":{"type":"string"},"forcePathStyle":{"type":"boolean"},"accessKeyId":{"type":"string"},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["id","name","region","bucket","forcePathStyle","accessKeyId","createdAt","updatedAt"],"additionalProperties":false,"title":"StorageDestination"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}},"patch":{"operationId":"updateStorageDestination","summary":"Change a storage destination","tags":["Storage destinations"],"description":"Omitted fields keep their values, including the keys. Any change but a new name runs the test upload again. Changing the endpoint, region, bucket or path style needs the secret access key again.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"endpoint":{"anyOf":[{"type":"string","maxLength":2048,"format":"uri","description":"The service's S3 endpoint, such as `https://<account>.r2.cloudflarestorage.com`. Omit it for Amazon S3."},{"type":"null"}]},"region":{"type":"string","pattern":"^[a-z0-9-]{1,64}$","description":"The bucket's region; `auto` for Cloudflare R2."},"bucket":{"type":"string","pattern":"^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$"},"prefix":{"anyOf":[{"type":"string","minLength":1,"maxLength":512,"description":"Prepended to every render's path."},{"type":"null"}]},"forcePathStyle":{"type":"boolean","description":"Address the bucket in the URL's path instead of its host name, as some self-hosted services need."},"accessKeyId":{"type":"string","minLength":1,"maxLength":256},"secretAccessKey":{"type":"string","minLength":1,"maxLength":1024,"description":"Stored encrypted and never returned."}},"additionalProperties":false,"title":"UpdateStorageDestinationBody"}}}},"parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string","minLength":1,"maxLength":120},"endpoint":{"type":"string"},"region":{"type":"string"},"bucket":{"type":"string"},"prefix":{"type":"string"},"forcePathStyle":{"type":"boolean"},"accessKeyId":{"type":"string"},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["id","name","region","bucket","forcePathStyle","accessKeyId","createdAt","updatedAt"],"additionalProperties":false,"title":"StorageDestination"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}},"delete":{"operationId":"deleteStorageDestination","summary":"Delete a storage destination","tags":["Storage destinations"],"description":"Queued renders that name it fail.","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"deleted":{"type":"boolean","enum":[true]}},"required":["id","deleted"],"additionalProperties":false,"title":"StorageDestinationDeleted"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/templates":{"post":{"operationId":"createTemplate","summary":"Create a template","tags":["Templates"],"description":"Needs `template:write`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"folderId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]},"name":{"type":"string","minLength":1,"maxLength":120},"description":{"type":"string","maxLength":2000},"content":{"type":"object","properties":{"composition":{"type":"object","properties":{"root":{"anyOf":[{"$ref":"#/components/schemas/CompositionNode"},{"type":"object","properties":{"type":{"type":"string","enum":["html"]},"html":{"type":"string","minLength":1,"maxLength":2000000},"helpers":{"type":"string","maxLength":500000}},"required":["type","html"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["sheets"]},"sheets":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":31,"pattern":"^[^[\\]*?:/\\\\]+$"},"sections":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"title":{"anyOf":[{"type":"string","maxLength":200},{"type":"object","propertyNames":{"type":"string","pattern":"^(?:default|[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3})$"},"additionalProperties":{"type":"string","maxLength":200}}]},"source":{"type":"string","maxLength":200,"pattern":"^[A-Za-z_$][\\w$]*(?:\\.(?:[A-Za-z_$][\\w$]*|0|[1-9]\\d*))*$"},"columns":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"header":{"anyOf":[{"type":"string","maxLength":200},{"type":"object","propertyNames":{"type":"string","pattern":"^(?:default|[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3})$"},"additionalProperties":{"type":"string","maxLength":200}}]},"value":{"type":"string","maxLength":200,"pattern":"^[A-Za-z_$][\\w$]*(?:\\.(?:[A-Za-z_$][\\w$]*|0|[1-9]\\d*))*$"},"format":{"type":"string","enum":["text","number","decimal","date"]},"width":{"type":"number","minimum":5,"maximum":100}},"required":["header","value","format"],"additionalProperties":false}}},"required":["source","columns"],"additionalProperties":false}}},"required":["name","sections"],"additionalProperties":false}}},"required":["type","sheets"],"additionalProperties":false}]},"header":{"type":"string","maxLength":100000},"footer":{"type":"string","maxLength":100000},"components":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"additionalProperties":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"root":{"$ref":"#/components/schemas/CompositionNode"},"source":{"type":"object","properties":{"templateId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"componentId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["templateId","componentId","revision"],"additionalProperties":false}},"required":["name","root"],"additionalProperties":false}},"stylesheets":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":255}}},"required":["root"],"additionalProperties":false,"title":"DraftComposition"},"scripts":{"maxItems":10,"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},"sampleDataFile":{"type":"string","minLength":1,"maxLength":255},"workbook":{"type":"string","minLength":1,"maxLength":255},"settings":{"type":"object","properties":{"pageSize":{"type":"object","properties":{"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["widthMm","heightMm"],"additionalProperties":false},"orientation":{"default":"portrait","type":"string","enum":["portrait","landscape"]},"margins":{"type":"object","properties":{"topMm":{"type":"number","minimum":0,"maximum":500},"rightMm":{"type":"number","minimum":0,"maximum":500},"bottomMm":{"type":"number","minimum":0,"maximum":500},"leftMm":{"type":"number","minimum":0,"maximum":500}},"required":["topMm","rightMm","bottomMm","leftMm"],"additionalProperties":false},"locale":{"default":"en-US","type":"string","minLength":2,"maxLength":64},"pageRanges":{"type":"string","maxLength":200},"metadata":{"type":"object","properties":{"title":{"type":"string","maxLength":500},"author":{"type":"string","maxLength":200},"subject":{"type":"string","maxLength":1000},"creator":{"type":"string","maxLength":200},"producer":{"type":"string","maxLength":200},"language":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","pattern":"^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3}$"}]},"keywords":{"maxItems":32,"type":"array","items":{"type":"string","maxLength":100}},"xmp":{"maxItems":4,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"prefix":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"namespace":{"type":"string","minLength":1,"maxLength":500,"pattern":"^[a-z][\\w+.-]*:\\S+$"},"properties":{"minItems":1,"maxItems":32,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"value":{"type":"string","maxLength":1000},"description":{"type":"string","minLength":1,"maxLength":1000}},"required":["name","value","description"],"additionalProperties":false}}},"required":["name","prefix","namespace","properties"],"additionalProperties":false,"title":"XmpSchema"}}},"additionalProperties":false,"title":"PdfMetadata"},"encryption":{"type":"object","properties":{"openPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"ownerPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"permissions":{"type":"object","properties":{"printing":{"type":"string","enum":["none","lowResolution","highResolution"]},"modifying":{"type":"boolean"},"copying":{"type":"boolean"},"annotating":{"type":"boolean"},"fillingForms":{"type":"boolean"},"contentAccessibility":{"type":"boolean"},"documentAssembly":{"type":"boolean"}},"additionalProperties":false,"title":"PdfPermissions"}},"additionalProperties":false,"title":"PdfEncryption"},"signature":{"type":"object","properties":{"certificate":{"type":"string","maxLength":120},"reason":{"type":"string","maxLength":200},"location":{"type":"string","maxLength":200},"contactInfo":{"type":"string","maxLength":200},"field":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"maximum":100000},"xMm":{"type":"number","minimum":0,"maximum":2000},"yMm":{"type":"number","minimum":0,"maximum":2000},"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["xMm","yMm","widthMm","heightMm"],"additionalProperties":false,"title":"PdfSignatureField"}},"required":["certificate"],"additionalProperties":false,"title":"PdfSignature"},"operations":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["append","prepend","merge"]},"template":{"type":"string","minLength":1,"maxLength":120},"pdf":{"type":"string","minLength":1,"maxLength":255},"mergeWholeDocument":{"type":"boolean"},"mergeToFront":{"type":"boolean"},"renderForEveryPage":{"type":"boolean"}},"required":["type"],"additionalProperties":false,"title":"PdfOperation"}},"pdfa":{"type":"string","enum":["4","2b","2u","2a","3b","3u","3a","4f"],"title":"PdfaLevel"},"pdfua":{"type":"string","enum":["1","2"],"title":"PdfuaPart"},"opaqueFills":{"type":"boolean"},"preferCssPageSize":{"type":"boolean"}},"required":["pageSize","margins"],"additionalProperties":false,"title":"TemplateSettings"},"contentFields":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_]{0,63}$","title":"ContentFieldKey"},"label":{"type":"string","minLength":1,"maxLength":120},"type":{"type":"string","enum":["text","richText","image","colour","toggle","choice","number","date"]},"group":{"type":"string","minLength":1,"maxLength":80},"help":{"type":"string","maxLength":500},"multiline":{"type":"boolean"},"maxLength":{"type":"integer","minimum":1,"maximum":65536},"options":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}}},"required":["key","label","type"],"additionalProperties":false,"title":"ContentField"},"title":"ContentFields"},"contentValues":{"type":"object","propertyNames":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_]{0,63}$","title":"ContentFieldKey"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":65536},{"type":"number"},{"type":"boolean"}],"title":"ContentValue"},"title":"ContentValues"}},"required":["composition","settings"],"additionalProperties":false,"title":"TemplateDraftContent"}},"required":["name","content"],"additionalProperties":false,"title":"CreateTemplateBody"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"folderId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]},"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string","minLength":1},"description":{"type":"string"},"draftRevision":{"type":"integer","exclusiveMinimum":0,"maximum":2147483647},"publishedVersionId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"publishedRevision":{"type":"integer","exclusiveMinimum":0,"maximum":2147483647},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["id","name","draftRevision","createdAt","updatedAt"],"additionalProperties":false,"title":"Template"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}},"get":{"operationId":"listTemplates","summary":"List templates","tags":["Templates"],"description":"Filter with `search`, `status` and `content`, which lists only templates with [content fields](/templates/content-fields/). Needs `template:read`.","parameters":[{"schema":{"type":"string"},"in":"query","name":"limit","required":false},{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"query","name":"cursor","required":false},{"schema":{"type":"string","maxLength":120},"in":"query","name":"search","required":false},{"schema":{"type":"string","enum":["draft","published"]},"in":"query","name":"status","required":false},{"schema":{"type":"string","enum":["true","false"]},"in":"query","name":"content","required":false}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"folderId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]},"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string","minLength":1},"description":{"type":"string"},"draftRevision":{"type":"integer","exclusiveMinimum":0,"maximum":2147483647},"publishedVersionId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"publishedRevision":{"type":"integer","exclusiveMinimum":0,"maximum":2147483647},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["id","name","draftRevision","createdAt","updatedAt"],"additionalProperties":false,"title":"Template"}},"nextCursor":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"}},"required":["items"],"additionalProperties":false,"title":"TemplateList"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}},"delete":{"operationId":"deleteTemplates","summary":"Delete up to 100 templates","tags":["Templates"],"description":"Needs `template:write`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"}}},"required":["ids"],"additionalProperties":false,"title":"DeleteTemplatesBody"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"}},"deleted":{"type":"boolean","enum":[true]}},"required":["ids","deleted"],"additionalProperties":false,"title":"DeleteTemplatesResponse"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/templates/{id}":{"get":{"operationId":"getTemplate","summary":"Get a template","tags":["Templates"],"description":"Needs `template:read`.","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"folderId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]},"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string","minLength":1},"description":{"type":"string"},"draftRevision":{"type":"integer","exclusiveMinimum":0,"maximum":2147483647},"publishedVersionId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"publishedRevision":{"type":"integer","exclusiveMinimum":0,"maximum":2147483647},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["id","name","draftRevision","createdAt","updatedAt"],"additionalProperties":false,"title":"Template"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}},"patch":{"operationId":"updateTemplate","summary":"Rename a template or move it to another folder","tags":["Templates"],"description":"Needs `template:write`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"folderId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]}},"additionalProperties":false,"title":"UpdateWorkspaceTemplateBody"}}}},"parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"folderId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]},"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string","minLength":1},"description":{"type":"string"},"draftRevision":{"type":"integer","exclusiveMinimum":0,"maximum":2147483647},"publishedVersionId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"publishedRevision":{"type":"integer","exclusiveMinimum":0,"maximum":2147483647},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["id","name","draftRevision","createdAt","updatedAt"],"additionalProperties":false,"title":"Template"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/templates/{id}/draft":{"get":{"operationId":"getTemplateDraft","summary":"Get a template's draft","tags":["Templates"],"description":"Needs `template:read`.","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"templateId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":2147483647},"content":{"type":"object","properties":{"composition":{"type":"object","properties":{"root":{"anyOf":[{"$ref":"#/components/schemas/CompositionNode"},{"type":"object","properties":{"type":{"type":"string","enum":["html"]},"html":{"type":"string","minLength":1,"maxLength":2000000},"helpers":{"type":"string","maxLength":500000}},"required":["type","html"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["sheets"]},"sheets":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":31,"pattern":"^[^[\\]*?:/\\\\]+$"},"sections":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"title":{"anyOf":[{"type":"string","maxLength":200},{"type":"object","propertyNames":{"type":"string","pattern":"^(?:default|[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3})$"},"additionalProperties":{"type":"string","maxLength":200}}]},"source":{"type":"string","maxLength":200,"pattern":"^[A-Za-z_$][\\w$]*(?:\\.(?:[A-Za-z_$][\\w$]*|0|[1-9]\\d*))*$"},"columns":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"header":{"anyOf":[{"type":"string","maxLength":200},{"type":"object","propertyNames":{"type":"string","pattern":"^(?:default|[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3})$"},"additionalProperties":{"type":"string","maxLength":200}}]},"value":{"type":"string","maxLength":200,"pattern":"^[A-Za-z_$][\\w$]*(?:\\.(?:[A-Za-z_$][\\w$]*|0|[1-9]\\d*))*$"},"format":{"type":"string","enum":["text","number","decimal","date"]},"width":{"type":"number","minimum":5,"maximum":100}},"required":["header","value","format"],"additionalProperties":false}}},"required":["source","columns"],"additionalProperties":false}}},"required":["name","sections"],"additionalProperties":false}}},"required":["type","sheets"],"additionalProperties":false}]},"header":{"type":"string","maxLength":100000},"footer":{"type":"string","maxLength":100000},"components":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"additionalProperties":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"root":{"$ref":"#/components/schemas/CompositionNode"},"source":{"type":"object","properties":{"templateId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"componentId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["templateId","componentId","revision"],"additionalProperties":false}},"required":["name","root"],"additionalProperties":false}},"stylesheets":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":255}}},"required":["root"],"additionalProperties":false,"title":"DraftComposition"},"scripts":{"maxItems":10,"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},"sampleDataFile":{"type":"string","minLength":1,"maxLength":255},"workbook":{"type":"string","minLength":1,"maxLength":255},"settings":{"type":"object","properties":{"pageSize":{"type":"object","properties":{"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["widthMm","heightMm"],"additionalProperties":false},"orientation":{"default":"portrait","type":"string","enum":["portrait","landscape"]},"margins":{"type":"object","properties":{"topMm":{"type":"number","minimum":0,"maximum":500},"rightMm":{"type":"number","minimum":0,"maximum":500},"bottomMm":{"type":"number","minimum":0,"maximum":500},"leftMm":{"type":"number","minimum":0,"maximum":500}},"required":["topMm","rightMm","bottomMm","leftMm"],"additionalProperties":false},"locale":{"default":"en-US","type":"string","minLength":2,"maxLength":64},"pageRanges":{"type":"string","maxLength":200},"metadata":{"type":"object","properties":{"title":{"type":"string","maxLength":500},"author":{"type":"string","maxLength":200},"subject":{"type":"string","maxLength":1000},"creator":{"type":"string","maxLength":200},"producer":{"type":"string","maxLength":200},"language":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","pattern":"^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3}$"}]},"keywords":{"maxItems":32,"type":"array","items":{"type":"string","maxLength":100}},"xmp":{"maxItems":4,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"prefix":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"namespace":{"type":"string","minLength":1,"maxLength":500,"pattern":"^[a-z][\\w+.-]*:\\S+$"},"properties":{"minItems":1,"maxItems":32,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"value":{"type":"string","maxLength":1000},"description":{"type":"string","minLength":1,"maxLength":1000}},"required":["name","value","description"],"additionalProperties":false}}},"required":["name","prefix","namespace","properties"],"additionalProperties":false,"title":"XmpSchema"}}},"additionalProperties":false,"title":"PdfMetadata"},"encryption":{"type":"object","properties":{"openPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"ownerPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"permissions":{"type":"object","properties":{"printing":{"type":"string","enum":["none","lowResolution","highResolution"]},"modifying":{"type":"boolean"},"copying":{"type":"boolean"},"annotating":{"type":"boolean"},"fillingForms":{"type":"boolean"},"contentAccessibility":{"type":"boolean"},"documentAssembly":{"type":"boolean"}},"additionalProperties":false,"title":"PdfPermissions"}},"additionalProperties":false,"title":"PdfEncryption"},"signature":{"type":"object","properties":{"certificate":{"type":"string","maxLength":120},"reason":{"type":"string","maxLength":200},"location":{"type":"string","maxLength":200},"contactInfo":{"type":"string","maxLength":200},"field":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"maximum":100000},"xMm":{"type":"number","minimum":0,"maximum":2000},"yMm":{"type":"number","minimum":0,"maximum":2000},"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["xMm","yMm","widthMm","heightMm"],"additionalProperties":false,"title":"PdfSignatureField"}},"required":["certificate"],"additionalProperties":false,"title":"PdfSignature"},"operations":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["append","prepend","merge"]},"template":{"type":"string","minLength":1,"maxLength":120},"pdf":{"type":"string","minLength":1,"maxLength":255},"mergeWholeDocument":{"type":"boolean"},"mergeToFront":{"type":"boolean"},"renderForEveryPage":{"type":"boolean"}},"required":["type"],"additionalProperties":false,"title":"PdfOperation"}},"pdfa":{"type":"string","enum":["4","2b","2u","2a","3b","3u","3a","4f"],"title":"PdfaLevel"},"pdfua":{"type":"string","enum":["1","2"],"title":"PdfuaPart"},"opaqueFills":{"type":"boolean"},"preferCssPageSize":{"type":"boolean"}},"required":["pageSize","margins"],"additionalProperties":false,"title":"TemplateSettings"},"contentFields":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_]{0,63}$","title":"ContentFieldKey"},"label":{"type":"string","minLength":1,"maxLength":120},"type":{"type":"string","enum":["text","richText","image","colour","toggle","choice","number","date"]},"group":{"type":"string","minLength":1,"maxLength":80},"help":{"type":"string","maxLength":500},"multiline":{"type":"boolean"},"maxLength":{"type":"integer","minimum":1,"maximum":65536},"options":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}}},"required":["key","label","type"],"additionalProperties":false,"title":"ContentField"},"title":"ContentFields"},"contentValues":{"type":"object","propertyNames":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_]{0,63}$","title":"ContentFieldKey"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":65536},{"type":"number"},{"type":"boolean"}],"title":"ContentValue"},"title":"ContentValues"}},"required":["composition","settings"],"additionalProperties":false,"title":"TemplateDraftContent"},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["templateId","revision","content","createdAt"],"additionalProperties":false,"title":"TemplateDraft"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}},"put":{"operationId":"saveTemplateDraft","summary":"Save a template's draft","tags":["Templates"],"description":"Refused when `expectedRevision` is not the draft's current revision. Needs `template:write`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"expectedRevision":{"type":"integer","exclusiveMinimum":0,"maximum":2147483647},"content":{"type":"object","properties":{"composition":{"type":"object","properties":{"root":{"anyOf":[{"$ref":"#/components/schemas/CompositionNode"},{"type":"object","properties":{"type":{"type":"string","enum":["html"]},"html":{"type":"string","minLength":1,"maxLength":2000000},"helpers":{"type":"string","maxLength":500000}},"required":["type","html"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["sheets"]},"sheets":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":31,"pattern":"^[^[\\]*?:/\\\\]+$"},"sections":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"title":{"anyOf":[{"type":"string","maxLength":200},{"type":"object","propertyNames":{"type":"string","pattern":"^(?:default|[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3})$"},"additionalProperties":{"type":"string","maxLength":200}}]},"source":{"type":"string","maxLength":200,"pattern":"^[A-Za-z_$][\\w$]*(?:\\.(?:[A-Za-z_$][\\w$]*|0|[1-9]\\d*))*$"},"columns":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"header":{"anyOf":[{"type":"string","maxLength":200},{"type":"object","propertyNames":{"type":"string","pattern":"^(?:default|[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3})$"},"additionalProperties":{"type":"string","maxLength":200}}]},"value":{"type":"string","maxLength":200,"pattern":"^[A-Za-z_$][\\w$]*(?:\\.(?:[A-Za-z_$][\\w$]*|0|[1-9]\\d*))*$"},"format":{"type":"string","enum":["text","number","decimal","date"]},"width":{"type":"number","minimum":5,"maximum":100}},"required":["header","value","format"],"additionalProperties":false}}},"required":["source","columns"],"additionalProperties":false}}},"required":["name","sections"],"additionalProperties":false}}},"required":["type","sheets"],"additionalProperties":false}]},"header":{"type":"string","maxLength":100000},"footer":{"type":"string","maxLength":100000},"components":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"additionalProperties":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"root":{"$ref":"#/components/schemas/CompositionNode"},"source":{"type":"object","properties":{"templateId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"componentId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["templateId","componentId","revision"],"additionalProperties":false}},"required":["name","root"],"additionalProperties":false}},"stylesheets":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":255}}},"required":["root"],"additionalProperties":false,"title":"DraftComposition"},"scripts":{"maxItems":10,"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},"sampleDataFile":{"type":"string","minLength":1,"maxLength":255},"workbook":{"type":"string","minLength":1,"maxLength":255},"settings":{"type":"object","properties":{"pageSize":{"type":"object","properties":{"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["widthMm","heightMm"],"additionalProperties":false},"orientation":{"default":"portrait","type":"string","enum":["portrait","landscape"]},"margins":{"type":"object","properties":{"topMm":{"type":"number","minimum":0,"maximum":500},"rightMm":{"type":"number","minimum":0,"maximum":500},"bottomMm":{"type":"number","minimum":0,"maximum":500},"leftMm":{"type":"number","minimum":0,"maximum":500}},"required":["topMm","rightMm","bottomMm","leftMm"],"additionalProperties":false},"locale":{"default":"en-US","type":"string","minLength":2,"maxLength":64},"pageRanges":{"type":"string","maxLength":200},"metadata":{"type":"object","properties":{"title":{"type":"string","maxLength":500},"author":{"type":"string","maxLength":200},"subject":{"type":"string","maxLength":1000},"creator":{"type":"string","maxLength":200},"producer":{"type":"string","maxLength":200},"language":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","pattern":"^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3}$"}]},"keywords":{"maxItems":32,"type":"array","items":{"type":"string","maxLength":100}},"xmp":{"maxItems":4,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"prefix":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"namespace":{"type":"string","minLength":1,"maxLength":500,"pattern":"^[a-z][\\w+.-]*:\\S+$"},"properties":{"minItems":1,"maxItems":32,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"value":{"type":"string","maxLength":1000},"description":{"type":"string","minLength":1,"maxLength":1000}},"required":["name","value","description"],"additionalProperties":false}}},"required":["name","prefix","namespace","properties"],"additionalProperties":false,"title":"XmpSchema"}}},"additionalProperties":false,"title":"PdfMetadata"},"encryption":{"type":"object","properties":{"openPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"ownerPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"permissions":{"type":"object","properties":{"printing":{"type":"string","enum":["none","lowResolution","highResolution"]},"modifying":{"type":"boolean"},"copying":{"type":"boolean"},"annotating":{"type":"boolean"},"fillingForms":{"type":"boolean"},"contentAccessibility":{"type":"boolean"},"documentAssembly":{"type":"boolean"}},"additionalProperties":false,"title":"PdfPermissions"}},"additionalProperties":false,"title":"PdfEncryption"},"signature":{"type":"object","properties":{"certificate":{"type":"string","maxLength":120},"reason":{"type":"string","maxLength":200},"location":{"type":"string","maxLength":200},"contactInfo":{"type":"string","maxLength":200},"field":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"maximum":100000},"xMm":{"type":"number","minimum":0,"maximum":2000},"yMm":{"type":"number","minimum":0,"maximum":2000},"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["xMm","yMm","widthMm","heightMm"],"additionalProperties":false,"title":"PdfSignatureField"}},"required":["certificate"],"additionalProperties":false,"title":"PdfSignature"},"operations":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["append","prepend","merge"]},"template":{"type":"string","minLength":1,"maxLength":120},"pdf":{"type":"string","minLength":1,"maxLength":255},"mergeWholeDocument":{"type":"boolean"},"mergeToFront":{"type":"boolean"},"renderForEveryPage":{"type":"boolean"}},"required":["type"],"additionalProperties":false,"title":"PdfOperation"}},"pdfa":{"type":"string","enum":["4","2b","2u","2a","3b","3u","3a","4f"],"title":"PdfaLevel"},"pdfua":{"type":"string","enum":["1","2"],"title":"PdfuaPart"},"opaqueFills":{"type":"boolean"},"preferCssPageSize":{"type":"boolean"}},"required":["pageSize","margins"],"additionalProperties":false,"title":"TemplateSettings"},"contentFields":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_]{0,63}$","title":"ContentFieldKey"},"label":{"type":"string","minLength":1,"maxLength":120},"type":{"type":"string","enum":["text","richText","image","colour","toggle","choice","number","date"]},"group":{"type":"string","minLength":1,"maxLength":80},"help":{"type":"string","maxLength":500},"multiline":{"type":"boolean"},"maxLength":{"type":"integer","minimum":1,"maximum":65536},"options":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}}},"required":["key","label","type"],"additionalProperties":false,"title":"ContentField"},"title":"ContentFields"},"contentValues":{"type":"object","propertyNames":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_]{0,63}$","title":"ContentFieldKey"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":65536},{"type":"number"},{"type":"boolean"}],"title":"ContentValue"},"title":"ContentValues"}},"required":["composition","settings"],"additionalProperties":false,"title":"TemplateDraftContent"}},"required":["expectedRevision","content"],"additionalProperties":false,"title":"SaveTemplateDraftBody"}}}},"parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"templateId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":2147483647},"content":{"type":"object","properties":{"composition":{"type":"object","properties":{"root":{"anyOf":[{"$ref":"#/components/schemas/CompositionNode"},{"type":"object","properties":{"type":{"type":"string","enum":["html"]},"html":{"type":"string","minLength":1,"maxLength":2000000},"helpers":{"type":"string","maxLength":500000}},"required":["type","html"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["sheets"]},"sheets":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":31,"pattern":"^[^[\\]*?:/\\\\]+$"},"sections":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"title":{"anyOf":[{"type":"string","maxLength":200},{"type":"object","propertyNames":{"type":"string","pattern":"^(?:default|[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3})$"},"additionalProperties":{"type":"string","maxLength":200}}]},"source":{"type":"string","maxLength":200,"pattern":"^[A-Za-z_$][\\w$]*(?:\\.(?:[A-Za-z_$][\\w$]*|0|[1-9]\\d*))*$"},"columns":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"header":{"anyOf":[{"type":"string","maxLength":200},{"type":"object","propertyNames":{"type":"string","pattern":"^(?:default|[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3})$"},"additionalProperties":{"type":"string","maxLength":200}}]},"value":{"type":"string","maxLength":200,"pattern":"^[A-Za-z_$][\\w$]*(?:\\.(?:[A-Za-z_$][\\w$]*|0|[1-9]\\d*))*$"},"format":{"type":"string","enum":["text","number","decimal","date"]},"width":{"type":"number","minimum":5,"maximum":100}},"required":["header","value","format"],"additionalProperties":false}}},"required":["source","columns"],"additionalProperties":false}}},"required":["name","sections"],"additionalProperties":false}}},"required":["type","sheets"],"additionalProperties":false}]},"header":{"type":"string","maxLength":100000},"footer":{"type":"string","maxLength":100000},"components":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"additionalProperties":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"root":{"$ref":"#/components/schemas/CompositionNode"},"source":{"type":"object","properties":{"templateId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"componentId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["templateId","componentId","revision"],"additionalProperties":false}},"required":["name","root"],"additionalProperties":false}},"stylesheets":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":255}}},"required":["root"],"additionalProperties":false,"title":"DraftComposition"},"scripts":{"maxItems":10,"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},"sampleDataFile":{"type":"string","minLength":1,"maxLength":255},"workbook":{"type":"string","minLength":1,"maxLength":255},"settings":{"type":"object","properties":{"pageSize":{"type":"object","properties":{"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["widthMm","heightMm"],"additionalProperties":false},"orientation":{"default":"portrait","type":"string","enum":["portrait","landscape"]},"margins":{"type":"object","properties":{"topMm":{"type":"number","minimum":0,"maximum":500},"rightMm":{"type":"number","minimum":0,"maximum":500},"bottomMm":{"type":"number","minimum":0,"maximum":500},"leftMm":{"type":"number","minimum":0,"maximum":500}},"required":["topMm","rightMm","bottomMm","leftMm"],"additionalProperties":false},"locale":{"default":"en-US","type":"string","minLength":2,"maxLength":64},"pageRanges":{"type":"string","maxLength":200},"metadata":{"type":"object","properties":{"title":{"type":"string","maxLength":500},"author":{"type":"string","maxLength":200},"subject":{"type":"string","maxLength":1000},"creator":{"type":"string","maxLength":200},"producer":{"type":"string","maxLength":200},"language":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","pattern":"^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3}$"}]},"keywords":{"maxItems":32,"type":"array","items":{"type":"string","maxLength":100}},"xmp":{"maxItems":4,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"prefix":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"namespace":{"type":"string","minLength":1,"maxLength":500,"pattern":"^[a-z][\\w+.-]*:\\S+$"},"properties":{"minItems":1,"maxItems":32,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"value":{"type":"string","maxLength":1000},"description":{"type":"string","minLength":1,"maxLength":1000}},"required":["name","value","description"],"additionalProperties":false}}},"required":["name","prefix","namespace","properties"],"additionalProperties":false,"title":"XmpSchema"}}},"additionalProperties":false,"title":"PdfMetadata"},"encryption":{"type":"object","properties":{"openPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"ownerPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"permissions":{"type":"object","properties":{"printing":{"type":"string","enum":["none","lowResolution","highResolution"]},"modifying":{"type":"boolean"},"copying":{"type":"boolean"},"annotating":{"type":"boolean"},"fillingForms":{"type":"boolean"},"contentAccessibility":{"type":"boolean"},"documentAssembly":{"type":"boolean"}},"additionalProperties":false,"title":"PdfPermissions"}},"additionalProperties":false,"title":"PdfEncryption"},"signature":{"type":"object","properties":{"certificate":{"type":"string","maxLength":120},"reason":{"type":"string","maxLength":200},"location":{"type":"string","maxLength":200},"contactInfo":{"type":"string","maxLength":200},"field":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"maximum":100000},"xMm":{"type":"number","minimum":0,"maximum":2000},"yMm":{"type":"number","minimum":0,"maximum":2000},"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["xMm","yMm","widthMm","heightMm"],"additionalProperties":false,"title":"PdfSignatureField"}},"required":["certificate"],"additionalProperties":false,"title":"PdfSignature"},"operations":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["append","prepend","merge"]},"template":{"type":"string","minLength":1,"maxLength":120},"pdf":{"type":"string","minLength":1,"maxLength":255},"mergeWholeDocument":{"type":"boolean"},"mergeToFront":{"type":"boolean"},"renderForEveryPage":{"type":"boolean"}},"required":["type"],"additionalProperties":false,"title":"PdfOperation"}},"pdfa":{"type":"string","enum":["4","2b","2u","2a","3b","3u","3a","4f"],"title":"PdfaLevel"},"pdfua":{"type":"string","enum":["1","2"],"title":"PdfuaPart"},"opaqueFills":{"type":"boolean"},"preferCssPageSize":{"type":"boolean"}},"required":["pageSize","margins"],"additionalProperties":false,"title":"TemplateSettings"},"contentFields":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_]{0,63}$","title":"ContentFieldKey"},"label":{"type":"string","minLength":1,"maxLength":120},"type":{"type":"string","enum":["text","richText","image","colour","toggle","choice","number","date"]},"group":{"type":"string","minLength":1,"maxLength":80},"help":{"type":"string","maxLength":500},"multiline":{"type":"boolean"},"maxLength":{"type":"integer","minimum":1,"maximum":65536},"options":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}}},"required":["key","label","type"],"additionalProperties":false,"title":"ContentField"},"title":"ContentFields"},"contentValues":{"type":"object","propertyNames":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_]{0,63}$","title":"ContentFieldKey"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":65536},{"type":"number"},{"type":"boolean"}],"title":"ContentValue"},"title":"ContentValues"}},"required":["composition","settings"],"additionalProperties":false,"title":"TemplateDraftContent"},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["templateId","revision","content","createdAt"],"additionalProperties":false,"title":"TemplateDraft"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/templates/{id}/content":{"put":{"operationId":"saveTemplateContent","summary":"Change the values of a template's content fields","tags":["Templates"],"description":"Stores the latest draft again with these [content field](/templates/content-fields/) values; the template's code and other settings stay as they are. With `expectedRevision`, refused when the draft has changed since. Needs `template:content`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"expectedRevision":{"type":"integer","exclusiveMinimum":0,"maximum":2147483647},"values":{"type":"object","propertyNames":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_]{0,63}$","title":"ContentFieldKey"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":65536},{"type":"number"},{"type":"boolean"}],"title":"ContentValue"},"title":"ContentValues"}},"required":["values"],"additionalProperties":false,"title":"SaveTemplateContentBody"}}}},"parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"templateId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":2147483647},"content":{"type":"object","properties":{"composition":{"type":"object","properties":{"root":{"anyOf":[{"$ref":"#/components/schemas/CompositionNode"},{"type":"object","properties":{"type":{"type":"string","enum":["html"]},"html":{"type":"string","minLength":1,"maxLength":2000000},"helpers":{"type":"string","maxLength":500000}},"required":["type","html"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["sheets"]},"sheets":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":31,"pattern":"^[^[\\]*?:/\\\\]+$"},"sections":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"title":{"anyOf":[{"type":"string","maxLength":200},{"type":"object","propertyNames":{"type":"string","pattern":"^(?:default|[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3})$"},"additionalProperties":{"type":"string","maxLength":200}}]},"source":{"type":"string","maxLength":200,"pattern":"^[A-Za-z_$][\\w$]*(?:\\.(?:[A-Za-z_$][\\w$]*|0|[1-9]\\d*))*$"},"columns":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"header":{"anyOf":[{"type":"string","maxLength":200},{"type":"object","propertyNames":{"type":"string","pattern":"^(?:default|[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3})$"},"additionalProperties":{"type":"string","maxLength":200}}]},"value":{"type":"string","maxLength":200,"pattern":"^[A-Za-z_$][\\w$]*(?:\\.(?:[A-Za-z_$][\\w$]*|0|[1-9]\\d*))*$"},"format":{"type":"string","enum":["text","number","decimal","date"]},"width":{"type":"number","minimum":5,"maximum":100}},"required":["header","value","format"],"additionalProperties":false}}},"required":["source","columns"],"additionalProperties":false}}},"required":["name","sections"],"additionalProperties":false}}},"required":["type","sheets"],"additionalProperties":false}]},"header":{"type":"string","maxLength":100000},"footer":{"type":"string","maxLength":100000},"components":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"additionalProperties":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"root":{"$ref":"#/components/schemas/CompositionNode"},"source":{"type":"object","properties":{"templateId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"componentId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["templateId","componentId","revision"],"additionalProperties":false}},"required":["name","root"],"additionalProperties":false}},"stylesheets":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":255}}},"required":["root"],"additionalProperties":false,"title":"DraftComposition"},"scripts":{"maxItems":10,"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},"sampleDataFile":{"type":"string","minLength":1,"maxLength":255},"workbook":{"type":"string","minLength":1,"maxLength":255},"settings":{"type":"object","properties":{"pageSize":{"type":"object","properties":{"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["widthMm","heightMm"],"additionalProperties":false},"orientation":{"default":"portrait","type":"string","enum":["portrait","landscape"]},"margins":{"type":"object","properties":{"topMm":{"type":"number","minimum":0,"maximum":500},"rightMm":{"type":"number","minimum":0,"maximum":500},"bottomMm":{"type":"number","minimum":0,"maximum":500},"leftMm":{"type":"number","minimum":0,"maximum":500}},"required":["topMm","rightMm","bottomMm","leftMm"],"additionalProperties":false},"locale":{"default":"en-US","type":"string","minLength":2,"maxLength":64},"pageRanges":{"type":"string","maxLength":200},"metadata":{"type":"object","properties":{"title":{"type":"string","maxLength":500},"author":{"type":"string","maxLength":200},"subject":{"type":"string","maxLength":1000},"creator":{"type":"string","maxLength":200},"producer":{"type":"string","maxLength":200},"language":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","pattern":"^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3}$"}]},"keywords":{"maxItems":32,"type":"array","items":{"type":"string","maxLength":100}},"xmp":{"maxItems":4,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"prefix":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"namespace":{"type":"string","minLength":1,"maxLength":500,"pattern":"^[a-z][\\w+.-]*:\\S+$"},"properties":{"minItems":1,"maxItems":32,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"value":{"type":"string","maxLength":1000},"description":{"type":"string","minLength":1,"maxLength":1000}},"required":["name","value","description"],"additionalProperties":false}}},"required":["name","prefix","namespace","properties"],"additionalProperties":false,"title":"XmpSchema"}}},"additionalProperties":false,"title":"PdfMetadata"},"encryption":{"type":"object","properties":{"openPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"ownerPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"permissions":{"type":"object","properties":{"printing":{"type":"string","enum":["none","lowResolution","highResolution"]},"modifying":{"type":"boolean"},"copying":{"type":"boolean"},"annotating":{"type":"boolean"},"fillingForms":{"type":"boolean"},"contentAccessibility":{"type":"boolean"},"documentAssembly":{"type":"boolean"}},"additionalProperties":false,"title":"PdfPermissions"}},"additionalProperties":false,"title":"PdfEncryption"},"signature":{"type":"object","properties":{"certificate":{"type":"string","maxLength":120},"reason":{"type":"string","maxLength":200},"location":{"type":"string","maxLength":200},"contactInfo":{"type":"string","maxLength":200},"field":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"maximum":100000},"xMm":{"type":"number","minimum":0,"maximum":2000},"yMm":{"type":"number","minimum":0,"maximum":2000},"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["xMm","yMm","widthMm","heightMm"],"additionalProperties":false,"title":"PdfSignatureField"}},"required":["certificate"],"additionalProperties":false,"title":"PdfSignature"},"operations":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["append","prepend","merge"]},"template":{"type":"string","minLength":1,"maxLength":120},"pdf":{"type":"string","minLength":1,"maxLength":255},"mergeWholeDocument":{"type":"boolean"},"mergeToFront":{"type":"boolean"},"renderForEveryPage":{"type":"boolean"}},"required":["type"],"additionalProperties":false,"title":"PdfOperation"}},"pdfa":{"type":"string","enum":["4","2b","2u","2a","3b","3u","3a","4f"],"title":"PdfaLevel"},"pdfua":{"type":"string","enum":["1","2"],"title":"PdfuaPart"},"opaqueFills":{"type":"boolean"},"preferCssPageSize":{"type":"boolean"}},"required":["pageSize","margins"],"additionalProperties":false,"title":"TemplateSettings"},"contentFields":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_]{0,63}$","title":"ContentFieldKey"},"label":{"type":"string","minLength":1,"maxLength":120},"type":{"type":"string","enum":["text","richText","image","colour","toggle","choice","number","date"]},"group":{"type":"string","minLength":1,"maxLength":80},"help":{"type":"string","maxLength":500},"multiline":{"type":"boolean"},"maxLength":{"type":"integer","minimum":1,"maximum":65536},"options":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}}},"required":["key","label","type"],"additionalProperties":false,"title":"ContentField"},"title":"ContentFields"},"contentValues":{"type":"object","propertyNames":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_]{0,63}$","title":"ContentFieldKey"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":65536},{"type":"number"},{"type":"boolean"}],"title":"ContentValue"},"title":"ContentValues"}},"required":["composition","settings"],"additionalProperties":false,"title":"TemplateDraftContent"},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["templateId","revision","content","createdAt"],"additionalProperties":false,"title":"TemplateDraft"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/templates/{id}/revisions":{"get":{"operationId":"listTemplateRevisions","summary":"List a draft's saved revisions","tags":["Templates"],"description":"Needs `template:read`.","parameters":[{"schema":{"type":"string"},"in":"query","name":"limit","required":false},{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"query","name":"cursor","required":false},{"schema":{"type":"string","enum":["asc","desc"]},"in":"query","name":"order","required":false},{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"templateId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":2147483647},"content":{"type":"object","properties":{"composition":{"type":"object","properties":{"root":{"anyOf":[{"$ref":"#/components/schemas/CompositionNode"},{"type":"object","properties":{"type":{"type":"string","enum":["html"]},"html":{"type":"string","minLength":1,"maxLength":2000000},"helpers":{"type":"string","maxLength":500000}},"required":["type","html"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["sheets"]},"sheets":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":31,"pattern":"^[^[\\]*?:/\\\\]+$"},"sections":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"title":{"anyOf":[{"type":"string","maxLength":200},{"type":"object","propertyNames":{"type":"string","pattern":"^(?:default|[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3})$"},"additionalProperties":{"type":"string","maxLength":200}}]},"source":{"type":"string","maxLength":200,"pattern":"^[A-Za-z_$][\\w$]*(?:\\.(?:[A-Za-z_$][\\w$]*|0|[1-9]\\d*))*$"},"columns":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"header":{"anyOf":[{"type":"string","maxLength":200},{"type":"object","propertyNames":{"type":"string","pattern":"^(?:default|[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3})$"},"additionalProperties":{"type":"string","maxLength":200}}]},"value":{"type":"string","maxLength":200,"pattern":"^[A-Za-z_$][\\w$]*(?:\\.(?:[A-Za-z_$][\\w$]*|0|[1-9]\\d*))*$"},"format":{"type":"string","enum":["text","number","decimal","date"]},"width":{"type":"number","minimum":5,"maximum":100}},"required":["header","value","format"],"additionalProperties":false}}},"required":["source","columns"],"additionalProperties":false}}},"required":["name","sections"],"additionalProperties":false}}},"required":["type","sheets"],"additionalProperties":false}]},"header":{"type":"string","maxLength":100000},"footer":{"type":"string","maxLength":100000},"components":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"additionalProperties":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"root":{"$ref":"#/components/schemas/CompositionNode"},"source":{"type":"object","properties":{"templateId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"componentId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["templateId","componentId","revision"],"additionalProperties":false}},"required":["name","root"],"additionalProperties":false}},"stylesheets":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":255}}},"required":["root"],"additionalProperties":false,"title":"DraftComposition"},"scripts":{"maxItems":10,"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},"sampleDataFile":{"type":"string","minLength":1,"maxLength":255},"workbook":{"type":"string","minLength":1,"maxLength":255},"settings":{"type":"object","properties":{"pageSize":{"type":"object","properties":{"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["widthMm","heightMm"],"additionalProperties":false},"orientation":{"default":"portrait","type":"string","enum":["portrait","landscape"]},"margins":{"type":"object","properties":{"topMm":{"type":"number","minimum":0,"maximum":500},"rightMm":{"type":"number","minimum":0,"maximum":500},"bottomMm":{"type":"number","minimum":0,"maximum":500},"leftMm":{"type":"number","minimum":0,"maximum":500}},"required":["topMm","rightMm","bottomMm","leftMm"],"additionalProperties":false},"locale":{"default":"en-US","type":"string","minLength":2,"maxLength":64},"pageRanges":{"type":"string","maxLength":200},"metadata":{"type":"object","properties":{"title":{"type":"string","maxLength":500},"author":{"type":"string","maxLength":200},"subject":{"type":"string","maxLength":1000},"creator":{"type":"string","maxLength":200},"producer":{"type":"string","maxLength":200},"language":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","pattern":"^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3}$"}]},"keywords":{"maxItems":32,"type":"array","items":{"type":"string","maxLength":100}},"xmp":{"maxItems":4,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"prefix":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"namespace":{"type":"string","minLength":1,"maxLength":500,"pattern":"^[a-z][\\w+.-]*:\\S+$"},"properties":{"minItems":1,"maxItems":32,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"value":{"type":"string","maxLength":1000},"description":{"type":"string","minLength":1,"maxLength":1000}},"required":["name","value","description"],"additionalProperties":false}}},"required":["name","prefix","namespace","properties"],"additionalProperties":false,"title":"XmpSchema"}}},"additionalProperties":false,"title":"PdfMetadata"},"encryption":{"type":"object","properties":{"openPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"ownerPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"permissions":{"type":"object","properties":{"printing":{"type":"string","enum":["none","lowResolution","highResolution"]},"modifying":{"type":"boolean"},"copying":{"type":"boolean"},"annotating":{"type":"boolean"},"fillingForms":{"type":"boolean"},"contentAccessibility":{"type":"boolean"},"documentAssembly":{"type":"boolean"}},"additionalProperties":false,"title":"PdfPermissions"}},"additionalProperties":false,"title":"PdfEncryption"},"signature":{"type":"object","properties":{"certificate":{"type":"string","maxLength":120},"reason":{"type":"string","maxLength":200},"location":{"type":"string","maxLength":200},"contactInfo":{"type":"string","maxLength":200},"field":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"maximum":100000},"xMm":{"type":"number","minimum":0,"maximum":2000},"yMm":{"type":"number","minimum":0,"maximum":2000},"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["xMm","yMm","widthMm","heightMm"],"additionalProperties":false,"title":"PdfSignatureField"}},"required":["certificate"],"additionalProperties":false,"title":"PdfSignature"},"operations":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["append","prepend","merge"]},"template":{"type":"string","minLength":1,"maxLength":120},"pdf":{"type":"string","minLength":1,"maxLength":255},"mergeWholeDocument":{"type":"boolean"},"mergeToFront":{"type":"boolean"},"renderForEveryPage":{"type":"boolean"}},"required":["type"],"additionalProperties":false,"title":"PdfOperation"}},"pdfa":{"type":"string","enum":["4","2b","2u","2a","3b","3u","3a","4f"],"title":"PdfaLevel"},"pdfua":{"type":"string","enum":["1","2"],"title":"PdfuaPart"},"opaqueFills":{"type":"boolean"},"preferCssPageSize":{"type":"boolean"}},"required":["pageSize","margins"],"additionalProperties":false,"title":"TemplateSettings"},"contentFields":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_]{0,63}$","title":"ContentFieldKey"},"label":{"type":"string","minLength":1,"maxLength":120},"type":{"type":"string","enum":["text","richText","image","colour","toggle","choice","number","date"]},"group":{"type":"string","minLength":1,"maxLength":80},"help":{"type":"string","maxLength":500},"multiline":{"type":"boolean"},"maxLength":{"type":"integer","minimum":1,"maximum":65536},"options":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}}},"required":["key","label","type"],"additionalProperties":false,"title":"ContentField"},"title":"ContentFields"},"contentValues":{"type":"object","propertyNames":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_]{0,63}$","title":"ContentFieldKey"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":65536},{"type":"number"},{"type":"boolean"}],"title":"ContentValue"},"title":"ContentValues"}},"required":["composition","settings"],"additionalProperties":false,"title":"TemplateDraftContent"},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["templateId","revision","content","createdAt"],"additionalProperties":false,"title":"TemplateDraft"}},"nextCursor":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"}},"required":["items"],"additionalProperties":false,"title":"TemplateRevisionList"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/templates/{id}/revisions/{revision}":{"get":{"operationId":"getTemplateRevision","summary":"Get one draft revision","tags":["Templates"],"description":"Needs `template:read`.","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"revision","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"templateId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":2147483647},"content":{"type":"object","properties":{"composition":{"type":"object","properties":{"root":{"anyOf":[{"$ref":"#/components/schemas/CompositionNode"},{"type":"object","properties":{"type":{"type":"string","enum":["html"]},"html":{"type":"string","minLength":1,"maxLength":2000000},"helpers":{"type":"string","maxLength":500000}},"required":["type","html"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["sheets"]},"sheets":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":31,"pattern":"^[^[\\]*?:/\\\\]+$"},"sections":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"title":{"anyOf":[{"type":"string","maxLength":200},{"type":"object","propertyNames":{"type":"string","pattern":"^(?:default|[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3})$"},"additionalProperties":{"type":"string","maxLength":200}}]},"source":{"type":"string","maxLength":200,"pattern":"^[A-Za-z_$][\\w$]*(?:\\.(?:[A-Za-z_$][\\w$]*|0|[1-9]\\d*))*$"},"columns":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"header":{"anyOf":[{"type":"string","maxLength":200},{"type":"object","propertyNames":{"type":"string","pattern":"^(?:default|[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3})$"},"additionalProperties":{"type":"string","maxLength":200}}]},"value":{"type":"string","maxLength":200,"pattern":"^[A-Za-z_$][\\w$]*(?:\\.(?:[A-Za-z_$][\\w$]*|0|[1-9]\\d*))*$"},"format":{"type":"string","enum":["text","number","decimal","date"]},"width":{"type":"number","minimum":5,"maximum":100}},"required":["header","value","format"],"additionalProperties":false}}},"required":["source","columns"],"additionalProperties":false}}},"required":["name","sections"],"additionalProperties":false}}},"required":["type","sheets"],"additionalProperties":false}]},"header":{"type":"string","maxLength":100000},"footer":{"type":"string","maxLength":100000},"components":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"additionalProperties":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"root":{"$ref":"#/components/schemas/CompositionNode"},"source":{"type":"object","properties":{"templateId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"componentId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["templateId","componentId","revision"],"additionalProperties":false}},"required":["name","root"],"additionalProperties":false}},"stylesheets":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":255}}},"required":["root"],"additionalProperties":false,"title":"DraftComposition"},"scripts":{"maxItems":10,"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},"sampleDataFile":{"type":"string","minLength":1,"maxLength":255},"workbook":{"type":"string","minLength":1,"maxLength":255},"settings":{"type":"object","properties":{"pageSize":{"type":"object","properties":{"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["widthMm","heightMm"],"additionalProperties":false},"orientation":{"default":"portrait","type":"string","enum":["portrait","landscape"]},"margins":{"type":"object","properties":{"topMm":{"type":"number","minimum":0,"maximum":500},"rightMm":{"type":"number","minimum":0,"maximum":500},"bottomMm":{"type":"number","minimum":0,"maximum":500},"leftMm":{"type":"number","minimum":0,"maximum":500}},"required":["topMm","rightMm","bottomMm","leftMm"],"additionalProperties":false},"locale":{"default":"en-US","type":"string","minLength":2,"maxLength":64},"pageRanges":{"type":"string","maxLength":200},"metadata":{"type":"object","properties":{"title":{"type":"string","maxLength":500},"author":{"type":"string","maxLength":200},"subject":{"type":"string","maxLength":1000},"creator":{"type":"string","maxLength":200},"producer":{"type":"string","maxLength":200},"language":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","pattern":"^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3}$"}]},"keywords":{"maxItems":32,"type":"array","items":{"type":"string","maxLength":100}},"xmp":{"maxItems":4,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"prefix":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"namespace":{"type":"string","minLength":1,"maxLength":500,"pattern":"^[a-z][\\w+.-]*:\\S+$"},"properties":{"minItems":1,"maxItems":32,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"value":{"type":"string","maxLength":1000},"description":{"type":"string","minLength":1,"maxLength":1000}},"required":["name","value","description"],"additionalProperties":false}}},"required":["name","prefix","namespace","properties"],"additionalProperties":false,"title":"XmpSchema"}}},"additionalProperties":false,"title":"PdfMetadata"},"encryption":{"type":"object","properties":{"openPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"ownerPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"permissions":{"type":"object","properties":{"printing":{"type":"string","enum":["none","lowResolution","highResolution"]},"modifying":{"type":"boolean"},"copying":{"type":"boolean"},"annotating":{"type":"boolean"},"fillingForms":{"type":"boolean"},"contentAccessibility":{"type":"boolean"},"documentAssembly":{"type":"boolean"}},"additionalProperties":false,"title":"PdfPermissions"}},"additionalProperties":false,"title":"PdfEncryption"},"signature":{"type":"object","properties":{"certificate":{"type":"string","maxLength":120},"reason":{"type":"string","maxLength":200},"location":{"type":"string","maxLength":200},"contactInfo":{"type":"string","maxLength":200},"field":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"maximum":100000},"xMm":{"type":"number","minimum":0,"maximum":2000},"yMm":{"type":"number","minimum":0,"maximum":2000},"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["xMm","yMm","widthMm","heightMm"],"additionalProperties":false,"title":"PdfSignatureField"}},"required":["certificate"],"additionalProperties":false,"title":"PdfSignature"},"operations":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["append","prepend","merge"]},"template":{"type":"string","minLength":1,"maxLength":120},"pdf":{"type":"string","minLength":1,"maxLength":255},"mergeWholeDocument":{"type":"boolean"},"mergeToFront":{"type":"boolean"},"renderForEveryPage":{"type":"boolean"}},"required":["type"],"additionalProperties":false,"title":"PdfOperation"}},"pdfa":{"type":"string","enum":["4","2b","2u","2a","3b","3u","3a","4f"],"title":"PdfaLevel"},"pdfua":{"type":"string","enum":["1","2"],"title":"PdfuaPart"},"opaqueFills":{"type":"boolean"},"preferCssPageSize":{"type":"boolean"}},"required":["pageSize","margins"],"additionalProperties":false,"title":"TemplateSettings"},"contentFields":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_]{0,63}$","title":"ContentFieldKey"},"label":{"type":"string","minLength":1,"maxLength":120},"type":{"type":"string","enum":["text","richText","image","colour","toggle","choice","number","date"]},"group":{"type":"string","minLength":1,"maxLength":80},"help":{"type":"string","maxLength":500},"multiline":{"type":"boolean"},"maxLength":{"type":"integer","minimum":1,"maximum":65536},"options":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}}},"required":["key","label","type"],"additionalProperties":false,"title":"ContentField"},"title":"ContentFields"},"contentValues":{"type":"object","propertyNames":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_]{0,63}$","title":"ContentFieldKey"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":65536},{"type":"number"},{"type":"boolean"}],"title":"ContentValue"},"title":"ContentValues"}},"required":["composition","settings"],"additionalProperties":false,"title":"TemplateDraftContent"},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["templateId","revision","content","createdAt"],"additionalProperties":false,"title":"TemplateDraft"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/templates/{id}/versions":{"post":{"operationId":"publishTemplateVersion","summary":"Publish a draft as a new version","tags":["Templates"],"description":"Publishes the draft at `expectedRevision`. Needs `template:publish`. Without `template:write`, only a draft whose content field values are all that changed since the published version can be published.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"expectedRevision":{"type":"integer","exclusiveMinimum":0,"maximum":2147483647}},"required":["expectedRevision"],"additionalProperties":false,"title":"CreateTemplateVersionBody"}}}},"parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"templateId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"number":{"type":"integer","exclusiveMinimum":0,"maximum":2147483647},"draftRevision":{"type":"integer","exclusiveMinimum":0,"maximum":2147483647},"content":{"type":"object","properties":{"composition":{"type":"object","properties":{"root":{"anyOf":[{"$ref":"#/components/schemas/CompositionNode"},{"type":"object","properties":{"type":{"type":"string","enum":["sheets"]},"sheets":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":31,"pattern":"^[^[\\]*?:/\\\\]+$"},"sections":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"title":{"anyOf":[{"type":"string","maxLength":200},{"type":"object","propertyNames":{"type":"string","pattern":"^(?:default|[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3})$"},"additionalProperties":{"type":"string","maxLength":200}}]},"source":{"type":"string","maxLength":200,"pattern":"^[A-Za-z_$][\\w$]*(?:\\.(?:[A-Za-z_$][\\w$]*|0|[1-9]\\d*))*$"},"columns":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"header":{"anyOf":[{"type":"string","maxLength":200},{"type":"object","propertyNames":{"type":"string","pattern":"^(?:default|[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3})$"},"additionalProperties":{"type":"string","maxLength":200}}]},"value":{"type":"string","maxLength":200,"pattern":"^[A-Za-z_$][\\w$]*(?:\\.(?:[A-Za-z_$][\\w$]*|0|[1-9]\\d*))*$"},"format":{"type":"string","enum":["text","number","decimal","date"]},"width":{"type":"number","minimum":5,"maximum":100}},"required":["header","value","format"],"additionalProperties":false}}},"required":["source","columns"],"additionalProperties":false}}},"required":["name","sections"],"additionalProperties":false}}},"required":["type","sheets"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["html"]},"html":{"type":"string","minLength":1,"maxLength":2000000},"helpers":{"type":"string","maxLength":500000},"scripts":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[^./\\\\\\s][^/\\\\]*$"},"source":{"type":"string","maxLength":100000}},"required":["name","source"],"additionalProperties":false}},"partials":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[A-Za-z0-9_-][A-Za-z0-9_./-]*$"},"additionalProperties":{"type":"string","maxLength":1000000}}},"required":["type","html"],"additionalProperties":false}]},"header":{"type":"string","maxLength":100000},"footer":{"type":"string","maxLength":100000},"components":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"additionalProperties":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"root":{"$ref":"#/components/schemas/CompositionNode"},"source":{"type":"object","properties":{"templateId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"componentId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["templateId","componentId","revision"],"additionalProperties":false}},"required":["name","root"],"additionalProperties":false}},"css":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","maxLength":1000000}},"fileNames":{"type":"object","propertyNames":{"type":"string","maxLength":140},"additionalProperties":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[^./\\\\\\s][^/\\\\]*$"}},"assetIds":{"default":[],"maxItems":500,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"}},"folders":{"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^./\\\\\\s][^/\\\\]*$"}},"assetPaths":{"type":"object","propertyNames":{"type":"string","maxLength":255,"pattern":"^[^\\\\]+$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"}}},"required":["root"],"additionalProperties":false,"title":"Composition"},"sampleData":{"$ref":"#/components/schemas/JsonValue"},"sampleDataSets":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string","minLength":1,"maxLength":80},"data":{"$ref":"#/components/schemas/JsonValue"}},"required":["id","name","data"],"additionalProperties":false}},"localizations":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string","minLength":1,"maxLength":80},"data":{"$ref":"#/components/schemas/JsonValue"}},"required":["id","name","data"],"additionalProperties":false}},"localizationId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"workbook":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"settings":{"type":"object","properties":{"pageSize":{"type":"object","properties":{"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["widthMm","heightMm"],"additionalProperties":false},"orientation":{"default":"portrait","type":"string","enum":["portrait","landscape"]},"margins":{"type":"object","properties":{"topMm":{"type":"number","minimum":0,"maximum":500},"rightMm":{"type":"number","minimum":0,"maximum":500},"bottomMm":{"type":"number","minimum":0,"maximum":500},"leftMm":{"type":"number","minimum":0,"maximum":500}},"required":["topMm","rightMm","bottomMm","leftMm"],"additionalProperties":false},"locale":{"default":"en-US","type":"string","minLength":2,"maxLength":64},"pageRanges":{"type":"string","maxLength":200},"metadata":{"type":"object","properties":{"title":{"type":"string","maxLength":500},"author":{"type":"string","maxLength":200},"subject":{"type":"string","maxLength":1000},"creator":{"type":"string","maxLength":200},"producer":{"type":"string","maxLength":200},"language":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","pattern":"^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3}$"}]},"keywords":{"maxItems":32,"type":"array","items":{"type":"string","maxLength":100}},"xmp":{"maxItems":4,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"prefix":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"namespace":{"type":"string","minLength":1,"maxLength":500,"pattern":"^[a-z][\\w+.-]*:\\S+$"},"properties":{"minItems":1,"maxItems":32,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"value":{"type":"string","maxLength":1000},"description":{"type":"string","minLength":1,"maxLength":1000}},"required":["name","value","description"],"additionalProperties":false}}},"required":["name","prefix","namespace","properties"],"additionalProperties":false,"title":"XmpSchema"}}},"additionalProperties":false,"title":"PdfMetadata"},"encryption":{"type":"object","properties":{"openPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"ownerPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"permissions":{"type":"object","properties":{"printing":{"type":"string","enum":["none","lowResolution","highResolution"]},"modifying":{"type":"boolean"},"copying":{"type":"boolean"},"annotating":{"type":"boolean"},"fillingForms":{"type":"boolean"},"contentAccessibility":{"type":"boolean"},"documentAssembly":{"type":"boolean"}},"additionalProperties":false,"title":"PdfPermissions"}},"additionalProperties":false,"title":"PdfEncryption"},"signature":{"type":"object","properties":{"certificate":{"type":"string","maxLength":120},"reason":{"type":"string","maxLength":200},"location":{"type":"string","maxLength":200},"contactInfo":{"type":"string","maxLength":200},"field":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"maximum":100000},"xMm":{"type":"number","minimum":0,"maximum":2000},"yMm":{"type":"number","minimum":0,"maximum":2000},"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["xMm","yMm","widthMm","heightMm"],"additionalProperties":false,"title":"PdfSignatureField"}},"required":["certificate"],"additionalProperties":false,"title":"PdfSignature"},"operations":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["append","prepend","merge"]},"template":{"type":"string","minLength":1,"maxLength":120},"pdf":{"type":"string","minLength":1,"maxLength":255},"mergeWholeDocument":{"type":"boolean"},"mergeToFront":{"type":"boolean"},"renderForEveryPage":{"type":"boolean"}},"required":["type"],"additionalProperties":false,"title":"PdfOperation"}},"pdfa":{"type":"string","enum":["4","2b","2u","2a","3b","3u","3a","4f"],"title":"PdfaLevel"},"pdfua":{"type":"string","enum":["1","2"],"title":"PdfuaPart"},"opaqueFills":{"type":"boolean"},"preferCssPageSize":{"type":"boolean"}},"required":["pageSize","margins"],"additionalProperties":false,"title":"TemplateSettings"},"contentFields":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_]{0,63}$","title":"ContentFieldKey"},"label":{"type":"string","minLength":1,"maxLength":120},"type":{"type":"string","enum":["text","richText","image","colour","toggle","choice","number","date"]},"group":{"type":"string","minLength":1,"maxLength":80},"help":{"type":"string","maxLength":500},"multiline":{"type":"boolean"},"maxLength":{"type":"integer","minimum":1,"maximum":65536},"options":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}}},"required":["key","label","type"],"additionalProperties":false,"title":"ContentField"},"title":"ContentFields"},"contentValues":{"type":"object","propertyNames":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_]{0,63}$","title":"ContentFieldKey"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":65536},{"type":"number"},{"type":"boolean"}],"title":"ContentValue"},"title":"ContentValues"}},"required":["composition","sampleData","settings"],"additionalProperties":false,"title":"TemplateVersionContent"},"componentCatalogVersion":{"type":"string","minLength":1},"rendererVersion":{"type":"string","minLength":1},"publishedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["id","templateId","number","draftRevision","content","componentCatalogVersion","rendererVersion","publishedAt"],"additionalProperties":false,"title":"TemplateVersion"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}},"get":{"operationId":"listTemplateVersions","summary":"List a template's published versions","tags":["Templates"],"description":"Needs `template:read`.","parameters":[{"schema":{"type":"string"},"in":"query","name":"limit","required":false},{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"query","name":"cursor","required":false},{"schema":{"type":"string","enum":["asc","desc"]},"in":"query","name":"order","required":false},{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"templateId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"number":{"type":"integer","exclusiveMinimum":0,"maximum":2147483647},"draftRevision":{"type":"integer","exclusiveMinimum":0,"maximum":2147483647},"content":{"type":"object","properties":{"composition":{"type":"object","properties":{"root":{"anyOf":[{"$ref":"#/components/schemas/CompositionNode"},{"type":"object","properties":{"type":{"type":"string","enum":["sheets"]},"sheets":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":31,"pattern":"^[^[\\]*?:/\\\\]+$"},"sections":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"title":{"anyOf":[{"type":"string","maxLength":200},{"type":"object","propertyNames":{"type":"string","pattern":"^(?:default|[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3})$"},"additionalProperties":{"type":"string","maxLength":200}}]},"source":{"type":"string","maxLength":200,"pattern":"^[A-Za-z_$][\\w$]*(?:\\.(?:[A-Za-z_$][\\w$]*|0|[1-9]\\d*))*$"},"columns":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"header":{"anyOf":[{"type":"string","maxLength":200},{"type":"object","propertyNames":{"type":"string","pattern":"^(?:default|[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3})$"},"additionalProperties":{"type":"string","maxLength":200}}]},"value":{"type":"string","maxLength":200,"pattern":"^[A-Za-z_$][\\w$]*(?:\\.(?:[A-Za-z_$][\\w$]*|0|[1-9]\\d*))*$"},"format":{"type":"string","enum":["text","number","decimal","date"]},"width":{"type":"number","minimum":5,"maximum":100}},"required":["header","value","format"],"additionalProperties":false}}},"required":["source","columns"],"additionalProperties":false}}},"required":["name","sections"],"additionalProperties":false}}},"required":["type","sheets"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["html"]},"html":{"type":"string","minLength":1,"maxLength":2000000},"helpers":{"type":"string","maxLength":500000},"scripts":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[^./\\\\\\s][^/\\\\]*$"},"source":{"type":"string","maxLength":100000}},"required":["name","source"],"additionalProperties":false}},"partials":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[A-Za-z0-9_-][A-Za-z0-9_./-]*$"},"additionalProperties":{"type":"string","maxLength":1000000}}},"required":["type","html"],"additionalProperties":false}]},"header":{"type":"string","maxLength":100000},"footer":{"type":"string","maxLength":100000},"components":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"additionalProperties":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"root":{"$ref":"#/components/schemas/CompositionNode"},"source":{"type":"object","properties":{"templateId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"componentId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["templateId","componentId","revision"],"additionalProperties":false}},"required":["name","root"],"additionalProperties":false}},"css":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","maxLength":1000000}},"fileNames":{"type":"object","propertyNames":{"type":"string","maxLength":140},"additionalProperties":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[^./\\\\\\s][^/\\\\]*$"}},"assetIds":{"default":[],"maxItems":500,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"}},"folders":{"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^./\\\\\\s][^/\\\\]*$"}},"assetPaths":{"type":"object","propertyNames":{"type":"string","maxLength":255,"pattern":"^[^\\\\]+$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"}}},"required":["root"],"additionalProperties":false,"title":"Composition"},"sampleData":{"$ref":"#/components/schemas/JsonValue"},"sampleDataSets":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string","minLength":1,"maxLength":80},"data":{"$ref":"#/components/schemas/JsonValue"}},"required":["id","name","data"],"additionalProperties":false}},"localizations":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string","minLength":1,"maxLength":80},"data":{"$ref":"#/components/schemas/JsonValue"}},"required":["id","name","data"],"additionalProperties":false}},"localizationId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"workbook":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"settings":{"type":"object","properties":{"pageSize":{"type":"object","properties":{"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["widthMm","heightMm"],"additionalProperties":false},"orientation":{"default":"portrait","type":"string","enum":["portrait","landscape"]},"margins":{"type":"object","properties":{"topMm":{"type":"number","minimum":0,"maximum":500},"rightMm":{"type":"number","minimum":0,"maximum":500},"bottomMm":{"type":"number","minimum":0,"maximum":500},"leftMm":{"type":"number","minimum":0,"maximum":500}},"required":["topMm","rightMm","bottomMm","leftMm"],"additionalProperties":false},"locale":{"default":"en-US","type":"string","minLength":2,"maxLength":64},"pageRanges":{"type":"string","maxLength":200},"metadata":{"type":"object","properties":{"title":{"type":"string","maxLength":500},"author":{"type":"string","maxLength":200},"subject":{"type":"string","maxLength":1000},"creator":{"type":"string","maxLength":200},"producer":{"type":"string","maxLength":200},"language":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","pattern":"^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3}$"}]},"keywords":{"maxItems":32,"type":"array","items":{"type":"string","maxLength":100}},"xmp":{"maxItems":4,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"prefix":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"namespace":{"type":"string","minLength":1,"maxLength":500,"pattern":"^[a-z][\\w+.-]*:\\S+$"},"properties":{"minItems":1,"maxItems":32,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"value":{"type":"string","maxLength":1000},"description":{"type":"string","minLength":1,"maxLength":1000}},"required":["name","value","description"],"additionalProperties":false}}},"required":["name","prefix","namespace","properties"],"additionalProperties":false,"title":"XmpSchema"}}},"additionalProperties":false,"title":"PdfMetadata"},"encryption":{"type":"object","properties":{"openPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"ownerPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"permissions":{"type":"object","properties":{"printing":{"type":"string","enum":["none","lowResolution","highResolution"]},"modifying":{"type":"boolean"},"copying":{"type":"boolean"},"annotating":{"type":"boolean"},"fillingForms":{"type":"boolean"},"contentAccessibility":{"type":"boolean"},"documentAssembly":{"type":"boolean"}},"additionalProperties":false,"title":"PdfPermissions"}},"additionalProperties":false,"title":"PdfEncryption"},"signature":{"type":"object","properties":{"certificate":{"type":"string","maxLength":120},"reason":{"type":"string","maxLength":200},"location":{"type":"string","maxLength":200},"contactInfo":{"type":"string","maxLength":200},"field":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"maximum":100000},"xMm":{"type":"number","minimum":0,"maximum":2000},"yMm":{"type":"number","minimum":0,"maximum":2000},"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["xMm","yMm","widthMm","heightMm"],"additionalProperties":false,"title":"PdfSignatureField"}},"required":["certificate"],"additionalProperties":false,"title":"PdfSignature"},"operations":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["append","prepend","merge"]},"template":{"type":"string","minLength":1,"maxLength":120},"pdf":{"type":"string","minLength":1,"maxLength":255},"mergeWholeDocument":{"type":"boolean"},"mergeToFront":{"type":"boolean"},"renderForEveryPage":{"type":"boolean"}},"required":["type"],"additionalProperties":false,"title":"PdfOperation"}},"pdfa":{"type":"string","enum":["4","2b","2u","2a","3b","3u","3a","4f"],"title":"PdfaLevel"},"pdfua":{"type":"string","enum":["1","2"],"title":"PdfuaPart"},"opaqueFills":{"type":"boolean"},"preferCssPageSize":{"type":"boolean"}},"required":["pageSize","margins"],"additionalProperties":false,"title":"TemplateSettings"},"contentFields":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_]{0,63}$","title":"ContentFieldKey"},"label":{"type":"string","minLength":1,"maxLength":120},"type":{"type":"string","enum":["text","richText","image","colour","toggle","choice","number","date"]},"group":{"type":"string","minLength":1,"maxLength":80},"help":{"type":"string","maxLength":500},"multiline":{"type":"boolean"},"maxLength":{"type":"integer","minimum":1,"maximum":65536},"options":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}}},"required":["key","label","type"],"additionalProperties":false,"title":"ContentField"},"title":"ContentFields"},"contentValues":{"type":"object","propertyNames":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_]{0,63}$","title":"ContentFieldKey"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":65536},{"type":"number"},{"type":"boolean"}],"title":"ContentValue"},"title":"ContentValues"}},"required":["composition","sampleData","settings"],"additionalProperties":false,"title":"TemplateVersionContent"},"componentCatalogVersion":{"type":"string","minLength":1},"rendererVersion":{"type":"string","minLength":1},"publishedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["id","templateId","number","draftRevision","content","componentCatalogVersion","rendererVersion","publishedAt"],"additionalProperties":false,"title":"TemplateVersion"}},"nextCursor":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"}},"required":["items"],"additionalProperties":false,"title":"TemplateVersionList"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/template-versions/{id}":{"get":{"operationId":"getTemplateVersion","summary":"Get one published version","tags":["Templates"],"description":"Needs `template:read`.","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"templateId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"number":{"type":"integer","exclusiveMinimum":0,"maximum":2147483647},"draftRevision":{"type":"integer","exclusiveMinimum":0,"maximum":2147483647},"content":{"type":"object","properties":{"composition":{"type":"object","properties":{"root":{"anyOf":[{"$ref":"#/components/schemas/CompositionNode"},{"type":"object","properties":{"type":{"type":"string","enum":["sheets"]},"sheets":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":31,"pattern":"^[^[\\]*?:/\\\\]+$"},"sections":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"title":{"anyOf":[{"type":"string","maxLength":200},{"type":"object","propertyNames":{"type":"string","pattern":"^(?:default|[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3})$"},"additionalProperties":{"type":"string","maxLength":200}}]},"source":{"type":"string","maxLength":200,"pattern":"^[A-Za-z_$][\\w$]*(?:\\.(?:[A-Za-z_$][\\w$]*|0|[1-9]\\d*))*$"},"columns":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"header":{"anyOf":[{"type":"string","maxLength":200},{"type":"object","propertyNames":{"type":"string","pattern":"^(?:default|[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3})$"},"additionalProperties":{"type":"string","maxLength":200}}]},"value":{"type":"string","maxLength":200,"pattern":"^[A-Za-z_$][\\w$]*(?:\\.(?:[A-Za-z_$][\\w$]*|0|[1-9]\\d*))*$"},"format":{"type":"string","enum":["text","number","decimal","date"]},"width":{"type":"number","minimum":5,"maximum":100}},"required":["header","value","format"],"additionalProperties":false}}},"required":["source","columns"],"additionalProperties":false}}},"required":["name","sections"],"additionalProperties":false}}},"required":["type","sheets"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["html"]},"html":{"type":"string","minLength":1,"maxLength":2000000},"helpers":{"type":"string","maxLength":500000},"scripts":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[^./\\\\\\s][^/\\\\]*$"},"source":{"type":"string","maxLength":100000}},"required":["name","source"],"additionalProperties":false}},"partials":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[A-Za-z0-9_-][A-Za-z0-9_./-]*$"},"additionalProperties":{"type":"string","maxLength":1000000}}},"required":["type","html"],"additionalProperties":false}]},"header":{"type":"string","maxLength":100000},"footer":{"type":"string","maxLength":100000},"components":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"additionalProperties":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"root":{"$ref":"#/components/schemas/CompositionNode"},"source":{"type":"object","properties":{"templateId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"componentId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["templateId","componentId","revision"],"additionalProperties":false}},"required":["name","root"],"additionalProperties":false}},"css":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","maxLength":1000000}},"fileNames":{"type":"object","propertyNames":{"type":"string","maxLength":140},"additionalProperties":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[^./\\\\\\s][^/\\\\]*$"}},"assetIds":{"default":[],"maxItems":500,"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"}},"folders":{"maxItems":100,"type":"array","items":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^./\\\\\\s][^/\\\\]*$"}},"assetPaths":{"type":"object","propertyNames":{"type":"string","maxLength":255,"pattern":"^[^\\\\]+$"},"additionalProperties":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"}}},"required":["root"],"additionalProperties":false,"title":"Composition"},"sampleData":{"$ref":"#/components/schemas/JsonValue"},"sampleDataSets":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string","minLength":1,"maxLength":80},"data":{"$ref":"#/components/schemas/JsonValue"}},"required":["id","name","data"],"additionalProperties":false}},"localizations":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string","minLength":1,"maxLength":80},"data":{"$ref":"#/components/schemas/JsonValue"}},"required":["id","name","data"],"additionalProperties":false}},"localizationId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"workbook":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"settings":{"type":"object","properties":{"pageSize":{"type":"object","properties":{"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["widthMm","heightMm"],"additionalProperties":false},"orientation":{"default":"portrait","type":"string","enum":["portrait","landscape"]},"margins":{"type":"object","properties":{"topMm":{"type":"number","minimum":0,"maximum":500},"rightMm":{"type":"number","minimum":0,"maximum":500},"bottomMm":{"type":"number","minimum":0,"maximum":500},"leftMm":{"type":"number","minimum":0,"maximum":500}},"required":["topMm","rightMm","bottomMm","leftMm"],"additionalProperties":false},"locale":{"default":"en-US","type":"string","minLength":2,"maxLength":64},"pageRanges":{"type":"string","maxLength":200},"metadata":{"type":"object","properties":{"title":{"type":"string","maxLength":500},"author":{"type":"string","maxLength":200},"subject":{"type":"string","maxLength":1000},"creator":{"type":"string","maxLength":200},"producer":{"type":"string","maxLength":200},"language":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","pattern":"^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3}$"}]},"keywords":{"maxItems":32,"type":"array","items":{"type":"string","maxLength":100}},"xmp":{"maxItems":4,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"prefix":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"namespace":{"type":"string","minLength":1,"maxLength":500,"pattern":"^[a-z][\\w+.-]*:\\S+$"},"properties":{"minItems":1,"maxItems":32,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"value":{"type":"string","maxLength":1000},"description":{"type":"string","minLength":1,"maxLength":1000}},"required":["name","value","description"],"additionalProperties":false}}},"required":["name","prefix","namespace","properties"],"additionalProperties":false,"title":"XmpSchema"}}},"additionalProperties":false,"title":"PdfMetadata"},"encryption":{"type":"object","properties":{"openPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"ownerPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"permissions":{"type":"object","properties":{"printing":{"type":"string","enum":["none","lowResolution","highResolution"]},"modifying":{"type":"boolean"},"copying":{"type":"boolean"},"annotating":{"type":"boolean"},"fillingForms":{"type":"boolean"},"contentAccessibility":{"type":"boolean"},"documentAssembly":{"type":"boolean"}},"additionalProperties":false,"title":"PdfPermissions"}},"additionalProperties":false,"title":"PdfEncryption"},"signature":{"type":"object","properties":{"certificate":{"type":"string","maxLength":120},"reason":{"type":"string","maxLength":200},"location":{"type":"string","maxLength":200},"contactInfo":{"type":"string","maxLength":200},"field":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"maximum":100000},"xMm":{"type":"number","minimum":0,"maximum":2000},"yMm":{"type":"number","minimum":0,"maximum":2000},"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["xMm","yMm","widthMm","heightMm"],"additionalProperties":false,"title":"PdfSignatureField"}},"required":["certificate"],"additionalProperties":false,"title":"PdfSignature"},"operations":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["append","prepend","merge"]},"template":{"type":"string","minLength":1,"maxLength":120},"pdf":{"type":"string","minLength":1,"maxLength":255},"mergeWholeDocument":{"type":"boolean"},"mergeToFront":{"type":"boolean"},"renderForEveryPage":{"type":"boolean"}},"required":["type"],"additionalProperties":false,"title":"PdfOperation"}},"pdfa":{"type":"string","enum":["4","2b","2u","2a","3b","3u","3a","4f"],"title":"PdfaLevel"},"pdfua":{"type":"string","enum":["1","2"],"title":"PdfuaPart"},"opaqueFills":{"type":"boolean"},"preferCssPageSize":{"type":"boolean"}},"required":["pageSize","margins"],"additionalProperties":false,"title":"TemplateSettings"},"contentFields":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_]{0,63}$","title":"ContentFieldKey"},"label":{"type":"string","minLength":1,"maxLength":120},"type":{"type":"string","enum":["text","richText","image","colour","toggle","choice","number","date"]},"group":{"type":"string","minLength":1,"maxLength":80},"help":{"type":"string","maxLength":500},"multiline":{"type":"boolean"},"maxLength":{"type":"integer","minimum":1,"maximum":65536},"options":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}}},"required":["key","label","type"],"additionalProperties":false,"title":"ContentField"},"title":"ContentFields"},"contentValues":{"type":"object","propertyNames":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_]{0,63}$","title":"ContentFieldKey"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":65536},{"type":"number"},{"type":"boolean"}],"title":"ContentValue"},"title":"ContentValues"}},"required":["composition","sampleData","settings"],"additionalProperties":false,"title":"TemplateVersionContent"},"componentCatalogVersion":{"type":"string","minLength":1},"rendererVersion":{"type":"string","minLength":1},"publishedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["id","templateId","number","draftRevision","content","componentCatalogVersion","rendererVersion","publishedAt"],"additionalProperties":false,"title":"TemplateVersion"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/usage":{"get":{"operationId":"getUsage","summary":"Get usage counters","tags":["Workspace administration"],"description":"Optionally between `from` and `to`. Needs `usage:read`.","parameters":[{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","title":"UsageDay"},"in":"query","name":"from","required":false},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","title":"UsageDay"},"in":"query","name":"to","required":false}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"from":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","title":"UsageDay"},"to":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","title":"UsageDay"},"totals":{"type":"object","properties":{"rendersSucceeded":{"type":"integer","minimum":0,"maximum":9007199254740991},"rendersFailed":{"type":"integer","minimum":0,"maximum":9007199254740991},"rendersCancelled":{"type":"integer","minimum":0,"maximum":9007199254740991},"pages":{"type":"integer","minimum":0,"maximum":9007199254740991},"outputBytes":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["rendersSucceeded","rendersFailed","rendersCancelled","pages","outputBytes"],"additionalProperties":false,"title":"UsageCounters"},"days":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","title":"UsageDay"},"rendersSucceeded":{"type":"integer","minimum":0,"maximum":9007199254740991},"rendersFailed":{"type":"integer","minimum":0,"maximum":9007199254740991},"rendersCancelled":{"type":"integer","minimum":0,"maximum":9007199254740991},"pages":{"type":"integer","minimum":0,"maximum":9007199254740991},"outputBytes":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["day","rendersSucceeded","rendersFailed","rendersCancelled","pages","outputBytes"],"additionalProperties":false,"title":"UsageDaily"}}},"required":["from","to","totals","days"],"additionalProperties":false,"title":"UsageReport"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/platform/usage":{"get":{"operationId":"listPlatformUsage","summary":"Get every workspace's usage","tags":["Platform administration"],"description":"Needs a platform administrator's Studio session.","parameters":[{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","title":"UsageDay"},"in":"query","name":"from","required":false},{"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","title":"UsageDay"},"in":"query","name":"to","required":false},{"schema":{"type":"string"},"in":"query","name":"limit","required":false},{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"query","name":"cursor","required":false}],"security":[{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"from":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","title":"UsageDay"},"to":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$","title":"UsageDay"},"items":{"type":"array","items":{"type":"object","properties":{"organizationId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string"},"slug":{"type":"string"},"rendersSucceeded":{"type":"integer","minimum":0,"maximum":9007199254740991},"rendersFailed":{"type":"integer","minimum":0,"maximum":9007199254740991},"rendersCancelled":{"type":"integer","minimum":0,"maximum":9007199254740991},"pages":{"type":"integer","minimum":0,"maximum":9007199254740991},"outputBytes":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["organizationId","name","slug","rendersSucceeded","rendersFailed","rendersCancelled","pages","outputBytes"],"additionalProperties":false,"title":"PlatformOrganizationUsage"}},"nextCursor":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"}},"required":["from","to","items"],"additionalProperties":false,"title":"PlatformUsageReport"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/platform-admins":{"get":{"operationId":"listPlatformAdmins","summary":"List platform administrators","tags":["Platform administration"],"description":"Needs a platform administrator's Studio session.","security":[{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string"},"email":{"type":"string"},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["userId","name","email","createdAt"],"additionalProperties":false,"title":"PlatformAdmin"}}},"required":["items"],"additionalProperties":false,"title":"PlatformAdminList"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}},"post":{"operationId":"grantPlatformAdmin","summary":"Grant platform access","tags":["Platform administration"],"description":"The person must already have an account. Needs a platform administrator's Studio session.","requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"userId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"}},"required":["userId"],"additionalProperties":false},{"type":"object","properties":{"email":{"type":"string","maxLength":254,"pattern":"^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$"}},"required":["email"],"additionalProperties":false}],"title":"GrantPlatformAdminBody"}}}},"security":[{"session":[]}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string"},"email":{"type":"string"},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["userId","name","email","createdAt"],"additionalProperties":false,"title":"PlatformAdmin"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/platform-admins/{id}":{"delete":{"operationId":"revokePlatformAdmin","summary":"Revoke platform access","tags":["Platform administration"],"description":"The last platform administrator cannot be revoked. Needs a platform administrator's Studio session.","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"security":[{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"revoked":{"type":"boolean","enum":[true]}},"required":["userId","revoked"],"additionalProperties":false,"title":"PlatformAdminRevoked"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/password-accounts":{"post":{"operationId":"setPassword","summary":"Set a generated password for a person","tags":["Platform administration"],"description":"Needs a platform administrator's Studio session.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","maxLength":254,"pattern":"^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$"}},"required":["email"],"additionalProperties":false,"title":"SetPasswordBody"}}}},"security":[{"session":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"email":{"type":"string"},"password":{"type":"string"}},"required":["userId","email","password"],"additionalProperties":false,"title":"PasswordAccount"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/webhook-endpoints":{"post":{"operationId":"createWebhookEndpoint","summary":"Register a webhook endpoint","tags":["Webhooks"],"description":"A workspace can have at most 10.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","maxLength":2048,"format":"uri"},"description":{"type":"string","minLength":1,"maxLength":256},"eventTypes":{"minItems":1,"maxItems":3,"type":"array","items":{"type":"string","enum":["render.succeeded","render.failed","render.cancelled"]}},"enabled":{"default":true,"type":"boolean"}},"required":["url","eventTypes"],"additionalProperties":false,"title":"CreateWebhookEndpointBody"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"url":{"type":"string","maxLength":2048,"format":"uri"},"description":{"type":"string","minLength":1,"maxLength":256},"eventTypes":{"type":"array","items":{"type":"string","enum":["render.succeeded","render.failed","render.cancelled"]}},"enabled":{"type":"boolean"},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"secret":{"type":"string","minLength":1}},"required":["id","url","eventTypes","enabled","createdAt","updatedAt","secret"],"additionalProperties":false,"title":"WebhookEndpointWithSecret"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}},"get":{"operationId":"listWebhookEndpoints","summary":"List webhook endpoints","tags":["Webhooks"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"url":{"type":"string","maxLength":2048,"format":"uri"},"description":{"type":"string","minLength":1,"maxLength":256},"eventTypes":{"type":"array","items":{"type":"string","enum":["render.succeeded","render.failed","render.cancelled"]}},"enabled":{"type":"boolean"},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["id","url","eventTypes","enabled","createdAt","updatedAt"],"additionalProperties":false,"title":"WebhookEndpoint"}}},"required":["items"],"additionalProperties":false,"title":"WebhookEndpointList"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/webhook-endpoints/{id}":{"get":{"operationId":"getWebhookEndpoint","summary":"Get a webhook endpoint","tags":["Webhooks"],"parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"url":{"type":"string","maxLength":2048,"format":"uri"},"description":{"type":"string","minLength":1,"maxLength":256},"eventTypes":{"type":"array","items":{"type":"string","enum":["render.succeeded","render.failed","render.cancelled"]}},"enabled":{"type":"boolean"},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["id","url","eventTypes","enabled","createdAt","updatedAt"],"additionalProperties":false,"title":"WebhookEndpoint"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}},"patch":{"operationId":"updateWebhookEndpoint","summary":"Change a webhook endpoint","tags":["Webhooks"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","maxLength":2048,"format":"uri"},"description":{"anyOf":[{"type":"string","minLength":1,"maxLength":256},{"type":"null"}]},"eventTypes":{"minItems":1,"maxItems":3,"type":"array","items":{"type":"string","enum":["render.succeeded","render.failed","render.cancelled"]}},"enabled":{"type":"boolean"}},"additionalProperties":false,"title":"UpdateWebhookEndpointBody"}}}},"parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"url":{"type":"string","maxLength":2048,"format":"uri"},"description":{"type":"string","minLength":1,"maxLength":256},"eventTypes":{"type":"array","items":{"type":"string","enum":["render.succeeded","render.failed","render.cancelled"]}},"enabled":{"type":"boolean"},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["id","url","eventTypes","enabled","createdAt","updatedAt"],"additionalProperties":false,"title":"WebhookEndpoint"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}},"delete":{"operationId":"deleteWebhookEndpoint","summary":"Delete a webhook endpoint","tags":["Webhooks"],"parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"deleted":{"type":"boolean","enum":[true]}},"required":["id","deleted"],"additionalProperties":false,"title":"WebhookEndpointDeleted"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/webhook-endpoints/{id}/rotate-secret":{"post":{"operationId":"rotateWebhookEndpointSecret","summary":"Replace an endpoint's signing secret","tags":["Webhooks"],"parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"url":{"type":"string","maxLength":2048,"format":"uri"},"description":{"type":"string","minLength":1,"maxLength":256},"eventTypes":{"type":"array","items":{"type":"string","enum":["render.succeeded","render.failed","render.cancelled"]}},"enabled":{"type":"boolean"},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"secret":{"type":"string","minLength":1}},"required":["id","url","eventTypes","enabled","createdAt","updatedAt","secret"],"additionalProperties":false,"title":"WebhookEndpointWithSecret"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/webhook-endpoints/{id}/deliveries":{"get":{"operationId":"listWebhookDeliveries","summary":"List an endpoint's delivery attempts","tags":["Webhooks"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"limit","required":false},{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"query","name":"cursor","required":false},{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"eventId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"eventType":{"type":"string","enum":["render.succeeded","render.failed","render.cancelled"]},"renderId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"status":{"type":"string","enum":["pending","succeeded","failed"]},"attempts":{"type":"integer","minimum":0,"maximum":9007199254740991},"lastStatusCode":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lastError":{"type":"string"},"lastAttemptAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"nextAttemptAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["id","eventId","eventType","renderId","status","attempts","createdAt"],"additionalProperties":false,"title":"WebhookDelivery"}},"nextCursor":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"}},"required":["items"],"additionalProperties":false,"title":"WebhookDeliveryList"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/workspace-folders/{id}/export":{"get":{"operationId":"exportWorkspaceFolder","summary":"Export a folder as a zip","tags":["Workspace files"],"description":"The same zip as Studio's **Export folder**, for importing on another installation. A folder with uploaded files also needs `asset:manage`.","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK"}}}},"/v1/workspace/export":{"get":{"operationId":"exportWorkspace","summary":"Export the whole workspace as a zip","tags":["Workspace files"],"description":"The same zip as Studio's **Export workspace**. A workspace with uploaded files also needs `asset:manage`.","responses":{"200":{"description":"OK"}}}},"/v1/workspace-folders/import":{"post":{"operationId":"importWorkspaceFolder","summary":"Import an exported folder or workspace","tags":["Workspace files"],"description":"Updates what already exists. Uploaded files also need `asset:manage`, and `publish: true` also needs `template:publish`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"archiveBase64":{"type":"string","maxLength":56000000,"pattern":"^[A-Za-z0-9+/]*={0,2}$"},"parentId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]},"publish":{"type":"boolean"},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["archiveBase64","parentId"],"additionalProperties":false,"title":"ImportWorkspaceFolderBody"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"folderId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]},"created":{"type":"object","properties":{"folders":{"type":"number"},"files":{"type":"number"},"templates":{"type":"number"}},"required":["folders","files","templates"],"additionalProperties":false},"updated":{"type":"object","properties":{"folders":{"type":"number"},"files":{"type":"number"},"templates":{"type":"number"}},"required":["folders","files","templates"],"additionalProperties":false},"unchanged":{"type":"object","properties":{"files":{"type":"number"},"templates":{"type":"number"}},"required":["files","templates"],"additionalProperties":false},"published":{"type":"number"},"unpublished":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"],"additionalProperties":false}}},"required":["folderId","created","updated","unchanged"],"additionalProperties":false,"title":"WorkspaceFolderImport"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/workspace-folders":{"get":{"operationId":"listWorkspaceFolders","summary":"List folders","tags":["Workspace files"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"limit","required":false},{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"query","name":"cursor","required":false}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^./\\\\\\s][^/\\\\]*$"},"parentId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["id","name","parentId","createdAt"],"additionalProperties":false,"title":"WorkspaceFolder"}},"nextCursor":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"}},"required":["items"],"additionalProperties":false,"title":"WorkspaceFolderList"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}},"post":{"operationId":"createWorkspaceFolder","summary":"Create a folder","tags":["Workspace files"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^./\\\\\\s][^/\\\\]*$"},"parentId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]}},"required":["name"],"additionalProperties":false,"title":"CreateWorkspaceFolderBody"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^./\\\\\\s][^/\\\\]*$"},"parentId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["id","name","parentId","createdAt"],"additionalProperties":false,"title":"WorkspaceFolder"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/workspace-folders/{id}":{"get":{"operationId":"getWorkspaceFolder","summary":"Get a folder","tags":["Workspace files"],"parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^./\\\\\\s][^/\\\\]*$"},"parentId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["id","name","parentId","createdAt"],"additionalProperties":false,"title":"WorkspaceFolder"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}},"patch":{"operationId":"updateWorkspaceFolder","summary":"Rename or move a folder","tags":["Workspace files"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^./\\\\\\s][^/\\\\]*$"},"parentId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]}},"additionalProperties":false,"title":"UpdateWorkspaceFolderBody"}}}},"parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^./\\\\\\s][^/\\\\]*$"},"parentId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["id","name","parentId","createdAt"],"additionalProperties":false,"title":"WorkspaceFolder"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}},"delete":{"operationId":"deleteWorkspaceFolder","summary":"Delete a folder","tags":["Workspace files"],"description":"Deletes an empty folder, or the folder and its contents with `recursive=true`.","parameters":[{"schema":{"default":"false","type":"string","enum":["true","false"]},"in":"query","name":"recursive","required":false},{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"deleted":{"type":"boolean","enum":[true]},"folderIds":{"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"}},"templateIds":{"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"}},"entityIds":{"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"}}},"required":["id","deleted","folderIds","templateIds","entityIds"],"additionalProperties":false,"title":"WorkspaceFolderDeleted"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/workspace-folders/{id}/definition":{"get":{"operationId":"getWorkspaceFolderDefinition","summary":"Get a folder's contents as one document","tags":["Workspace files"],"description":"The folder's subfolders, files and templates.","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"format":{"type":"string","enum":["typefold-workspace-v1","pdf-renderer-workspace-v1"]},"rootId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]},"folders":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^./\\\\\\s][^/\\\\]*$"},"parentId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["id","name","parentId","createdAt"],"additionalProperties":false,"title":"WorkspaceFolder"}},"entities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[^./\\\\\\s][^/\\\\]*$"},"kind":{"type":"string","enum":["data","localization","partial","script","stylesheet","asset"]},"folderId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]},"assetId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]},"scope":{"type":"string","enum":["template","folder","global"]},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"source":{"type":"string","maxLength":1000000}},"required":["id","name","kind","folderId","assetId","revision","createdAt","updatedAt","source"],"additionalProperties":false}},"templates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string"},"description":{"type":["string","null"]},"folderId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]},"content":{"type":"object","properties":{"composition":{"type":"object","properties":{"root":{"anyOf":[{"$ref":"#/components/schemas/CompositionNode"},{"type":"object","properties":{"type":{"type":"string","enum":["html"]},"html":{"type":"string","minLength":1,"maxLength":2000000},"helpers":{"type":"string","maxLength":500000}},"required":["type","html"],"additionalProperties":false},{"type":"object","properties":{"type":{"type":"string","enum":["sheets"]},"sheets":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":31,"pattern":"^[^[\\]*?:/\\\\]+$"},"sections":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"title":{"anyOf":[{"type":"string","maxLength":200},{"type":"object","propertyNames":{"type":"string","pattern":"^(?:default|[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3})$"},"additionalProperties":{"type":"string","maxLength":200}}]},"source":{"type":"string","maxLength":200,"pattern":"^[A-Za-z_$][\\w$]*(?:\\.(?:[A-Za-z_$][\\w$]*|0|[1-9]\\d*))*$"},"columns":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"header":{"anyOf":[{"type":"string","maxLength":200},{"type":"object","propertyNames":{"type":"string","pattern":"^(?:default|[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3})$"},"additionalProperties":{"type":"string","maxLength":200}}]},"value":{"type":"string","maxLength":200,"pattern":"^[A-Za-z_$][\\w$]*(?:\\.(?:[A-Za-z_$][\\w$]*|0|[1-9]\\d*))*$"},"format":{"type":"string","enum":["text","number","decimal","date"]},"width":{"type":"number","minimum":5,"maximum":100}},"required":["header","value","format"],"additionalProperties":false}}},"required":["source","columns"],"additionalProperties":false}}},"required":["name","sections"],"additionalProperties":false}}},"required":["type","sheets"],"additionalProperties":false}]},"header":{"type":"string","maxLength":100000},"footer":{"type":"string","maxLength":100000},"components":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"additionalProperties":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"root":{"$ref":"#/components/schemas/CompositionNode"},"source":{"type":"object","properties":{"templateId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"componentId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["templateId","componentId","revision"],"additionalProperties":false}},"required":["name","root"],"additionalProperties":false}},"stylesheets":{"maxItems":20,"type":"array","items":{"type":"string","minLength":1,"maxLength":255}}},"required":["root"],"additionalProperties":false,"title":"DraftComposition"},"scripts":{"maxItems":10,"type":"array","items":{"type":"string","minLength":1,"maxLength":255}},"sampleDataFile":{"type":"string","minLength":1,"maxLength":255},"workbook":{"type":"string","minLength":1,"maxLength":255},"settings":{"type":"object","properties":{"pageSize":{"type":"object","properties":{"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["widthMm","heightMm"],"additionalProperties":false},"orientation":{"default":"portrait","type":"string","enum":["portrait","landscape"]},"margins":{"type":"object","properties":{"topMm":{"type":"number","minimum":0,"maximum":500},"rightMm":{"type":"number","minimum":0,"maximum":500},"bottomMm":{"type":"number","minimum":0,"maximum":500},"leftMm":{"type":"number","minimum":0,"maximum":500}},"required":["topMm","rightMm","bottomMm","leftMm"],"additionalProperties":false},"locale":{"default":"en-US","type":"string","minLength":2,"maxLength":64},"pageRanges":{"type":"string","maxLength":200},"metadata":{"type":"object","properties":{"title":{"type":"string","maxLength":500},"author":{"type":"string","maxLength":200},"subject":{"type":"string","maxLength":1000},"creator":{"type":"string","maxLength":200},"producer":{"type":"string","maxLength":200},"language":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","pattern":"^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8}){0,3}$"}]},"keywords":{"maxItems":32,"type":"array","items":{"type":"string","maxLength":100}},"xmp":{"maxItems":4,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"prefix":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"namespace":{"type":"string","minLength":1,"maxLength":500,"pattern":"^[a-z][\\w+.-]*:\\S+$"},"properties":{"minItems":1,"maxItems":32,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","maxLength":100,"pattern":"^[A-Za-z_][\\w.-]*$"},"value":{"type":"string","maxLength":1000},"description":{"type":"string","minLength":1,"maxLength":1000}},"required":["name","value","description"],"additionalProperties":false}}},"required":["name","prefix","namespace","properties"],"additionalProperties":false,"title":"XmpSchema"}}},"additionalProperties":false,"title":"PdfMetadata"},"encryption":{"type":"object","properties":{"openPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"ownerPassword":{"type":"string","maxLength":1000,"description":"May use `{{path}}` placeholders bound to render data. At most 127 UTF-8 bytes once bound."},"permissions":{"type":"object","properties":{"printing":{"type":"string","enum":["none","lowResolution","highResolution"]},"modifying":{"type":"boolean"},"copying":{"type":"boolean"},"annotating":{"type":"boolean"},"fillingForms":{"type":"boolean"},"contentAccessibility":{"type":"boolean"},"documentAssembly":{"type":"boolean"}},"additionalProperties":false,"title":"PdfPermissions"}},"additionalProperties":false,"title":"PdfEncryption"},"signature":{"type":"object","properties":{"certificate":{"type":"string","maxLength":120},"reason":{"type":"string","maxLength":200},"location":{"type":"string","maxLength":200},"contactInfo":{"type":"string","maxLength":200},"field":{"type":"object","properties":{"page":{"type":"integer","minimum":1,"maximum":100000},"xMm":{"type":"number","minimum":0,"maximum":2000},"yMm":{"type":"number","minimum":0,"maximum":2000},"widthMm":{"type":"number","exclusiveMinimum":0,"maximum":2000},"heightMm":{"type":"number","exclusiveMinimum":0,"maximum":2000}},"required":["xMm","yMm","widthMm","heightMm"],"additionalProperties":false,"title":"PdfSignatureField"}},"required":["certificate"],"additionalProperties":false,"title":"PdfSignature"},"operations":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["append","prepend","merge"]},"template":{"type":"string","minLength":1,"maxLength":120},"pdf":{"type":"string","minLength":1,"maxLength":255},"mergeWholeDocument":{"type":"boolean"},"mergeToFront":{"type":"boolean"},"renderForEveryPage":{"type":"boolean"}},"required":["type"],"additionalProperties":false,"title":"PdfOperation"}},"pdfa":{"type":"string","enum":["4","2b","2u","2a","3b","3u","3a","4f"],"title":"PdfaLevel"},"pdfua":{"type":"string","enum":["1","2"],"title":"PdfuaPart"},"opaqueFills":{"type":"boolean"},"preferCssPageSize":{"type":"boolean"}},"required":["pageSize","margins"],"additionalProperties":false,"title":"TemplateSettings"},"contentFields":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"key":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_]{0,63}$","title":"ContentFieldKey"},"label":{"type":"string","minLength":1,"maxLength":120},"type":{"type":"string","enum":["text","richText","image","colour","toggle","choice","number","date"]},"group":{"type":"string","minLength":1,"maxLength":80},"help":{"type":"string","maxLength":500},"multiline":{"type":"boolean"},"maxLength":{"type":"integer","minimum":1,"maximum":65536},"options":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string","minLength":1,"maxLength":120}}},"required":["key","label","type"],"additionalProperties":false,"title":"ContentField"},"title":"ContentFields"},"contentValues":{"type":"object","propertyNames":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_]{0,63}$","title":"ContentFieldKey"},"additionalProperties":{"anyOf":[{"type":"string","maxLength":65536},{"type":"number"},{"type":"boolean"}],"title":"ContentValue"},"title":"ContentValues"}},"required":["composition","settings"],"additionalProperties":false,"title":"TemplateDraftContent"}},"required":["id","name","description","folderId","content"],"additionalProperties":false}}},"required":["format","rootId","folders","entities","templates"],"additionalProperties":false,"title":"WorkspaceFolderDefinition"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/workspace-folders/{id}/copy":{"post":{"operationId":"copyWorkspaceFolder","summary":"Copy a folder into another parent","tags":["Workspace files"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"parentId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]}},"required":["parentId"],"additionalProperties":false,"title":"CopyWorkspaceFolderBody"}}}},"parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string","minLength":1,"maxLength":80,"pattern":"^[^./\\\\\\s][^/\\\\]*$"},"parentId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["id","name","parentId","createdAt"],"additionalProperties":false,"title":"WorkspaceFolder"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/workspace-entities":{"get":{"operationId":"listWorkspaceEntities","summary":"List workspace files","tags":["Workspace files"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"limit","required":false},{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"query","name":"cursor","required":false}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[^./\\\\\\s][^/\\\\]*$"},"kind":{"type":"string","enum":["data","localization","partial","script","stylesheet","asset"]},"folderId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]},"assetId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]},"scope":{"type":"string","enum":["template","folder","global"]},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"}},"required":["id","name","kind","folderId","assetId","scope","revision","createdAt","updatedAt"],"additionalProperties":false,"title":"WorkspaceEntityMetadata"}},"nextCursor":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"}},"required":["items"],"additionalProperties":false,"title":"WorkspaceEntityList"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}},"post":{"operationId":"createWorkspaceEntity","summary":"Create a workspace file","tags":["Workspace files"],"description":"A file backed by an uploaded asset also needs `asset:manage`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[^./\\\\\\s][^/\\\\]*$"},"kind":{"type":"string","enum":["data","localization","partial","script","stylesheet","asset"]},"folderId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]},"assetId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"source":{"type":"string","maxLength":1000000},"scope":{"type":"string","enum":["template","folder","global"]}},"required":["name","kind"],"additionalProperties":false,"title":"CreateWorkspaceEntityBody"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[^./\\\\\\s][^/\\\\]*$"},"kind":{"type":"string","enum":["data","localization","partial","script","stylesheet","asset"]},"folderId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]},"assetId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]},"scope":{"type":"string","enum":["template","folder","global"]},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"source":{"type":"string","maxLength":1000000}},"required":["id","name","kind","folderId","assetId","scope","revision","createdAt","updatedAt","source"],"additionalProperties":false,"title":"WorkspaceEntity"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/workspace-references":{"get":{"operationId":"listWorkspaceReferences","summary":"List the files each template's draft uses","tags":["Workspace files"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"entityIds":{"type":"array","items":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"}}},"required":["id","entityIds"],"additionalProperties":false}}},"required":["items"],"additionalProperties":false,"title":"WorkspaceReferenceList"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/workspace-entities/{id}/usages":{"get":{"operationId":"listWorkspaceEntityUsages","summary":"List the templates whose drafts use a file","tags":["Workspace files"],"parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string"},"publishedVersion":{"type":["number","null"]}},"required":["id","name","publishedVersion"],"additionalProperties":false}}},"required":["items"],"additionalProperties":false,"title":"WorkspaceEntityUsageList"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/workspace-entities/{id}":{"get":{"operationId":"getWorkspaceEntity","summary":"Get a workspace file","tags":["Workspace files"],"parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[^./\\\\\\s][^/\\\\]*$"},"kind":{"type":"string","enum":["data","localization","partial","script","stylesheet","asset"]},"folderId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]},"assetId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]},"scope":{"type":"string","enum":["template","folder","global"]},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"source":{"type":"string","maxLength":1000000}},"required":["id","name","kind","folderId","assetId","scope","revision","createdAt","updatedAt","source"],"additionalProperties":false,"title":"WorkspaceEntity"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}},"put":{"operationId":"saveWorkspaceEntity","summary":"Save a workspace file's content","tags":["Workspace files"],"description":"Refused when `expectedRevision` is not the file's current revision. Replacing it with an uploaded asset also needs `asset:manage`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"type":"object","properties":{"source":{"type":"string","maxLength":1000000},"expectedRevision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["source","expectedRevision"],"additionalProperties":false},{"type":"object","properties":{"assetId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"expectedRevision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["assetId","expectedRevision"],"additionalProperties":false}],"title":"SaveWorkspaceEntityBody"}}}},"parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[^./\\\\\\s][^/\\\\]*$"},"kind":{"type":"string","enum":["data","localization","partial","script","stylesheet","asset"]},"folderId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]},"assetId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]},"scope":{"type":"string","enum":["template","folder","global"]},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"source":{"type":"string","maxLength":1000000}},"required":["id","name","kind","folderId","assetId","scope","revision","createdAt","updatedAt","source"],"additionalProperties":false,"title":"WorkspaceEntity"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}},"patch":{"operationId":"updateWorkspaceEntity","summary":"Rename, move or rescope a workspace file","tags":["Workspace files"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[^./\\\\\\s][^/\\\\]*$"},"folderId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]},"scope":{"type":"string","enum":["template","folder","global"]}},"additionalProperties":false,"title":"UpdateWorkspaceEntityBody"}}}},"parameters":[{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string","minLength":1,"maxLength":120,"pattern":"^[^./\\\\\\s][^/\\\\]*$"},"kind":{"type":"string","enum":["data","localization","partial","script","stylesheet","asset"]},"folderId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]},"assetId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]},"scope":{"type":"string","enum":["template","folder","global"]},"revision":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"createdAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"updatedAt":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d+)?(?:Z|[+-]\\d{2}:\\d{2})$","title":"IsoDateTime"},"source":{"type":"string","maxLength":1000000}},"required":["id","name","kind","folderId","assetId","scope","revision","createdAt","updatedAt","source"],"additionalProperties":false,"title":"WorkspaceEntity"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}},"/v1/workspace/template-resources":{"get":{"operationId":"listWorkspaceTemplateResources","summary":"List templates as Studio's Explorer shows them","tags":["Workspace files"],"parameters":[{"schema":{"type":"string"},"in":"query","name":"limit","required":false},{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"in":"query","name":"cursor","required":false}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"templateId":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},"name":{"type":"string"},"folderId":{"anyOf":[{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"},{"type":"null"}]},"draftRevision":{"type":"number"},"published":{"type":"boolean"},"rootType":{"type":"string","enum":["html","node","sheets"]}},"required":["templateId","name","folderId","draftRevision","published","rootType"],"additionalProperties":false,"title":"WorkspaceTemplateResources"}},"nextCursor":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9][A-Za-z0-9_-]*$","title":"Identifier"}},"required":["items"],"additionalProperties":false,"title":"WorkspaceTemplateResourcesList"}}}},"default":{"description":"An error. See [errors](/clients/http/#errors).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","CONFLICT","RATE_LIMITED","TEMPLATE_INVALID","DATA_INVALID","ASSET_INVALID","UNSUPPORTED_FEATURE","LIMIT_EXCEEDED","QUOTA_EXCEEDED","LICENSE_REQUIRED","RENDER_TIMEOUT","RENDER_FAILED","INTERNAL"]},"message":{"type":"string"},"retryable":{"default":false,"type":"boolean"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["message"],"additionalProperties":false}},"renderId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"title":"ErrorEnvelope"}}}}}}}},"security":[{"apiKey":[]},{"session":[]}],"tags":[{"name":"Reports","description":"Render the published version of a template by name and get the file back in the response. See [Reports API](/guides/reports/)."},{"name":"Renders","description":"Background renders of HTML, a node document, a fixed template version or a draft, followed by polling or webhooks. See [Renders API](/guides/rendering/)."},{"name":"Templates","description":"Templates, their drafts, revisions and published versions. See [how templates work](/templates/overview/)."},{"name":"Workspace files","description":"Folders and the files templates share, and folder export and import. `GET` requests need `template:read`; every other method needs `template:write`. See [templates and workspace files](/templates/overview/) and [deploy across environments](/guides/environments/)."},{"name":"Assets","description":"Fonts, images, stylesheets and workbooks. Uploads take two steps; see [upload fonts, images and workbooks](/clients/http/#upload-fonts-images-and-workbooks)."},{"name":"Webhooks","description":"Endpoints that receive render events. All need `webhook:manage`. See [webhooks](/guides/webhooks/)."},{"name":"Signing certificates","description":"Certificates that sign PDFs. See [digital signatures](/guides/pdf-standards/#digital-signatures)."},{"name":"Storage destinations","description":"Buckets that renders upload their PDFs to. All need `destination:manage`. See [storage destinations](/guides/storage-destinations/)."},{"name":"Workspace administration","description":"API keys, the audit history, usage and render allowances. See [API keys](/clients/http/#api-keys) and [limits](/clients/limits/)."},{"name":"Platform administration","description":"Self-hosted installations only. Needs a platform administrator's Studio session; API keys are refused. See [users and roles](/self-hosting/users/)."},{"name":"Migrating","description":"Bring templates over from a report archive. See [Migrating](/guides/jsreport-import/)."},{"name":"Status","description":"Public endpoints that need no credential. See [health checks](/self-hosting/monitoring/#health-checks)."}]}