Document API for AI-native software: render PDFs, e-sign, PAdES-seal, and verify.
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Ask Kamy Brain a question about Kamy usage, templates, plans, or errors. Sends the question to Kamy's public assistant endpoint and returns a paragraph answer.
The question to ask Kamy about — how to render a template, why a render failed, what plan to pick, etc.
Ask Kamy Brain a question about Kamy usage, templates, plans, or errors. Sends the question to Kamy's public assistant endpoint and returns a paragraph answer.
| Argument | Type | Description |
|---|---|---|
| question* | string | The question to ask Kamy about — how to render a template, why a render failed, what plan to pick, etc. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"question"
],
"properties": {
"question": {
"type": "string",
"maxLength": 2000,
"minLength": 1,
"description": "The question to ask Kamy about — how to render a template, why a render failed, what plan to pick, etc."
}
},
"additionalProperties": false
}Cryptographically sign an output your agent produced — a PDF, report, code patch, dataset, email — so a third party can later confirm those exact bytes are the ones that were recorded, unmodified. Pass content_text or content_base64 and Kamy hashes the bytes for you; pass content_sha256 alone when the content itself must never leave your environment. Returns { attestation_id, content_sha256, signature, recorded_at, verify_url } — hand verify_url to whoever needs to check the artifact. This proves the bytes match what this account recorded at that time; it makes no claim about whether the content is correct. Requires a Kamy API key.
| Argument | Type | Description |
|---|---|---|
| tags | array | Up to 20 free-form labels. |
| run_id | string | Your identifier for the agent run this artifact belongs to. Pass the same run_id across attestations and agent-action records to build one provenance chain readable via get_provenance_chain. |
| feature | string | Product area or pipeline name, for grouping attestations. |
| metadata | object | Arbitrary JSON stored alongside the attestation (model, source URL, reviewer, ...). |
| content_text | string | UTF-8 text artifact. Convenience input: this MCP server base64-encodes it locally and sends it as content_base64 — no other transformation is applied. Supply exactly one of content_sha256, content_base64, or content_text. |
| artifact_type* | string | What kind of output this is, e.g. 'pdf', 'report', 'code_patch', 'dataset', 'email', 'llm_output'. Free-form label used for filtering later. |
| parent_sha256 | any | content_sha256 of the preceding record in the chain, when this artifact was derived from an earlier one. |
| content_base64 | string | Base64-encoded artifact bytes. Use for binary output (PDF, image, archive). Supply exactly one of content_sha256, content_base64, or content_text. |
| content_sha256 | string | SHA-256 of the artifact bytes, when you'd rather not send the content itself. Supply exactly one of content_sha256, content_base64, or content_text. |
Fan one already-rendered PDF out to up to 100 independent signers in a single call — the 'send this NDA to everyone on the list' path. Each signer gets their own request, their own sign link and their own invitation email, but they all share one source render, so only one document is produced and stored. Choose create_envelope instead when the recipients are signing the SAME document together and you need routing, ordering and one envelope status; choose this when they are unrelated parties each signing their own copy. Duplicate signer emails within one batch are rejected up front with 422. Per-signer failures do not abort the batch: the response is { bulkId, count, successCount, failureCount, results } in input order, each row either ok with signatureId and signUrl or ok:false with a reason, and the call returns 207 when any row failed. Consumes one signature from the monthly quota PER signer (free tier: 10 per month, then per-signature billing), so a large batch can exhaust a small plan part-way through and the remaining rows come back failed. Requires a Kamy API key with the `signatures:write` scope; without a key, returns dashboard setup instructions.
| Argument | Type | Description |
|---|---|---|
| message | string | Shared invite message. `{{signerName}}` is substituted per recipient. |
| signers* | array | 1–100 signers. Duplicate emails are rejected up front with 422. |
| position | object | One signature rectangle in PDF points (origin bottom-left) shared by every signer. |
| renderId* | string | Render UUID every signer receives. One render, one storage object, many requests. |
| expiresIn |
Convert a file you already hold — .docx, .xlsx or .csv — into a PDF, preserving its existing content. Pass the bytes base64-encoded together with the original filename, which is what the API uses to detect the input type. This is the inbound direction: it consumes an existing document, whereas render_docx / render_xlsx / render_pptx GENERATE new documents from structured data, and render_pdf builds one from a template. Returns a stored render { id, url, bytes, durationMs, name } whose id can be fed straight into merge_pdfs, split_pdf, edit_pdf, create_signature_request or create_envelope. Counts one render against the monthly quota. Files over 10 MB are refused by this tool because the bytes travel through the tool call. Requires a Kamy API key with the `render` scope; without a key, returns dashboard setup instructions.
| Argument | Type | Description |
|---|---|---|
| name | string | Label for the resulting render row. Defaults to the source filename. |
| filename* | string | Source filename including its extension — the route detects the input type from it. Must end in .docx, .xlsx or .csv. |
| fileBase64* | string | Base64-encoded bytes of the source file. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"filename",
"fileBase64"
],
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Label for the resulting render row. Defaults to the source filename."
},
"filename": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Source filename including its extension — the route detects the input type from it. Must end in .docx, .xlsx or .csv."
},
"fileBase64": {
"type": "string",
"minLength": 1,
"description": "Base64-encoded bytes of the source file."
}
},
"additionalProperties": false
}Send a single PDF to 2–10 signers as one envelope. This is the multi-signer counterpart to create_signature_request, which handles exactly one signer — the API rejects an envelope with fewer than two recipients, so pick the tool by signer count. routing 'parallel' (default) emails everyone at once and each signs independently; routing 'sequential' emails only the lowest-order recipient and activates the rest one at a time as each preceding signer finishes, which is what you want for approve-then-countersign chains. The source is either a render you own (renderId) or a PDF fetched from a public URL (pdfUrl) — supply exactly one. Pass preview: true to create the envelope and get every sign URL back WITHOUT sending any email and WITHOUT consuming quota; do that first if you are unsure about field placement. A real send emails the recipients immediately and consumes one signature from the monthly quota PER recipient (free tier: 10 signatures/month, then per-signature billing). Returns { envelope, recipients: [...] } with a sign_url per recipient. Requires a Kamy API key with the `signatures:write` scope; without a key, returns dashboard setup instructions.
| Argument | Type | Description |
|---|---|---|
| pdfUrl | string | Publicly fetchable PDF URL. Kamy downloads it and stores it as a render first. Supply exactly one of renderId or pdfUrl. |
| message | string | Message included in every invitation email. |
| preview | boolean | When true, creates the envelope and returns every sign URL WITHOUT emailing anyone and without consuming signature quota. Use it to check placement and routing before the real send. |
| routing | string | 'parallel' (default) emails everyone at once and each signs independently. 'sequential' emails only the lowest-order recipient; the rest are created with status 'waiting' and activated one at a time as the preceding signer completes. |
Set up a recurring render: a cron expression, a template, and where each document goes. Use this instead of render_pdf when the user wants a document produced repeatedly on a calendar — a weekly report, a monthly invoice run — so nothing has to stay running. Delivery channel is 'email' or 'whatsapp' (recipients required) or 'download' (stored only; retrieve later with list_renders). The cron is evaluated in the given IANA timezone, and how often it may fire is plan-gated: at least 60 minutes apart on Free, 15 on Starter, 5 on Pro and above — a tighter expression is rejected with a validation error naming the limit. Every firing spends one render from the monthly quota, so a frequent schedule can exhaust a small plan on its own. Returns the created schedule including its id and next_run_at.
| Argument | Type | Description |
|---|---|---|
| data | object | Template data, used verbatim on every firing. Defaults to {}. |
| name* | string | Human label for this schedule, shown in the dashboard. |
| channel* | string | Where each rendered document goes. 'download' just stores it (find it later with list_renders); 'email' and 'whatsapp' require recipients. |
| enabled | boolean | Defaults to true. Create it disabled to set it up now and start it later. |
| options | object | Render options passed straight through to the render, in the nested /v1/render shape, e.g. { format: 'letter', margin: { top: '20mm' } }. |
| schedule* |
Send a previously rendered PDF to a signer for e-signature when a Kamy API key is configured. Without a key, returns dashboard setup instructions.
| Argument | Type | Description |
|---|---|---|
| message | string | Optional message rendered in the email invitation body. |
| ccEmails | array | Up to 10 observer addresses CC'd on the invite and the completion notice. Not signers themselves. |
| position | object | Optional sender-chosen signature placement in PDF points (72 dpi, origin bottom-left). Defaults to bottom-right of the last page sized 220×64 pt; when omitted, the signer can drag the placeholder on the sign page. |
| renderId* | string | Render UUID returned by render_pdf or any /v1/render call. The render's PDF is the document the signer will receive. |
| expiresIn | integer | How long (seconds) the sign link stays valid. Defaults to 30 days. Min 1 hour, max 30 days. |
| authMethod | string | Identity-verification mode. `link` (default) — possession of the secret URL is the only check. `email_otp` — sign page renders a 6-digit OTP gate; code emailed to `signerEmail`. `sms_otp` — same gate, code texted to `signerPhone` (which must then be supplied). Recommend `email_otp` for higher-value transactions. |
| signerName* | string |
Create a new custom PDF template owned by this account: a name, a unique slug, a Handlebars/HTML body, and optional CSS and JSON Schema. The slug is what render_pdf then takes as `template`. Custom templates are a paid feature — on the Free plan this returns 403 FORBIDDEN before anything is created. The slug must be unique within the account and must not collide with a built-in system slug (invoice, receipt, quote, …); both cases come back 422, and the fix for an already-taken slug is update_template rather than a retry. A brand-new template has no published version, so it renders straight from what you supply here — publish_template only becomes necessary once you start cutting versions. Requires a Kamy API key with the `templates:write` scope; without a key, returns dashboard setup instructions.
| Argument | Type | Description |
|---|---|---|
| css | string | Stylesheet applied at render time. Max 1 MB. |
| html* | string | Handlebars/HTML body of the document. Max 5 MB. |
| name* | string | Human-readable template name. |
| slug* | string | Stable identifier the render tools take as `template`. Unique per account, and it may not collide with a built-in system slug (invoice, receipt, quote, …) — both cases are rejected with 422. |
| tags | array | Up to 10 free-form labels. |
| schema | object | JSON Schema describing the data payload the template expects. Defaults to {}. |
Register an HTTPS endpoint that Kamy POSTs to when work finishes, so a long render or an e-signature does not have to be polled. Use this when the caller owns a server that can receive callbacks; use get_job or list_renders when it cannot. The response includes a one-time signing secret used to verify delivery signatures — it is shown here and never again, so surface it to the user immediately and tell them to store it. Defaults to the render.completed and render.failed events; the full set is render.completed, render.failed, signature.signed, signature.voided, signature.expired, signature.envelope_completed, signature.envelope_voided, test.ping, and any other string is accepted so new events can be subscribed to without an upgrade. Endpoint URLs on private, loopback, link-local or cloud-metadata hosts are rejected at registration, so a localhost tunnel will not work — use a public URL.
| Argument | Type | Description |
|---|---|---|
| url* | string | HTTPS endpoint Kamy POSTs each event to. Private, loopback, link-local and cloud-metadata hosts are rejected at registration time, so localhost and 10.x/192.168.x addresses will not work. |
| events | array | Event names to receive. Defaults to ["render.completed", "render.failed"]. Known events: render.completed, render.failed, signature.signed, signature.voided, signature.expired, signature.envelope_completed, signature.envelope_voided, test.ping. |
| enabled | boolean | Defaults to true. Register it disabled to wire it up before switching it on. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"format": "uri",
"maxLength": 2000,
"description": "HTTPS endpoint Kamy POSTs each event to. Private, loopback, link-local and cloud-metadata hosts are rejected at registration time, so localhost and 10.x/192.168.x addresses will not work."
},
"events": {
"type": "array",
"items": {
"type": "string",
"maxLength": 120,
"minLength": 1
},
"description": "Event names to receive. Defaults to [\"render.completed\", \"render.failed\"]. Known events: render.completed, render.failed, signature.signed, signature.voided, signature.expired, signature.envelope_completed, signature.envelope_voided, test.ping."
},
"enabled": {
"type": "boolean",
"description": "Defaults to true. Register it disabled to wire it up before switching it on."
}
},
"additionalProperties": false
}Permanently delete a recurring schedule so it stops firing. There is no undo and no trash — recreate it with create_schedule if it is deleted by mistake, so confirm with the user before calling this on a schedule you did not just create. If the intent is only to pause it, do not use this tool: a schedule can be switched off and back on again via its `enabled` flag on the REST endpoint (PATCH /v1/schedules/{id}), which this MCP surface does not expose. Documents already produced by past firings are unaffected and remain available through list_renders. Returns { deleted: true }, or 404 if the id does not belong to this account.
| Argument | Type | Description |
|---|---|---|
| schedule_id* | string | Schedule id (UUID) from create_schedule or list_schedules. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"schedule_id"
],
"properties": {
"schedule_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Schedule id (UUID) from create_schedule or list_schedules."
}
},
"additionalProperties": false
}Modify an existing PDF: fill AcroForm fields by name, stamp text at absolute coordinates, or paint opaque boxes over regions. Operations apply in the order given, to either a render you own (renderId) or a PDF Kamy downloads from a public URL (pdfUrl) — supply exactly one. Use this when a document already exists and needs values or marks; use render_pdf when the document should be generated from a template instead. Nothing is overwritten: the source is untouched and the result is a NEW render whose id feeds directly into create_signature_request, create_envelope, merge_pdfs or split_pdf. Coordinates are PDF points with the origin at the BOTTOM-left. AcroForm values are flattened by default so they cannot be edited after signing. 'cover' paints an opaque rectangle over the region — it hides content visually but does NOT delete the underlying bytes, and the response carries a COVER_VISUAL_ONLY warning for every cover op. Anyone can still copy the text out from under the box. It is NOT redaction: never use it to hide secrets or personal data in a document you are about to hand out, and do not describe the result as redacted. There is no redaction operation — 'op: redact' is rejected with REDACTION_NOT_SUPPORTED. To remove sensitive data, regenerate the document without it. Returns { id, url, bytes, durationMs, name, warnings } — always read warnings, since out-of-range pages and unmatched field names are reported there rather than failing the call. Requires a Kamy API key with the `render` scope; without a key, returns dashboard setup instructions.
| Argument | Type | Description |
|---|---|---|
| name | string | Label for the resulting render row. |
| pdfUrl | string | Publicly fetchable URL of a PDF Kamy has never seen. Kamy downloads it, applies the operations and stores only the edited result — the source does not become a separate render, and the call costs one render either way. Supply exactly one of renderId or pdfUrl. |
| renderId | string |
Extract structured data from a PDF (invoice, receipt, contract, ID document, or any form). Returns the parsed JSON plus a public verify URL that proves the extraction matches the source. Use this when an agent needs to read an inbound document and act on it.
| Argument | Type | Description |
|---|---|---|
| template* | string | Predefined template id. invoice/receipt for AP and POS docs, contract for legal agreements, id_document for passports/IDs, generic_form for anything else. |
| source_url | string | Public URL to a PDF (preferred). One of source_url or source_base64 is required. |
| source_base64 | string | Base64-encoded PDF bytes. Use when the source isn't publicly fetchable. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"template"
],
"properties": {
"template": {
"enum": [
"invoice",
"receipt",
"contract",
"id_document",
"generic_form"
],
"type": "string",
"description": "Predefined template id. invoice/receipt for AP and POS docs, contract for legal agreements, id_document for passports/IDs, generic_form for anything else."
},
"source_url": {
"type": "string",
"format": "uri",
"description": "Public URL to a PDF (preferred). One of source_url or source_base64 is required."
},
"source_base64": {
"type": "string",
"description": "Base64-encoded PDF bytes. Use when the source isn't publicly fetchable."
}
},
"additionalProperties": false
}Read the text or the form fields back out of a document this account already rendered, without uploading anything. Pass type='text' (the default) for per-page text plus a joined fullText string, or type='fields' for the PDF's AcroForm field names, types and current values — the latter is how you discover what edit_pdf can fill in. Choose extract_document instead when the PDF came from outside Kamy or when you need AI-structured JSON against a schema; this tool is a plain mechanical read of an existing render, spends no render quota and no extraction credits. The render must have status 'success' or the call returns 409 RENDER_NOT_READY.
| Argument | Type | Description |
|---|---|---|
| type | string | 'text' (default) returns { pages: [{ page, text }], fullText, pageCount }. 'fields' returns the AcroForm fields as { name, type, value }. |
| render_id* | string | Render id (UUID) as returned by render_pdf, render_async/get_job, or list_renders. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"render_id"
],
"properties": {
"type": {
"enum": [
"text",
"fields"
],
"type": "string",
"description": "'text' (default) returns { pages: [{ page, text }], fullText, pageCount }. 'fields' returns the AcroForm fields as { name, type, value }."
},
"render_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Render id (UUID) as returned by render_pdf, render_async/get_job, or list_renders."
}
},
"additionalProperties": false
}Read everything about the authenticated Kamy account in one call: profile, plan and plan status, the plan's limits (renders per month, API keys, seats, custom templates, overage pricing, priority queue), month-to-date render usage, and whether documents rendered on this plan carry Kamy's own watermark. This is the only tool that answers any of those questions — there is no separate quota tool. Call it before render_batch, create_schedule, or any long series of renders: usage.renders.remaining is how many the API will still accept, and every render tool fails with 402 QUOTA_EXCEEDED once it hits zero, a failure nothing can recover from within the same calendar month. quota and remaining are null on unmetered plans, which means unlimited, not zero. Also check watermarkPolicy.appliedToRenders before generating something the user intends to send on: it is true on the free plan and cannot be turned off per render. Read-only, spends nothing, and works with any valid API key regardless of its scopes.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Fetch one multi-signer envelope with every recipient in signing order — each with a live sign_url, status, recipient_order, expires_at and last_reminded_at — plus the envelope's own status and routing. This is the tool for 'who still has not signed?' after a create_envelope send; get_signature_request answers that for a single standalone request and returns no recipient list. Under sequential routing, recipients whose turn has not arrived show status 'waiting'. Read-only and spends no quota. Requires a Kamy API key with the `signatures:read` scope; without a key, returns dashboard setup instructions.
| Argument | Type | Description |
|---|---|---|
| envelopeId* | string | Envelope ID returned by create_envelope. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"envelopeId"
],
"properties": {
"envelopeId": {
"type": "string",
"format": "uuid",
"description": "Envelope ID returned by create_envelope."
}
},
"additionalProperties": false
}Poll an asynchronous render job started by render_async. Returns { jobId, status } where status is 'queued', 'processing', 'completed' or 'failed'; on 'completed' the response also carries `render` with the finished document's id, signed URL, size and duration, and on 'failed' it carries `error` with the reason. Poll every few seconds rather than in a tight loop — a typical render finishes in seconds, a heavy one can take a minute. If a job's signed URL has since expired, pass its render id to get_render for a fresh one. Read-only and spends no quota.
| Argument | Type | Description |
|---|---|---|
| job_id* | string | The jobId render_async returned. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"job_id"
],
"properties": {
"job_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "The jobId render_async returned."
}
},
"additionalProperties": false
}Replay everything recorded under one run_id — artifacts from attest_artifact and calls from record_agent_action — in order, with each record's link to its parent hash. Use it to answer 'what did this agent actually do, and in what sequence?' during an incident review, a handover, or an audit. Returns { run_id, chain_intact, records: [...] }, where chain_intact is the server's verdict on whether the parent-hash links are unbroken across the run. Read-only. Requires a Kamy API key.
| Argument | Type | Description |
|---|---|---|
| run_id* | string | The run_id you passed to attest_artifact / record_agent_action. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"run_id"
],
"properties": {
"run_id": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The run_id you passed to attest_artifact / record_agent_action."
}
},
"additionalProperties": false
}Fetch one previously produced document by its render id, with a freshly signed download URL valid for the next hour. This is the recovery path for an expired link: the URL is minted at read time, so calling this again on an old render always yields a working download. Use list_renders first if you do not have the id. Returns { id, name, templateId, templateName, status, bytes, durationMs, url, createdAt }, where url is null when the render failed, has not finished yet, or its file has aged out of retention — check status before assuming a download exists. Read-only and spends no quota.
| Argument | Type | Description |
|---|---|---|
| render_id* | string | Render id (UUID) as returned by render_pdf, render_async/get_job, or list_renders. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"render_id"
],
"properties": {
"render_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Render id (UUID) as returned by render_pdf, render_async/get_job, or list_renders."
}
},
"additionalProperties": false
}Rasterise every page of an existing render to a PNG image and return one signed 1-hour URL per page, with pixel width and height. Use this when a page has to be looked at rather than read — thumbnails, previews, visual QA of a layout, or an image attachment — and use extract_from_render when you want the text. The render must already have status 'success'; a queued or failed one comes back as 409 RENDER_NOT_READY. Repeated calls overwrite the same page images, so it is safe to retry. Rasterisation costs no render quota. Returns { pages: [{ page, width, height, url }], count, dpi }.
| Argument | Type | Description |
|---|---|---|
| dpi | integer | Raster resolution. Defaults to 150 (screen quality); 300 for print-quality thumbnails. Clamped to 72-300 server-side. |
| render_id* | string | Render id (UUID) as returned by render_pdf, render_async/get_job, or list_renders. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"render_id"
],
"properties": {
"dpi": {
"type": "integer",
"maximum": 300,
"minimum": 72,
"description": "Raster resolution. Defaults to 150 (screen quality); 300 for print-quality thumbnails. Clamped to 72-300 server-side."
},
"render_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Render id (UUID) as returned by render_pdf, render_async/get_job, or list_renders."
}
},
"additionalProperties": false
}Returns the authenticated download URL for a signature request's Certificate of Completion PDF — the process audit trail (invite → opened → consent → signed, with IP / user-agent) that legal teams expect. Only available after the request reaches a terminal state. Without a key, returns dashboard setup instructions.
| Argument | Type | Description |
|---|---|---|
| signatureRequestId* | string | ID of the signature_request to fetch the Certificate of Completion for. Must be in a terminal state (signed / declined / delegated / voided / expired); pending requests return 409. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"signatureRequestId"
],
"properties": {
"signatureRequestId": {
"type": "string",
"format": "uuid",
"description": "ID of the signature_request to fetch the Certificate of Completion for. Must be in a terminal state (signed / declined / delegated / voided / expired); pending requests return 409."
}
},
"additionalProperties": false
}Fetch one signature request by id, with the detail list_signature_requests leaves out: the placed_fields layout, signed_at plus signed_ip and signed_user_agent, last_reminded_at, cc_emails, and envelope_id + recipient_order when it is part of an envelope. Use list_signature_requests to find an id and this to inspect it; use get_signature_certificate when what you actually want is the legal audit-trail PDF rather than the row. `status` is one of pending, waiting, signed, declined, delegated, voided or expired — `waiting` means a sequential envelope has not reached this signer yet, so nothing is wrong and no reminder is due. Read-only and spends no quota. Requires a Kamy API key with the `signatures:read` scope; without a key, returns dashboard setup instructions.
| Argument | Type | Description |
|---|---|---|
| signatureRequestId* | string | ID returned by create_signature_request, bulk_signature_requests, or a list call. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"signatureRequestId"
],
"properties": {
"signatureRequestId": {
"type": "string",
"format": "uuid",
"description": "ID returned by create_signature_request, bulk_signature_requests, or a list call."
}
},
"additionalProperties": false
}Fetch one e-signature preset in full, including the placed_fields array and position that list_signature_templates omits. Use it to inspect or copy an existing field layout before applying it through create_signature_request's signatureTemplateId, or as the starting point for a preview_field_placement check against a new render. Read-only and spends no quota. Requires a Kamy API key with the `signatures:read` scope; without a key, returns dashboard setup instructions.
| Argument | Type | Description |
|---|---|---|
| signatureTemplateId* | string | ID from list_signature_templates. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"signatureTemplateId"
],
"properties": {
"signatureTemplateId": {
"type": "string",
"format": "uuid",
"description": "ID from list_signature_templates."
}
},
"additionalProperties": false
}Everything needed to go from nothing to a rendered document in one call: the steps to create an API key in the dashboard, and — when you name a `framework` — the install command for the Kamy SDK, the environment variable it reads, and the client-setup snippet for that stack. Add a `template` slug and it also returns a ready-to-paste route handler that renders it. Every argument is optional and each one only adds a section, so calling this with no arguments is the right move when a user has no key yet, and calling it with framework + template is the right move when they are wiring the first endpoint. This replaces the separate install_sdk, generate_integration_code and get_api_key_instructions tools removed in 1.5.0. Pure text: it makes no API call, reads no account state, and needs no API key.
| Argument | Type | Description |
|---|---|---|
| template | string | Template slug (e.g. 'invoice') to also emit a ready-to-paste route handler that renders it. Requires `framework`. Call list_templates first if you do not know the slug. |
| framework | string | Stack being integrated. Omit to get only the API-key steps; supply it to also get the install command, the environment variable, and the client-setup snippet. |
| packageManager | string | Package manager for the install command. Default npm. Ignored for Python stacks. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"template": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Template slug (e.g. 'invoice') to also emit a ready-to-paste route handler that renders it. Requires `framework`. Call list_templates first if you do not know the slug."
},
"framework": {
"enum": [
"nextjs",
"remix",
"sveltekit",
"astro",
"express",
"fastify",
"hono",
"fastapi",
"flask"
],
"type": "string",
"description": "Stack being integrated. Omit to get only the API-key steps; supply it to also get the install command, the environment variable, and the client-setup snippet."
},
"packageManager": {
"enum": [
"npm",
"pnpm",
"yarn",
"bun"
],
"type": "string",
"description": "Package manager for the install command. Default npm. Ignored for Python stacks."
}
},
"additionalProperties": false
}Fetch the JSON Schema (exact data shape) and a copy-pasteable sample payload for a Kamy system template by slug. Call this before render_pdf so you fill the right fields with the right types instead of guessing. No authentication required.
| Argument | Type | Description |
|---|---|---|
| slug* | string | Template slug — e.g. 'invoice', 'receipt', 'uae-tax-invoice'. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"slug"
],
"properties": {
"slug": {
"type": "string",
"description": "Template slug — e.g. 'invoice', 'receipt', 'uae-tax-invoice'."
}
},
"additionalProperties": false
}Fetch one template version snapshot in full — html, css, schema, createdBy, createdAt — exactly as it was frozen when that version was cut. Use list_template_versions first to find the number. Use this to inspect what a released version actually contained, or to recover content a later draft edit overwrote; it changes nothing on its own, so pair it with rollback_template when you want that version live again. Takes a template UUID or slug. Read-only and spends no quota. Requires a Kamy API key with the `templates:read` scope; without a key, returns dashboard setup instructions.
| Argument | Type | Description |
|---|---|---|
| version* | integer | Version number from list_template_versions. |
| templateId* | string | Template UUID or slug — every /v1/templates route resolves either. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"templateId",
"version"
],
"properties": {
"version": {
"type": "integer",
"description": "Version number from list_template_versions.",
"exclusiveMinimum": 0
},
"templateId": {
"type": "string",
"minLength": 1,
"description": "Template UUID or slug — every /v1/templates route resolves either."
}
},
"additionalProperties": false
}Look up a stored asset by its upload id: filename, contentType, sizeBytes, status, its `kamy://asset/<id>` reference, and a freshly signed downloadUrl valid for one hour once the bytes exist. Its main use is confirming an out-of-band transfer landed — upload_file returns uploaded:false when the file was too large to pass inline and you PUT it yourself — because this read reconciles a still-'pending' row against storage and flips it to 'uploaded' the first time it sees the object. Also the way to mint a fresh download link after an earlier signed URL expired. Read-only and spends no quota. Requires a Kamy API key with the `uploads:read` scope; without a key, returns dashboard setup instructions.
| Argument | Type | Description |
|---|---|---|
| uploadId* | string | Upload UUID returned by upload_file. The bare UUID, not the kamy://asset/... ref. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"uploadId"
],
"properties": {
"uploadId": {
"type": "string",
"format": "uuid",
"description": "Upload UUID returned by upload_file. The bare UUID, not the kamy://asset/... ref."
}
},
"additionalProperties": false
}List the documents this account has already produced, newest first. This is how you find a PDF made earlier — in a previous turn, by a schedule, or by another process — when you no longer hold its URL. Download URLs returned by the render tools are signed and expire after an hour, so a link from earlier in the conversation is probably dead; find the render here, then call get_render with its id to mint a fresh one. Returns { renders: [{ id, name, templateId, templateName, status, bytes, durationMs, cost, createdAt }], total, page, pageSize, hasMore, currency }. The `name` field is whatever label was passed at render time, which is the fastest way to identify the right document. Read-only and spends no quota.
| Argument | Type | Description |
|---|---|---|
| page | integer | 1-based page number. Defaults to 1 (the most recent renders). |
| page_size | integer | Rows per page, 1-100. Defaults to 20. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"page": {
"type": "integer",
"minimum": 1,
"description": "1-based page number. Defaults to 1 (the most recent renders)."
},
"page_size": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Rows per page, 1-100. Defaults to 20."
}
},
"additionalProperties": false
}List this account's recurring render schedules, newest first, with the id needed to delete one. Use it to answer what is already automated before creating a duplicate, and to diagnose a schedule that is not producing documents: each row carries enabled, schedule, timezone, next_run_at, and last_run_at / last_run_status / last_run_error from the most recent firing — last_run_error is where a delivery or quota failure shows up. Returns { schedules, total, limit, offset }. Read-only and spends no quota.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Rows to return, 1-100. Defaults to 50. |
| offset | integer | Rows to skip. Defaults to 0. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Rows to return, 1-100. Defaults to 50."
},
"offset": {
"type": "integer",
"minimum": 0,
"description": "Rows to skip. Defaults to 0."
}
},
"additionalProperties": false
}List signature requests created by the configured Kamy account, newest first. Without a key, returns dashboard setup instructions.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Default 50. |
| offset | integer | Default 0. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Default 50."
},
"offset": {
"type": "integer",
"minimum": 0,
"description": "Default 0."
}
},
"additionalProperties": false
}List this account's reusable e-signature presets — saved field placements, default invite message, default link lifetime and CC list — newest first. These are signing presets, NOT the document catalog: list_templates is what render_pdf draws from. Rows here carry only id, name, description, expires_in and cc_emails; call get_signature_template for the placed_fields and position. Pass an id as create_signature_request's signatureTemplateId to apply a preset instead of re-specifying the layout every time. Returns { templates, total, limit, offset }. Read-only and spends no quota. Requires a Kamy API key with the `signatures:read` scope; without a key, returns dashboard setup instructions.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Page size, 1–100. Default 50. |
| offset | integer | Rows to skip. Default 0. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Page size, 1–100. Default 50."
},
"offset": {
"type": "integer",
"minimum": 0,
"description": "Rows to skip. Default 0."
}
},
"additionalProperties": false
}List a template's immutable version snapshots, newest first, as { id, version, createdAt }. This is where the version number that publish_template and rollback_template take comes from. Bodies are deliberately not included — call get_template_version when you need one snapshot's html, css and schema. Works on system and public templates as well as your own, by UUID or slug. Read-only and spends no quota. Requires a Kamy API key with the `templates:read` scope; without a key, returns dashboard setup instructions.
| Argument | Type | Description |
|---|---|---|
| templateId* | string | Template UUID or slug — every /v1/templates route resolves either. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"templateId"
],
"properties": {
"templateId": {
"type": "string",
"minLength": 1,
"description": "Template UUID or slug — every /v1/templates route resolves either."
}
},
"additionalProperties": false
}List Kamy's public system PDF templates. No authentication required.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}List the webhook endpoints registered on this account, with the id needed to test one. Each row carries url, events, enabled, and lastDeliveryAt / lastStatus from the most recent delivery — lastStatus is the HTTP code the caller's own server returned, so this is where a silently broken endpoint shows up as a 4xx or 5xx. Signing secrets are never returned here; they are shown only once, by create_webhook. Read-only and spends no quota.
No arguments.
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {}
}Concatenate 2–20 existing renders into a single new PDF, in exactly the order the ids are given. Both the inputs and the output are Kamy render ids, so this is the composition step after several render_pdf / convert_document / edit_pdf calls — it cannot merge arbitrary URLs or raw bytes, and every id must belong to this account and point at a completed render or the whole call fails. The source renders are left untouched. Returns a new render { id, url, bytes, durationMs }. Billed as one additional render. Requires a Kamy API key with the `render` scope; without a key, returns dashboard setup instructions.
| Argument | Type | Description |
|---|---|---|
| name | string | Label for the merged render, e.g. 'Q3 statement bundle'. |
| renderIds* | array | 2–20 render UUIDs owned by this account, in the page order you want. Any id that isn't yours, or whose render didn't complete, fails the whole call. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"renderIds"
],
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Label for the merged render, e.g. 'Q3 statement bundle'."
},
"renderIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"maxItems": 20,
"minItems": 2,
"description": "2–20 render UUIDs owned by this account, in the page order you want. Any id that isn't yours, or whose render didn't complete, fails the whole call."
}
},
"additionalProperties": false
}Cryptographically sign an existing render with PAdES when a Kamy API key is configured. Without a key, returns dashboard setup instructions.
| Argument | Type | Description |
|---|---|---|
| reason | string | Optional /Sig dictionary Reason — surfaced in Acrobat's signature panel. ASCII-coerced server-side. |
| location | string | Optional /Sig dictionary Location. |
| renderId* | string | Render UUID returned by render_pdf or any /v1/render call. The PDF will be sealed with a Kamy-issued X.509 leaf certificate. |
| signerName | string | Override the signer display name. Defaults to the account's full_name. |
| signerEmail | string | Override the signer email. Defaults to the account's email. |
| withTimestamp | boolean | When false, skip the RFC 3161 timestamp call (PAdES-B-B instead of B-T). Default: true. |
| withRevocationInfo | boolean | When false, skip embedding the Kamy CA CRL into the PKCS#7 SignedData (PAdES-B-T instead of B-LT). Online verifiers can still fetch the CRL via the Distribution Point on the leaf cert. Default: true. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"renderId"
],
"properties": {
"reason": {
"type": "string",
"maxLength": 200,
"description": "Optional /Sig dictionary Reason — surfaced in Acrobat's signature panel. ASCII-coerced server-side."
},
"location": {
"type": "string",
"maxLength": 120,
"description": "Optional /Sig dictionary Location."
},
"renderId": {
"type": "string",
"format": "uuid",
"description": "Render UUID returned by render_pdf or any /v1/render call. The PDF will be sealed with a Kamy-issued X.509 leaf certificate."
},
"signerName": {
"type": "string",
"maxLength": 120,
"description": "Override the signer display name. Defaults to the account's full_name."
},
"signerEmail": {
"type": "string",
"format": "email",
"description": "Override the signer email. Defaults to the account's email."
},
"withTimestamp": {
"type": "boolean",
"description": "When false, skip the RFC 3161 timestamp call (PAdES-B-B instead of B-T). Default: true."
},
"withRevocationInfo": {
"type": "boolean",
"description": "When false, skip embedding the Kamy CA CRL into the PKCS#7 SignedData (PAdES-B-T instead of B-LT). Online verifiers can still fetch the CRL via the Distribution Point on the leaf cert. Default: true."
}
},
"additionalProperties": false
}Check a placedFields layout against a real render's page geometry before anything is sent: no signature request is created, no email goes out, and no signature quota is spent. It accepts exactly what create_signature_request accepts — all seven field types, `options`, and anchor-positioned fields — so anything that previews clean will send. Returns each page's true width and height, so a sender UI can draw a preview at the right aspect ratio, plus per field valid / issues / the resolved coordinates the request would actually be stored with, after sourcePage scaling and anchor substitution. Issues are PAGE_OUT_OF_RANGE, OFF_PAGE_RIGHT, OFF_PAGE_TOP, DUPLICATE_NAME, ANCHOR_NOT_FOUND (the anchor text is not on that page, so the field falls back to the raw x/y) and OPTIONS_REQUIRED. None of these make create_signature_request fail — that is the point of checking here, because a field that lands off the page is accepted and emailed. The source render must have status 'success'; if its PDF has aged out of storage the call returns 410 and the fix is to re-render. Read-only. Requires a Kamy API key with the `signatures:read` scope; without a key, returns dashboard setup instructions.
| Argument | Type | Description |
|---|---|---|
| renderId* | string | Render UUID whose real page sizes the fields are checked against. |
| placedFields* | array | Up to 100 fields to validate. Exactly the shape create_signature_request takes — same seven types, same `anchor` and `options` support — so a layout that previews clean is a layout that sends. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"renderId",
"placedFields"
],
"properties": {
"renderId": {
"type": "string",
"format": "uuid",
"description": "Render UUID whose real page sizes the fields are checked against."
},
"placedFields": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"type",
"page",
"x",
"y",
"w",
"h"
],
"properties": {
"h": {
"type": "number",
"maximum": 800,
"minimum": 8,
"description": "Height in PDF points."
},
"w": {
"type": "number",
"maximum": 800,
"minimum": 8,
"description": "Width in PDF points."
},
"x": {
"type": "number",
"maximum": 2000,
"minimum": 0,
"description": "Bottom-left x in PDF points — an offset from the anchor when `anchor` is set."
},
"y": {
"type": "number",
"maximum": 2000,
"minimum": 0,
"description": "Bottom-left y in PDF points — an offset from the anchor when `anchor` is set."
},
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Unique field name within the request."
},
"page": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "1-indexed page number."
},
"type": {
"enum": [
"text",
"textarea",
"checkbox",
"date",
"initials",
"radio",
"dropdown"
],
"type": "string",
"description": "Widget the signer sees. `radio` and `dropdown` also need `options`. Every type here is accepted by both create_signature_request and preview_field_placement."
},
"anchor": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Text to position this field against. The server searches only the page named in `page` (case-insensitive, first match wins) and uses that text's bottom-left corner as the origin, adding x/y as offsets. If the text is not on that page the field silently falls back to the raw x/y — call preview_field_placement first to find out, where the miss comes back as an ANCHOR_NOT_FOUND issue."
},
"options": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"maxItems": 50,
"minItems": 1,
"description": "Valid choices for radio / dropdown. Ignored for other types."
},
"required": {
"type": "boolean"
},
"signerLabel": {
"type": "string",
"maxLength": 200,
"description": "Which signer this field belongs to."
},
"defaultValue": {
"type": "string",
"maxLength": 2000
},
"sourcePageWidth": {
"type": "number",
"maximum": 7200,
"minimum": 72,
"description": "Page width the coordinates were measured against. Supply with sourcePageHeight."
},
"sourcePageHeight": {
"type": "number",
"maximum": 7200,
"minimum": 72,
"description": "Page height the coordinates were measured against. Supply with sourcePageWidth."
}
},
"additionalProperties": false
},
"maxItems": 100,
"description": "Up to 100 fields to validate. Exactly the shape create_signature_request takes — same seven types, same `anchor` and `options` support — so a layout that previews clean is a layout that sends."
}
},
"additionalProperties": false
}Make a template version live for rendering. Called with no `version`, it snapshots the current draft into a new version and points published_version at it — this is how you ship an edit made with update_template. Called with an existing `version`, it republishes that earlier snapshot and leaves the draft alone. Reach for rollback_template instead when you are reverting a bad release: only that tool offers the concurrency fence and the option to restore the draft as well. Takes a template UUID or slug, same as every other /v1/templates route. Returns { templateId, publishedVersion, publishedVersionId, latestVersion, publishedAt }. Requires a Kamy API key with the `templates:write` scope; without a key, returns dashboard setup instructions.
| Argument | Type | Description |
|---|---|---|
| version | integer | Omit to snapshot the current draft into a new version and publish that. Supply an existing version number to republish a known-good earlier snapshot, leaving the draft untouched. |
| templateId* | string | Template UUID or slug — every /v1/templates route resolves either. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"templateId"
],
"properties": {
"version": {
"type": "integer",
"description": "Omit to snapshot the current draft into a new version and publish that. Supply an existing version number to republish a known-good earlier snapshot, leaving the draft untouched.",
"exclusiveMinimum": 0
},
"templateId": {
"type": "string",
"minLength": 1,
"description": "Template UUID or slug — every /v1/templates route resolves either."
}
},
"additionalProperties": false
}Append one signed tool_call -> tool_result pair to a tamper-evident ledger. Call it after any consequential tool invocation — a payment, an outbound email, a write into a customer system — so there is a hash-chained record of what the agent asked for and what came back, signed at write time. Pass a stable run_id to keep an entire agent run in one chain, and parent_sha256 to link records explicitly; read the result back with get_provenance_chain. Returns { record_id, content_sha256, signature, recorded_at, verify_url }. Requires a Kamy API key.
| Argument | Type | Description |
|---|---|---|
| tool* | string | Name of the tool that was invoked. |
| run_id | string | Your identifier for this agent run. Reuse it across records to build one chain. |
| server* | string | Identifier of the MCP server (or tool provider) the call went to, e.g. 'kamy'. |
| status | string | Outcome of the call. Defaults to ok. |
| tool_call | any | The request you sent — typically the arguments object, verbatim. |
| latency_ms | integer | Wall-clock duration of the call. |
| tool_result | any | The result you received back, verbatim. |
| parent_sha256 |
Resend the signature invitation email. Pass signatureRequestId to nudge one signer, or envelopeId to nudge every currently-pending recipient of an envelope — supply exactly one; there is no separate envelope-reminder tool. This sends real email to third parties. Each recipient is capped at one reminder per hour: the single-request form returns 429 REMIND_TOO_SOON with a Retry-After header, while the envelope form silently skips capped recipients and reports skipped_reason per row, so read the per-recipient results rather than assuming everyone was mailed. Only pending recipients are reminded — signed, voided and expired requests return 409, and sequential recipients still in 'waiting' are skipped because it is not their turn. A manual nudge also counts toward the three-reminder auto-cadence cap. Requires a Kamy API key with the `signatures:write` scope; without a key, returns dashboard setup instructions.
| Argument | Type | Description |
|---|---|---|
| envelopeId | string | Nudge every currently-pending recipient of this envelope. Supply exactly one of signatureRequestId or envelopeId. |
| signatureRequestId | string | Nudge this one signer. Supply exactly one of signatureRequestId or envelopeId. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"envelopeId": {
"type": "string",
"format": "uuid",
"description": "Nudge every currently-pending recipient of this envelope. Supply exactly one of signatureRequestId or envelopeId."
},
"signatureRequestId": {
"type": "string",
"format": "uuid",
"description": "Nudge this one signer. Supply exactly one of signatureRequestId or envelopeId."
}
},
"additionalProperties": false
}Queue one PDF render and return immediately with { jobId, status: 'queued' } instead of waiting for the document. Choose this over render_pdf when blocking is not acceptable — a heavy template, a large data set, or a turn where you have other work to do — and poll get_job with the returned jobId until status is 'completed' (the finished render, including its download URL, arrives on the job) or 'failed'. Choose render_pdf when a single document is small enough that waiting a few seconds is fine and you want the URL in one call, and render_batch when you have many documents to make at once. Same template, data and page options as render_pdf, and the same one render from the monthly quota — the quota is checked when the job is accepted, so an over-quota call fails here with 402 rather than silently queueing.
| Argument | Type | Description |
|---|---|---|
| data* | object | Data used to populate the template. |
| name | string | Your own label for this document. Echoed back on the job result and stored on the render, so list_renders can be grepped by it later. |
| pdf_a | string | Convert the output to a PDF/A archival conformance level. |
| format | string | Paper size. Defaults to a4. |
| margin | object | CSS lengths, e.g. { top: '20mm', bottom: '20mm' }. |
| metadata | object | PDF document properties written into the file's metadata dictionary. |
Render up to 100 documents in a single blocking call, each from its own template, HTML or URL, and get every result back in one response. Choose this over calling render_pdf in a loop whenever you have more than a couple of documents — it is one round trip, one quota reservation and one rate-limit charge. It does block: items render sequentially inside a 300-second budget, so expect to wait, and reach for render_async instead when you cannot. Returns { results: [...] } in request order, where each entry is either a finished render or an { error: { code, message } } — a partial batch is normal and successful items are still yours. The whole batch's quota is reserved up front, so a batch that would cross the monthly quota is rejected in full with 402 and nothing is rendered; call get_account first if you are near the limit. Items that would overrun the time budget come back as SERVICE_UNAVAILABLE having been neither rendered nor billed — retry just those in a smaller batch.
| Argument | Type | Description |
|---|---|---|
| items* | array | 1-100 documents to render, in order. Results come back in this same order. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "Public https URL to render. Private, loopback and link-local hosts are rejected. Supply exactly one of template, html, or url."
},
"data": {
"type": "object",
"description": "Data for the template or HTML. Ignored when rendering a url.",
"additionalProperties": {}
},
"html": {
"type": "string",
"maxLength": 5000000,
"minLength": 1,
"description": "Raw HTML to render. Handlebars expressions in it are populated from `data`. Supply exactly one of template, html, or url."
},
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Your own label for this one document, stored on the render and shown by list_renders."
},
"format": {
"enum": [
"a4",
"a3",
"letter",
"legal"
],
"type": "string",
"description": "Paper size. Defaults to a4."
},
"margin": {
"type": "object",
"properties": {
"top": {
"type": "string",
"maxLength": 20
},
"left": {
"type": "string",
"maxLength": 20
},
"right": {
"type": "string",
"maxLength": 20
},
"bottom": {
"type": "string",
"maxLength": 20
}
},
"description": "CSS lengths, e.g. { top: '20mm' }.",
"additionalProperties": false
},
"template": {
"type": "string",
"minLength": 1,
"description": "Template slug or UUID. Supply exactly one of template, html, or url for each item."
},
"direction": {
"enum": [
"auto",
"ltr",
"rtl"
],
"type": "string",
"description": "Text direction. 'auto' detects RTL scripts. Per item, so one batch can mix both."
},
"orientation": {
"enum": [
"portrait",
"landscape"
],
"type": "string",
"description": "Defaults to portrait."
},
"page_numbers": {
"type": "boolean",
"description": "Print page numbers in the footer."
}
},
"additionalProperties": false
},
"maxItems": 100,
"minItems": 1,
"description": "1-100 documents to render, in order. Results come back in this same order."
}
},
"additionalProperties": false
}Render an editable Word (.docx) document from a Kamy template and data. Takes the same { template, data } payload as render_pdf but produces a different container — reach for it when the recipient has to EDIT the document (legal redlines, Word-based intake, corporate templates) rather than receive a fixed artifact. Only five slugs have a Word implementation — invoice, receipt, quote, contract, agreement — and any other template is rejected with a validation error; use render_pdf for those. Returns { id, url, bytes, durationMs, format: 'docx' }, where url is a signed download link valid for one hour and id is a normal render id. Counts one render against the monthly quota. Requires a Kamy API key with the `render` scope; without a key, returns dashboard setup instructions.
| Argument | Type | Description |
|---|---|---|
| data | object | Template data, identical in shape to the render_pdf payload for the same slug — call get_template_schema first to get the exact fields. |
| name | string | Label stored on the render row so the document is identifiable in the dashboard. |
| template* | string | Which built-in document to build. These five are the only slugs with a Word implementation; custom templates and other system templates are PDF-only (use render_pdf). |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"template"
],
"properties": {
"data": {
"type": "object",
"default": {},
"description": "Template data, identical in shape to the render_pdf payload for the same slug — call get_template_schema first to get the exact fields.",
"additionalProperties": {}
},
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Label stored on the render row so the document is identifiable in the dashboard."
},
"template": {
"enum": [
"invoice",
"receipt",
"quote",
"contract",
"agreement"
],
"type": "string",
"description": "Which built-in document to build. These five are the only slugs with a Word implementation; custom templates and other system templates are PDF-only (use render_pdf)."
}
},
"additionalProperties": false
}Compile a Kamy template — or raw Handlebars source you pass inline — against a data payload and get the rendered HTML string back. No browser runs, no PDF is produced and no file is stored, so this is the tool for piping a template into a transactional email provider, or for inspecting the markup before committing to render_pdf. Use render_pdf instead whenever the output has to be a paginated, printable artifact. Supply exactly one of template or html. Returns { format: 'html', html, bytes }. Paid-tier system templates are refused on the free plan. Counts one render against the monthly quota, since the compile step is the shared cost. Requires a Kamy API key with the `render` scope; without a key, returns dashboard setup instructions.
| Argument | Type | Description |
|---|---|---|
| data | object | Values substituted into the template's Handlebars expressions. |
| html | string | Raw Handlebars/HTML source to compile instead of a stored template. Supply exactly one of template or html. |
| template | string | Template slug or UUID — a Kamy system template or one of your own. Supply exactly one of template or html. |
| direction | string | Force the document's lang/dir attributes for RTL/bidi mail clients. 'auto' (default) leaves the template's own <html lang> untouched. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"data": {
"type": "object",
"default": {},
"description": "Values substituted into the template's Handlebars expressions.",
"additionalProperties": {}
},
"html": {
"type": "string",
"maxLength": 5000000,
"minLength": 1,
"description": "Raw Handlebars/HTML source to compile instead of a stored template. Supply exactly one of template or html."
},
"template": {
"type": "string",
"minLength": 1,
"description": "Template slug or UUID — a Kamy system template or one of your own. Supply exactly one of template or html."
},
"direction": {
"enum": [
"auto",
"ltr",
"rtl"
],
"type": "string",
"description": "Force the document's lang/dir attributes for RTL/bidi mail clients. 'auto' (default) leaves the template's own <html lang> untouched."
}
},
"additionalProperties": false
}Render a PDF from a Kamy template and data, and wait for it. This is the default document tool: it blocks until the file exists and hands back { id, url, bytes, durationMs, templateId, createdAt } in one call, where url is a signed download link valid for one hour and id is the render id every later tool takes. Reach for render_async instead when waiting is not acceptable, and render_batch when several documents are wanted at once. Call get_template_schema first if you are unsure what fields the template expects. Counts one render against the monthly quota — get_account tells you what is left before this fails with 402. Requires a Kamy API key with the `render` scope; without a key, returns dashboard setup instructions.
| Argument | Type | Description |
|---|---|---|
| data* | object | Data to populate the template |
| format | string | |
| template* | string | Template slug (e.g., 'invoice') or template UUID |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"template",
"data"
],
"properties": {
"data": {
"type": "object",
"description": "Data to populate the template",
"additionalProperties": {}
},
"format": {
"enum": [
"a4",
"letter"
],
"type": "string",
"default": "a4"
},
"template": {
"type": "string",
"description": "Template slug (e.g., 'invoice') or template UUID"
}
},
"additionalProperties": false
}Build a PowerPoint (.pptx) deck from a slide spec: an ordered array of slides, each tagged with one of five fixed layouts (title, bullets, two-column, table, quote). This is NOT a template renderer like render_pdf / render_docx — there is no template slug and no free-form layout, so content has to be shaped into those five. It also converts nothing; use convert_document to turn a file you already have into a PDF. Returns a stored render { id, url, bytes, durationMs, format } where url is a signed download link valid for one hour; the deck is a .pptx, so feed the id to convert_document if the next step needs a PDF (merge_pdfs, split_pdf and the signature tools take PDFs only). Counts one render against the monthly quota. Requires a Kamy API key with the `render` scope; without a key, returns dashboard setup instructions.
| Argument | Type | Description |
|---|---|---|
| theme | object | |
| title | string | Deck title — used as document metadata and as the returned filename stem. |
| format | string | WIDE = 16:9 (default), STANDARD = 4:3. |
| slides* | array | Ordered slides. Each carries a `layout` discriminator: 'title', 'bullets', 'two-column', 'table' or 'quote'. There is no free-form layout — content that doesn't fit one of the five should be reshaped into bullets or a table. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"slides"
],
"properties": {
"theme": {
"type": "object",
"properties": {
"fontFace": {
"type": "string",
"maxLength": 60,
"description": "Font family name. Defaults to Calibri."
},
"accentHex": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$",
"description": "Accent colour for the title bar, table header fill and column headings."
}
},
"additionalProperties": false
},
"title": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Deck title — used as document metadata and as the returned filename stem."
},
"format": {
"enum": [
"WIDE",
"STANDARD"
],
"type": "string",
"default": "WIDE",
"description": "WIDE = 16:9 (default), STANDARD = 4:3."
},
"slides": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"required": [
"layout",
"title"
],
"properties": {
"title": {
"type": "string",
"maxLength": 160,
"minLength": 1
},
"layout": {
"type": "string",
"const": "title"
},
"subtitle": {
"type": "string",
"maxLength": 200
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"layout",
"title",
"bullets"
],
"properties": {
"title": {
"type": "string",
"maxLength": 160,
"minLength": 1
},
"layout": {
"type": "string",
"const": "bullets"
},
"bullets": {
"type": "array",
"items": {
"type": "string",
"maxLength": 400,
"minLength": 1
},
"maxItems": 20,
"minItems": 1
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"layout",
"title",
"left",
"right"
],
"properties": {
"left": {
"type": "object",
"required": [
"bullets"
],
"properties": {
"title": {
"type": "string",
"maxLength": 80
},
"bullets": {
"type": "array",
"items": {
"type": "string",
"maxLength": 400
},
"maxItems": 12
}
},
"additionalProperties": false
},
"right": {
"$ref": "#/properties/slides/items/anyOf/2/properties/left"
},
"title": {
"type": "string",
"maxLength": 160,
"minLength": 1
},
"layout": {
"type": "string",
"const": "two-column"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"layout",
"title",
"headers",
"rows"
],
"properties": {
"rows": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string",
"maxLength": 120
},
"minItems": 1
},
"maxItems": 20,
"description": "Body rows, each an array of cell strings aligned to `headers`."
},
"title": {
"type": "string",
"maxLength": 160,
"minLength": 1
},
"layout": {
"type": "string",
"const": "table"
},
"headers": {
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"minLength": 1
},
"maxItems": 8,
"minItems": 1
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"layout",
"quote"
],
"properties": {
"quote": {
"type": "string",
"maxLength": 400,
"minLength": 1
},
"layout": {
"type": "string",
"const": "quote"
},
"attribution": {
"type": "string",
"maxLength": 120
}
},
"additionalProperties": false
}
]
},
"maxItems": 60,
"minItems": 1,
"description": "Ordered slides. Each carries a `layout` discriminator: 'title', 'bullets', 'two-column', 'table' or 'quote'. There is no free-form layout — content that doesn't fit one of the five should be reshaped into bullets or a table."
}
},
"additionalProperties": false
}Build an Excel (.xlsx) workbook from a sheet spec: columns with keys, row objects keyed to those columns, optional Excel number formats and a formula-aware total row (bare 'SUM' / 'AVG' / 'COUNT' / 'MIN' / 'MAX' expands into a real formula over the column's data range). Choose this over render_pdf when the recipient will sort, filter or recompute the numbers, and over render_docx when the content is tabular rather than prose. Returns a stored render { id, url, bytes, durationMs, format } where url is a signed download link valid for one hour; the workbook is a .xlsx, so feed the id to convert_document if the next step needs a PDF. Header rows are always bold on a tinted fill — there is no flag for it. Counts one render against the monthly quota. Requires a Kamy API key with the `render` scope; without a key, returns dashboard setup instructions.
| Argument | Type | Description |
|---|---|---|
| title | string | Workbook title — document metadata and the returned filename stem. |
| sheets* | array | One or more sheets, in tab order. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"sheets"
],
"properties": {
"title": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Workbook title — document metadata and the returned filename stem."
},
"sheets": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"columns",
"rows"
],
"properties": {
"name": {
"type": "string",
"maxLength": 31,
"minLength": 1,
"description": "Sheet tab name. Excel caps this at 31 characters."
},
"rows": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {}
},
"maxItems": 50000,
"description": "Data rows as objects keyed by the column `key`s."
},
"freeze": {
"type": "boolean",
"default": true,
"description": "Freeze the header row and first column. Default true."
},
"columns": {
"type": "array",
"items": {
"type": "object",
"required": [
"header",
"key"
],
"properties": {
"key": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Property name read off each row object — `row[key]` fills this column."
},
"width": {
"type": "number",
"maximum": 120,
"minimum": 2,
"description": "Column width in characters."
},
"header": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Header label rendered in row 1."
},
"numFmt": {
"type": "string",
"maxLength": 40,
"description": "Excel number-format string applied to every cell in the column, e.g. '#,##0.00' for money, '0.00%' for percent, 'yyyy-mm-dd' for dates."
}
},
"additionalProperties": false
},
"maxItems": 64,
"minItems": 1
},
"totalRow": {
"type": "object",
"description": "Optional bold, top-bordered footer row keyed by column key. A bare aggregator keyword ('SUM', 'AVG', 'COUNT', 'MIN', 'MAX') is expanded into a real formula over that column's data range; a string starting with '=' is passed to Excel verbatim; anything else lands as a literal, which is how you write a label like { name: 'Total' }.",
"additionalProperties": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
}
},
"additionalProperties": false
},
"maxItems": 20,
"minItems": 1,
"description": "One or more sheets, in tab order."
}
},
"additionalProperties": false
}Revert a template after a bad release: repoints published_version at the version you name, so every subsequent render immediately serves that snapshot again. Prefer this over publish_template's `version` argument whenever you are reverting, because only this tool takes expectedPublishedVersion — an optimistic fence that rejects with 409 VERSION_CONFLICT if someone moved the pointer since you read it — and only this tool can restore the working draft too. restoreDraft: true overwrites the draft html/css/schema with that version's content, auto-snapshotting the existing draft into a fresh version first so unsaved work is recoverable; it defaults to false. Destructive: it changes what production renders, and there is no undo beyond rolling forward again. Takes a template UUID or slug. Requires a Kamy API key with the `templates:write` scope; without a key, returns dashboard setup instructions.
| Argument | Type | Description |
|---|---|---|
| version* | integer | The known-good version to make live again. Get it from list_template_versions. |
| templateId* | string | Template UUID or slug — every /v1/templates route resolves either. |
| restoreDraft | boolean | When true, also overwrite the working draft (html/css/schema) with that version's content. The current draft is auto-snapshotted into a new version first, unless it is already byte-identical. Defaults to false, which leaves in-flight edits alone. |
| expectedPublishedVersion | integer | Optimistic fence: the published_version you believe is live (0 if never published). The call is rejected with 409 VERSION_CONFLICT if someone moved the pointer in the meantime. Pass it whenever you read the state in an earlier step. |
Heuristic pattern scan of MCP tool description text for prompt-injection tells — instructions addressed at the reading model, data-exfiltration hints, attempts to override your system prompt or hide content. Run it on descriptions from third-party MCP servers before you act on what they say. Returns risk 'low' | 'medium' | 'high' and the matched findings with excerpts. This is a heuristic aid, NOT a security boundary: a 'low' verdict is not evidence that a tool is safe, and an injection phrased to avoid the patterns will score low. Do not treat any result here as clearance to trust an untrusted tool — keep your own judgement and human review in the loop. Read-only: it analyses only the text you pass in and fetches nothing. Requires a Kamy API key.
| Argument | Type | Description |
|---|---|---|
| tools | array | Several tools at once — e.g. the entries of a `tools/list` result. Supply description, tools, or both. |
| description | string | A single tool description to scan. Supply description, tools, or both. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"tools": {
"type": "array",
"items": {
"type": "object",
"required": [
"description"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"description": "Tool name, echoed back in findings."
},
"description": {
"type": "string",
"maxLength": 20000,
"description": "The tool's description text."
}
},
"additionalProperties": true
},
"maxItems": 200,
"description": "Several tools at once — e.g. the entries of a `tools/list` result. Supply description, tools, or both."
},
"description": {
"type": "string",
"maxLength": 20000,
"minLength": 1,
"description": "A single tool description to scan. Supply description, tools, or both."
}
},
"additionalProperties": false
}Extract page ranges from one existing render into separate new PDFs — the inverse of merge_pdfs. Each range you pass produces its own render, returned in the same order, so one call can both halve a contract and peel off single pages. Omit a range's `to` to run to the end of the document; a range starting past the last page fails the entire call. The source render is left untouched. Returns { renders: [...], count }, each entry a normal render object usable with merge_pdfs, edit_pdf or the signature tools. Requires a Kamy API key with the `render` scope; without a key, returns dashboard setup instructions.
| Argument | Type | Description |
|---|---|---|
| ranges* | array | 1–50 page ranges; each produces one output render, returned in this order. A range that starts past the last page fails the whole call. |
| renderId* | string | UUID of the completed render to split. Must belong to this account. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"renderId",
"ranges"
],
"properties": {
"ranges": {
"type": "array",
"items": {
"type": "object",
"required": [
"from"
],
"properties": {
"to": {
"type": "integer",
"minimum": 1,
"description": "1-based last page, inclusive. Omit to run to the end of the document."
},
"from": {
"type": "integer",
"minimum": 1,
"description": "1-based first page, inclusive."
},
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Label for this output render."
}
},
"additionalProperties": false
},
"maxItems": 50,
"minItems": 1,
"description": "1–50 page ranges; each produces one output render, returned in this order. A range that starts past the last page fails the whole call."
},
"renderId": {
"type": "string",
"format": "uuid",
"description": "UUID of the completed render to split. Must belong to this account."
}
},
"additionalProperties": false
}Send a real test.ping event to a registered webhook endpoint — an actual outbound HTTP POST to whatever URL the user configured, signed like a genuine delivery. Use it to prove an endpoint is reachable and that signature verification works before relying on it. Delivery is dispatched in the background, so the { message: 'Test ping dispatched' } you get back means accepted for sending, not that the endpoint answered: wait a few seconds and call list_webhooks to read lastStatus and lastDeliveryAt for the real outcome. The ping is delivered regardless of which events the endpoint subscribes to.
| Argument | Type | Description |
|---|---|---|
| webhook_id* | string | Webhook endpoint id (UUID) from create_webhook or list_webhooks. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"webhook_id"
],
"properties": {
"webhook_id": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "Webhook endpoint id (UUID) from create_webhook or list_webhooks."
}
},
"additionalProperties": false
}Record one LLM call — prompt, output, provider, model, tokens, latency — into Kamy Trace, a signed retention ledger. Each record is hashed and signed at write time, so it can be produced later without the 'you could have edited this' objection. Reach for it when model calls need a reviewable history: regulated workflows, customer-facing generations, anything you may have to explain months later. Set status 'flagged' with status_detail on calls a human should revisit. Returns { id, content_sha256, signature, recorded_at, verify_url }. Requires a Kamy API key with the trace:record scope; each call consumes monthly Trace quota.
| Argument | Type | Description |
|---|---|---|
| tags | array | Up to 20 free-form labels. trace_search can filter on any one of them. |
| model* | string | Model identifier exactly as the provider reports it, e.g. 'claude-sonnet-4-6'. |
| output | any | The model's response, verbatim. Any JSON value. |
| prompt | any | The prompt / request you sent, verbatim. Any JSON value (string, array, object). |
| status | string | Outcome. 'flagged' marks a call you want a human to review later. Defaults to 'ok'. |
| feature | string | Product area the call belongs to, e.g. 'support_reply'. Filterable in trace_search. |
| provider* | string |
Write up to 100 Kamy Trace records in one call. Reach for this over trace_record whenever you have more than a couple of buffered LLM calls to persist — it is one auth, one quota check and one round trip instead of N. Each element takes exactly the shape trace_record takes. The whole batch is counted against the monthly Trace quota up front, so a batch that would cross the plan cap is rejected in full with 402 and nothing is stored; split it or upgrade rather than retrying. Returns { records: [{ id, content_sha256, signature, recorded_at, verify_url }] } in input order. Requires a Kamy API key with the `trace:record` scope; without a key, returns dashboard setup instructions.
| Argument | Type | Description |
|---|---|---|
| records* | array | 1–100 records, each exactly the shape trace_record takes. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"records"
],
"properties": {
"records": {
"type": "array",
"items": {
"type": "object",
"required": [
"provider",
"model"
],
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 64
},
"maxItems": 20,
"description": "Up to 20 free-form labels. trace_search can filter on any one of them."
},
"model": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Model identifier exactly as the provider reports it, e.g. 'claude-sonnet-4-6'."
},
"output": {
"description": "The model's response, verbatim. Any JSON value."
},
"prompt": {
"description": "The prompt / request you sent, verbatim. Any JSON value (string, array, object)."
},
"status": {
"enum": [
"ok",
"flagged",
"error"
],
"type": "string",
"description": "Outcome. 'flagged' marks a call you want a human to review later. Defaults to 'ok'."
},
"feature": {
"type": "string",
"maxLength": 120,
"description": "Product area the call belongs to, e.g. 'support_reply'. Filterable in trace_search."
},
"provider": {
"enum": [
"anthropic",
"openai",
"custom"
],
"type": "string",
"description": "Which model vendor served the call. Use 'custom' for anything self-hosted."
},
"latency_ms": {
"type": "integer",
"minimum": 0,
"description": "Wall-clock duration of the call."
},
"input_tokens": {
"type": "integer",
"minimum": 0,
"description": "Prompt tokens billed."
},
"output_tokens": {
"type": "integer",
"minimum": 0,
"description": "Completion tokens billed."
},
"status_detail": {
"type": "string",
"maxLength": 500,
"description": "Why the call was flagged or failed. Free text."
}
},
"additionalProperties": false
},
"maxItems": 100,
"minItems": 1,
"description": "1–100 records, each exactly the shape trace_record takes."
}
},
"additionalProperties": false
}Query this account's Kamy Trace records, newest first, filtered by feature, status, provider, tag, or time window. Returns record metadata — model, tokens, latency, status, content hash, recorded_at — plus next_cursor for paging; it does not return the stored prompt and output bodies. Use it to answer questions like 'how many flagged calls last week?' or to locate a specific record's id before opening it in the dashboard. Read-only. Requires a Kamy API key with the trace:read scope.
| Argument | Type | Description |
|---|---|---|
| tag | string | Return records whose tags array contains this tag. |
| limit | integer | Page size, 1-100. Default 25. |
| since | string | ISO-8601 timestamp, inclusive lower bound. |
| until | string | ISO-8601 timestamp, exclusive upper bound. |
| cursor | string | Pass the `next_cursor` from the previous response to fetch the next page. |
| status | string | Exact-match filter on outcome. |
| feature | string | Exact-match filter on the feature label. |
| provider | string |
Edit an existing custom template's DRAFT — name, html, css, schema, tags, visibility — addressed by UUID or slug. Only the fields you pass are changed. Crucially, this does not change what renders once the template has been published even once: while published_version is set, render_pdf serves that frozen snapshot and your edits stay invisible until publish_template moves the pointer, so an edit that appears to do nothing usually needs a publish. System templates, and templates belonging to another account, return 403. Requires a Kamy API key with the `templates:write` scope; without a key, returns dashboard setup instructions.
| Argument | Type | Description |
|---|---|---|
| css | string | Replaces the draft CSS entirely. |
| html | string | Replaces the draft HTML entirely. |
| name | string | |
| tags | array | |
| schema | object | Replaces the draft JSON Schema entirely. |
| isPublic | boolean | |
| template* | string | Template UUID or slug. This route accepts either. |
| description | string |
Store an image, font or PDF in the account's asset bucket and get back a `kamy://asset/<id>` reference you can drop anywhere inside a render_pdf / render_html data payload — Kamy swaps it for a fresh signed URL at render time. That reference is the point of this tool: it is how a logo, signature image or custom font gets into a template without hosting it yourself. Pass contentBase64 and this server performs the upload for you, returning { id, assetRef, bytes, uploaded: true }. Omit contentBase64 for files too big to pass through a tool call and you get the raw slot instead — { uploadUrl, uploadMethod, uploadHeaders, expiresAt, uploaded: false } — then PUT the bytes yourself within 15 minutes. Inline uploads are capped at 5 MB here; the API itself allows 100 MB via that URL. Only the listed MIME types are accepted. Requires a Kamy API key with the `uploads:write` scope; without a key, returns dashboard setup instructions.
| Argument | Type | Description |
|---|---|---|
| filename* | string | Name to store the asset under. Characters outside [A-Za-z0-9._-] are replaced with '_'. |
| sizeBytes | integer | Declared size in bytes. Computed automatically when contentBase64 is supplied. Max 100 MB. |
| contentType* | string | MIME type. The API rejects anything outside this list. |
| contentBase64 | string | Base64 bytes to upload. When supplied, this server PUTs them to the pre-signed URL and the asset is immediately usable. Omit for files too large to pass through a tool call — you then get uploadUrl back and PUT the bytes yourself within 15 minutes. |
Dry-run a render payload against a template's schema WITHOUT producing a PDF or using quota. Returns per-field self-healing errors (expected type, value received, allowed values, an example) so you can fix the data before render_pdf. Requires a Kamy API key.
| Argument | Type | Description |
|---|---|---|
| data* | object | The data payload to validate against the template schema. |
| template* | string | Template slug (e.g. 'invoice') or template UUID. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"template",
"data"
],
"properties": {
"data": {
"type": "object",
"description": "The data payload to validate against the template schema.",
"additionalProperties": {}
},
"template": {
"type": "string",
"description": "Template slug (e.g. 'invoice') or template UUID."
}
},
"additionalProperties": false
}Ask Kamy whether a SHA-256 digest has an attestation on record — the tool that actually returns a verdict. Takes a digest, not a file: if what you hold is a PDF, run verify_pdf_signature over the bytes first and pass the sha256 it gives you. A match returns { verified: true, artifact_type, recorded_at, signature, public_key }. A false result means no attestation exists for those exact bytes, which happens both when content was altered after attestation and when it was simply never attested; it does not by itself identify tampering or a culprit. Public surface — like the extract_document verify URL, no API key is required, so a recipient can confirm an artifact independently of whoever sent it.
| Argument | Type | Description |
|---|---|---|
| hash* | string | SHA-256 of the artifact you want to check, as hex. Hash the bytes you actually hold — if they were modified after attestation, the digest won't match any record and `verified` comes back false. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"hash"
],
"properties": {
"hash": {
"type": "string",
"pattern": "^[0-9a-f]{64}$",
"description": "SHA-256 of the artifact you want to check, as hex. Hash the bytes you actually hold — if they were modified after attestation, the digest won't match any record and `verified` comes back false."
}
},
"additionalProperties": false
}Detect when an MCP server changes its tool manifest after you adopted it — the 'rug pull' case, where a server you already trusted silently rewrites a tool's description or input schema. Pass server_url and Kamy fetches that third-party server's manifest itself, or pass manifest when you already hold it (local or private servers). Returns status 'new' (first fingerprint for this account — nothing to compare against yet), 'unchanged', or 'mutated', plus a per-tool changes list with previous and current hashes. 'unchanged' means only that it matches what Kamy recorded previously; it is not a judgement that the server is trustworthy, and a first-ever 'new' result establishes a baseline rather than clearing anything. Requires a Kamy API key.
| Argument | Type | Description |
|---|---|---|
| manifest | any | A tool manifest you already hold — the `tools/list` result, or an object with a `tools` array. Use this when the server isn't reachable from Kamy (local stdio server, private network). Supply either server_url or manifest. |
| server_url | string | URL of the MCP server to fingerprint. Kamy fetches its tool manifest server-side. Supply either server_url or manifest. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"manifest": {
"description": "A tool manifest you already hold — the `tools/list` result, or an object with a `tools` array. Use this when the server isn't reachable from Kamy (local stdio server, private network). Supply either server_url or manifest."
},
"server_url": {
"type": "string",
"format": "uri",
"description": "URL of the MCP server to fingerprint. Kamy fetches its tool manifest server-side. Supply either server_url or manifest."
}
},
"additionalProperties": false
}Turn PDF bytes you are holding into their SHA-256 digest and the matching kamy.dev/verify/{sha256} page URL. Purely local: the MCP Worker hashes the base64 in memory, makes no Kamy API call, stores nothing and forwards nothing, so it works with no key and never leaves a trace. Note it returns no verdict — it does not tell you whether the document is genuine, signed, or on record anywhere. It is the first half of a check: take the sha256 it returns and pass it to verify_attestation for the actual yes/no, or hand a person the verify_url to open. Use this whenever you have the file itself; use verify_attestation directly when someone has already given you a digest.
| Argument | Type | Description |
|---|---|---|
| pdfBase64* | string | Base64-encoded PDF bytes. The MCP Worker hashes the file in-memory and does not store or forward it. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"pdfBase64"
],
"properties": {
"pdfBase64": {
"type": "string",
"minLength": 1,
"description": "Base64-encoded PDF bytes. The MCP Worker hashes the file in-memory and does not store or forward it."
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"artifact_type"
],
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 64
},
"maxItems": 20,
"description": "Up to 20 free-form labels."
},
"run_id": {
"type": "string",
"maxLength": 200,
"description": "Your identifier for the agent run this artifact belongs to. Pass the same run_id across attestations and agent-action records to build one provenance chain readable via get_provenance_chain."
},
"feature": {
"type": "string",
"maxLength": 120,
"description": "Product area or pipeline name, for grouping attestations."
},
"metadata": {
"type": "object",
"description": "Arbitrary JSON stored alongside the attestation (model, source URL, reviewer, ...).",
"additionalProperties": {}
},
"content_text": {
"type": "string",
"minLength": 1,
"description": "UTF-8 text artifact. Convenience input: this MCP server base64-encodes it locally and sends it as content_base64 — no other transformation is applied. Supply exactly one of content_sha256, content_base64, or content_text."
},
"artifact_type": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "What kind of output this is, e.g. 'pdf', 'report', 'code_patch', 'dataset', 'email', 'llm_output'. Free-form label used for filtering later."
},
"parent_sha256": {
"$ref": "#/properties/content_sha256",
"description": "content_sha256 of the preceding record in the chain, when this artifact was derived from an earlier one."
},
"content_base64": {
"type": "string",
"minLength": 1,
"description": "Base64-encoded artifact bytes. Use for binary output (PDF, image, archive). Supply exactly one of content_sha256, content_base64, or content_text."
},
"content_sha256": {
"type": "string",
"pattern": "^[0-9a-f]{64}$",
"description": "SHA-256 of the artifact bytes, when you'd rather not send the content itself. Supply exactly one of content_sha256, content_base64, or content_text."
}
},
"additionalProperties": false
}| integer |
| Sign-link lifetime in seconds. Min 1 hour, max 30 days. Defaults to 7 days. |
| reminderCadenceHours | integer | Auto-reminder cadence in hours, shared across the batch. Up to 3 reminders. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"renderId",
"signers"
],
"properties": {
"message": {
"type": "string",
"maxLength": 2000,
"description": "Shared invite message. `{{signerName}}` is substituted per recipient."
},
"signers": {
"type": "array",
"items": {
"type": "object",
"required": [
"signerEmail",
"signerName"
],
"properties": {
"ccEmails": {
"type": "array",
"items": {
"type": "string",
"format": "email",
"maxLength": 200
},
"maxItems": 10,
"description": "Up to 10 observers CC'd on this signer's invite. Not signers themselves."
},
"signerName": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Recipient full name. They must type it verbatim to confirm intent."
},
"signerEmail": {
"type": "string",
"format": "email",
"maxLength": 200,
"description": "Recipient email. Must be unique in the batch."
}
},
"additionalProperties": false
},
"maxItems": 100,
"minItems": 1,
"description": "1–100 signers. Duplicate emails are rejected up front with 422."
},
"position": {
"type": "object",
"properties": {
"h": {
"type": "number",
"maximum": 400,
"minimum": 20
},
"w": {
"type": "number",
"maximum": 800,
"minimum": 40
},
"x": {
"type": "number",
"maximum": 2000,
"minimum": 0
},
"y": {
"type": "number",
"maximum": 2000,
"minimum": 0
},
"page": {
"type": "integer",
"maximum": 500,
"minimum": 1
}
},
"description": "One signature rectangle in PDF points (origin bottom-left) shared by every signer.",
"additionalProperties": false
},
"renderId": {
"type": "string",
"format": "uuid",
"description": "Render UUID every signer receives. One render, one storage object, many requests."
},
"expiresIn": {
"type": "integer",
"maximum": 2592000,
"minimum": 3600,
"description": "Sign-link lifetime in seconds. Min 1 hour, max 30 days. Defaults to 7 days."
},
"reminderCadenceHours": {
"type": "integer",
"maximum": 168,
"minimum": 24,
"description": "Auto-reminder cadence in hours, shared across the batch. Up to 3 reminders."
}
},
"additionalProperties": false
}| ccEmails | array | Up to 10 observers CC'd on the invitations. Not signers. |
| position | object | Default signature placement in PDF points, origin bottom-left. |
| renderId | string | UUID of a completed render owned by this account. Supply exactly one of renderId or pdfUrl. |
| expiresIn | integer | Sign-link lifetime in seconds. Min 1 hour, max 30 days. |
| recipients* | array | 2–10 signers. The route rejects a single recipient — use create_signature_request for one signer. |
| placedFields | array | Up to 100 sender-placed form fields for signers to complete. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"recipients"
],
"properties": {
"pdfUrl": {
"type": "string",
"format": "uri",
"description": "Publicly fetchable PDF URL. Kamy downloads it and stores it as a render first. Supply exactly one of renderId or pdfUrl."
},
"message": {
"type": "string",
"maxLength": 500,
"description": "Message included in every invitation email."
},
"preview": {
"type": "boolean",
"description": "When true, creates the envelope and returns every sign URL WITHOUT emailing anyone and without consuming signature quota. Use it to check placement and routing before the real send."
},
"routing": {
"enum": [
"parallel",
"sequential"
],
"type": "string",
"default": "parallel",
"description": "'parallel' (default) emails everyone at once and each signs independently. 'sequential' emails only the lowest-order recipient; the rest are created with status 'waiting' and activated one at a time as the preceding signer completes."
},
"ccEmails": {
"type": "array",
"items": {
"type": "string",
"format": "email"
},
"maxItems": 10,
"description": "Up to 10 observers CC'd on the invitations. Not signers."
},
"position": {
"type": "object",
"properties": {
"h": {
"type": "number",
"maximum": 400,
"minimum": 20
},
"w": {
"type": "number",
"maximum": 800,
"minimum": 40
},
"x": {
"type": "number",
"maximum": 2000,
"minimum": 0
},
"y": {
"type": "number",
"maximum": 2000,
"minimum": 0
},
"page": {
"type": "integer",
"maximum": 500,
"minimum": 1
}
},
"description": "Default signature placement in PDF points, origin bottom-left.",
"additionalProperties": false
},
"renderId": {
"type": "string",
"format": "uuid",
"description": "UUID of a completed render owned by this account. Supply exactly one of renderId or pdfUrl."
},
"expiresIn": {
"type": "integer",
"maximum": 2592000,
"minimum": 3600,
"description": "Sign-link lifetime in seconds. Min 1 hour, max 30 days."
},
"recipients": {
"type": "array",
"items": {
"type": "object",
"required": [
"email",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Signer's full name. They must type it verbatim to confirm intent."
},
"email": {
"type": "string",
"format": "email"
},
"order": {
"type": "integer",
"minimum": 1,
"description": "Signing position. Drives who goes first under sequential routing; ignored for ordering purposes under parallel routing. Defaults to array order."
},
"message": {
"type": "string",
"maxLength": 500,
"description": "Per-recipient note in the invitation email, overriding the envelope-level message."
}
},
"additionalProperties": false
},
"maxItems": 10,
"minItems": 2,
"description": "2–10 signers. The route rejects a single recipient — use create_signature_request for one signer."
},
"placedFields": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"type",
"page",
"x",
"y",
"w",
"h"
],
"properties": {
"h": {
"type": "number",
"maximum": 800,
"minimum": 8,
"description": "Height in PDF points."
},
"w": {
"type": "number",
"maximum": 800,
"minimum": 8,
"description": "Width in PDF points."
},
"x": {
"type": "number",
"maximum": 2000,
"minimum": 0,
"description": "Bottom-left x in PDF points."
},
"y": {
"type": "number",
"maximum": 2000,
"minimum": 0,
"description": "Bottom-left y in PDF points."
},
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Unique field name within the envelope."
},
"page": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "1-indexed page number."
},
"type": {
"enum": [
"text",
"textarea",
"checkbox",
"date",
"initials",
"radio",
"dropdown"
],
"type": "string"
},
"anchor": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Text anchor — the server locates this string in the PDF and uses its position."
},
"options": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"maxItems": 50,
"minItems": 1,
"description": "Valid choices for radio / dropdown."
},
"required": {
"type": "boolean"
},
"signerLabel": {
"type": "string",
"maxLength": 200,
"description": "Which signer this field belongs to."
},
"defaultValue": {
"type": "string",
"maxLength": 2000
},
"sourcePageWidth": {
"type": "number",
"maximum": 7200,
"minimum": 72,
"description": "Page width the coordinates were measured against, for rescaling."
},
"sourcePageHeight": {
"type": "number",
"maximum": 7200,
"minimum": 72,
"description": "Page height the coordinates were measured against, for rescaling."
}
},
"additionalProperties": false
},
"maxItems": 100,
"description": "Up to 100 sender-placed form fields for signers to complete."
}
},
"additionalProperties": false
}| string |
| Standard 5-field cron expression, e.g. '0 9 * * 1' for 09:00 every Monday. Rejected with a validation error if it fires more often than the plan's minimum interval. |
| template* | string | Template slug or UUID rendered on every firing. Same values render_pdf accepts. |
| timezone | string | IANA timezone the cron expression is evaluated in, e.g. 'Asia/Dubai'. Defaults to UTC. |
| recipients | array | Email addresses or phone numbers, matching the channel. Required and non-empty for email and whatsapp; ignored for download. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"template",
"schedule",
"channel"
],
"properties": {
"data": {
"type": "object",
"description": "Template data, used verbatim on every firing. Defaults to {}.",
"additionalProperties": {}
},
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Human label for this schedule, shown in the dashboard."
},
"channel": {
"enum": [
"email",
"whatsapp",
"download"
],
"type": "string",
"description": "Where each rendered document goes. 'download' just stores it (find it later with list_renders); 'email' and 'whatsapp' require recipients."
},
"enabled": {
"type": "boolean",
"description": "Defaults to true. Create it disabled to set it up now and start it later."
},
"options": {
"type": "object",
"description": "Render options passed straight through to the render, in the nested /v1/render shape, e.g. { format: 'letter', margin: { top: '20mm' } }.",
"additionalProperties": {}
},
"schedule": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Standard 5-field cron expression, e.g. '0 9 * * 1' for 09:00 every Monday. Rejected with a validation error if it fires more often than the plan's minimum interval."
},
"template": {
"type": "string",
"maxLength": 80,
"minLength": 1,
"description": "Template slug or UUID rendered on every firing. Same values render_pdf accepts."
},
"timezone": {
"type": "string",
"maxLength": 64,
"minLength": 1,
"description": "IANA timezone the cron expression is evaluated in, e.g. 'Asia/Dubai'. Defaults to UTC."
},
"recipients": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"description": "Email addresses or phone numbers, matching the channel. Required and non-empty for email and whatsapp; ignored for download."
}
},
"additionalProperties": false
}| Recipient full name. Must be typed verbatim by the signer to confirm intent. |
| signerEmail* | string | Recipient email address. |
| signerPhone | string | E.164 phone number. Required when `authMethod` is `sms_otp`; ignored otherwise. Example: `+14155551234`. |
| placedFields | array | Up to 100 sender-defined fillable fields stamped onto the PDF at sign time. Use for flat PDFs that don't ship AcroForm widgets. Names must be unique. |
| requireStamp | boolean | Require the signer to upload a company stamp / seal alongside their personal signature (UAE, KSA, JP, KR, IN, CN B2B workflows). Server refuses to seal without one. |
| signOnEveryPage | boolean | When true, the server stamps the signer's signature on every page of the source PDF instead of only the configured position. Common B2B contract pattern. |
| signatureTemplateId | string | Apply a signature template's defaults (placedFields, position, message, expiresIn, ccEmails). Request-level fields override the template. |
| reminderCadenceHours | integer | When set (24–168), the auto-reminder cron resends the invite every N hours while the request stays pending, up to 3 reminders. Omit for no auto-reminders. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"renderId",
"signerEmail",
"signerName"
],
"properties": {
"message": {
"type": "string",
"maxLength": 500,
"description": "Optional message rendered in the email invitation body."
},
"ccEmails": {
"type": "array",
"items": {
"type": "string",
"format": "email"
},
"maxItems": 10,
"description": "Up to 10 observer addresses CC'd on the invite and the completion notice. Not signers themselves."
},
"position": {
"type": "object",
"properties": {
"h": {
"type": "number",
"maximum": 400,
"minimum": 20
},
"w": {
"type": "number",
"maximum": 800,
"minimum": 40
},
"x": {
"type": "number",
"maximum": 2000,
"minimum": 0
},
"y": {
"type": "number",
"maximum": 2000,
"minimum": 0
},
"page": {
"type": "integer",
"maximum": 500,
"minimum": 1
}
},
"description": "Optional sender-chosen signature placement in PDF points (72 dpi, origin bottom-left). Defaults to bottom-right of the last page sized 220×64 pt; when omitted, the signer can drag the placeholder on the sign page.",
"additionalProperties": false
},
"renderId": {
"type": "string",
"format": "uuid",
"description": "Render UUID returned by render_pdf or any /v1/render call. The render's PDF is the document the signer will receive."
},
"expiresIn": {
"type": "integer",
"maximum": 2592000,
"minimum": 3600,
"description": "How long (seconds) the sign link stays valid. Defaults to 30 days. Min 1 hour, max 30 days."
},
"authMethod": {
"enum": [
"link",
"sms_otp",
"email_otp"
],
"type": "string",
"description": "Identity-verification mode. `link` (default) — possession of the secret URL is the only check. `email_otp` — sign page renders a 6-digit OTP gate; code emailed to `signerEmail`. `sms_otp` — same gate, code texted to `signerPhone` (which must then be supplied). Recommend `email_otp` for higher-value transactions."
},
"signerName": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Recipient full name. Must be typed verbatim by the signer to confirm intent."
},
"signerEmail": {
"type": "string",
"format": "email",
"description": "Recipient email address."
},
"signerPhone": {
"type": "string",
"pattern": "^\\+[1-9]\\d{6,14}$",
"description": "E.164 phone number. Required when `authMethod` is `sms_otp`; ignored otherwise. Example: `+14155551234`."
},
"placedFields": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"type",
"page",
"x",
"y",
"w",
"h"
],
"properties": {
"h": {
"type": "number",
"maximum": 800,
"minimum": 8,
"description": "Height in PDF points."
},
"w": {
"type": "number",
"maximum": 800,
"minimum": 8,
"description": "Width in PDF points."
},
"x": {
"type": "number",
"maximum": 2000,
"minimum": 0,
"description": "Bottom-left x in PDF points — an offset from the anchor when `anchor` is set."
},
"y": {
"type": "number",
"maximum": 2000,
"minimum": 0,
"description": "Bottom-left y in PDF points — an offset from the anchor when `anchor` is set."
},
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Unique field name within the request."
},
"page": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "1-indexed page number."
},
"type": {
"enum": [
"text",
"textarea",
"checkbox",
"date",
"initials",
"radio",
"dropdown"
],
"type": "string",
"description": "Widget the signer sees. `radio` and `dropdown` also need `options`. Every type here is accepted by both create_signature_request and preview_field_placement."
},
"anchor": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Text to position this field against. The server searches only the page named in `page` (case-insensitive, first match wins) and uses that text's bottom-left corner as the origin, adding x/y as offsets. If the text is not on that page the field silently falls back to the raw x/y — call preview_field_placement first to find out, where the miss comes back as an ANCHOR_NOT_FOUND issue."
},
"options": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"maxItems": 50,
"minItems": 1,
"description": "Valid choices for radio / dropdown. Ignored for other types."
},
"required": {
"type": "boolean"
},
"signerLabel": {
"type": "string",
"maxLength": 200,
"description": "Which signer this field belongs to."
},
"defaultValue": {
"type": "string",
"maxLength": 2000
},
"sourcePageWidth": {
"type": "number",
"maximum": 7200,
"minimum": 72,
"description": "Page width the coordinates were measured against. Supply with sourcePageHeight."
},
"sourcePageHeight": {
"type": "number",
"maximum": 7200,
"minimum": 72,
"description": "Page height the coordinates were measured against. Supply with sourcePageWidth."
}
},
"additionalProperties": false
},
"maxItems": 100,
"description": "Up to 100 sender-defined fillable fields stamped onto the PDF at sign time. Use for flat PDFs that don't ship AcroForm widgets. Names must be unique."
},
"requireStamp": {
"type": "boolean",
"description": "Require the signer to upload a company stamp / seal alongside their personal signature (UAE, KSA, JP, KR, IN, CN B2B workflows). Server refuses to seal without one."
},
"signOnEveryPage": {
"type": "boolean",
"description": "When true, the server stamps the signer's signature on every page of the source PDF instead of only the configured position. Common B2B contract pattern."
},
"signatureTemplateId": {
"type": "string",
"format": "uuid",
"description": "Apply a signature template's defaults (placedFields, position, message, expiresIn, ccEmails). Request-level fields override the template."
},
"reminderCadenceHours": {
"type": "integer",
"maximum": 168,
"minimum": 24,
"description": "When set (24–168), the auto-reminder cron resends the invite every N hours while the request stays pending, up to 3 reminders. Omit for no auto-reminders."
}
},
"additionalProperties": false
}| isPublic | boolean | When true, other accounts can list and render it. Defaults to false. |
| description | string | What this template is for. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"name",
"slug",
"html"
],
"properties": {
"css": {
"type": "string",
"maxLength": 1000000,
"description": "Stylesheet applied at render time. Max 1 MB."
},
"html": {
"type": "string",
"maxLength": 5000000,
"minLength": 1,
"description": "Handlebars/HTML body of the document. Max 5 MB."
},
"name": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Human-readable template name."
},
"slug": {
"type": "string",
"pattern": "^[a-z0-9-]+$",
"maxLength": 80,
"minLength": 1,
"description": "Stable identifier the render tools take as `template`. Unique per account, and it may not collide with a built-in system slug (invoice, receipt, quote, …) — both cases are rejected with 422."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 10,
"description": "Up to 10 free-form labels."
},
"schema": {
"type": "object",
"description": "JSON Schema describing the data payload the template expects. Defaults to {}.",
"additionalProperties": {}
},
"isPublic": {
"type": "boolean",
"description": "When true, other accounts can list and render it. Defaults to false."
},
"description": {
"type": "string",
"maxLength": 500,
"description": "What this template is for."
}
},
"additionalProperties": false
}| UUID of an existing render owned by this account. Supply exactly one of renderId or pdfUrl. |
| operations* | array | 1–200 operations applied in the order given. 'fill_field' writes into an AcroForm widget; 'stamp_text' draws text at an absolute position; 'cover' paints an opaque rectangle over the region — it hides content visually but does NOT delete the underlying bytes, and the response carries a COVER_VISUAL_ONLY warning for every cover op. Anyone can still copy the text out from under the box. It is NOT redaction: never use it to hide secrets or personal data in a document you are about to hand out, and do not describe the result as redacted. There is no redaction operation — 'op: redact' is rejected with REDACTION_NOT_SUPPORTED. To remove sensitive data, regenerate the document without it. |
| flattenFields | boolean | Bake AcroForm values into the page content stream after the fill_field ops so they can no longer be edited. Leave true before e-signing. Pass false only when something downstream still needs the live form. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"operations"
],
"properties": {
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Label for the resulting render row."
},
"pdfUrl": {
"type": "string",
"format": "uri",
"description": "Publicly fetchable URL of a PDF Kamy has never seen. Kamy downloads it, applies the operations and stores only the edited result — the source does not become a separate render, and the call costs one render either way. Supply exactly one of renderId or pdfUrl."
},
"renderId": {
"type": "string",
"format": "uuid",
"description": "UUID of an existing render owned by this account. Supply exactly one of renderId or pdfUrl."
},
"operations": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"required": [
"op",
"field",
"value"
],
"properties": {
"op": {
"type": "string",
"const": "fill_field"
},
"field": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "AcroForm field name."
},
"value": {
"anyOf": [
{
"type": "string",
"maxLength": 2000
},
{
"type": "boolean"
}
],
"description": "Text value, or a boolean for checkbox widgets."
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"op",
"page",
"x",
"y",
"text"
],
"properties": {
"x": {
"type": "number",
"maximum": 10000,
"minimum": 0,
"description": "X in PDF points from the left edge."
},
"y": {
"type": "number",
"maximum": 10000,
"minimum": 0,
"description": "Y in PDF points from the BOTTOM edge."
},
"op": {
"type": "string",
"const": "stamp_text"
},
"page": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "1-based page number."
},
"text": {
"type": "string",
"maxLength": 2000,
"minLength": 1
},
"color": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$",
"description": "6-digit hex colour, e.g. '#101014'."
},
"fontSize": {
"type": "number",
"maximum": 300,
"minimum": 1
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"op",
"page",
"x",
"y",
"w",
"h"
],
"properties": {
"h": {
"type": "number",
"maximum": 10000,
"minimum": 1,
"description": "Rectangle height in points."
},
"w": {
"type": "number",
"maximum": 10000,
"minimum": 1,
"description": "Rectangle width in points."
},
"x": {
"type": "number",
"maximum": 10000,
"minimum": 0,
"description": "X in PDF points from the left edge."
},
"y": {
"type": "number",
"maximum": 10000,
"minimum": 0,
"description": "Y in PDF points from the BOTTOM edge."
},
"op": {
"type": "string",
"const": "cover"
},
"page": {
"type": "integer",
"maximum": 500,
"minimum": 1,
"description": "1-based page number."
},
"color": {
"$ref": "#/properties/operations/items/anyOf/1/properties/color",
"description": "Fill colour of the box. Defaults to black."
}
},
"additionalProperties": false
}
]
},
"maxItems": 200,
"minItems": 1,
"description": "1–200 operations applied in the order given. 'fill_field' writes into an AcroForm widget; 'stamp_text' draws text at an absolute position; 'cover' paints an opaque rectangle over the region — it hides content visually but does NOT delete the underlying bytes, and the response carries a COVER_VISUAL_ONLY warning for every cover op. Anyone can still copy the text out from under the box. It is NOT redaction: never use it to hide secrets or personal data in a document you are about to hand out, and do not describe the result as redacted. There is no redaction operation — 'op: redact' is rejected with REDACTION_NOT_SUPPORTED. To remove sensitive data, regenerate the document without it."
},
"flattenFields": {
"type": "boolean",
"default": true,
"description": "Bake AcroForm values into the page content stream after the fill_field ops so they can no longer be edited. Leave true before e-signing. Pass false only when something downstream still needs the live form."
}
},
"additionalProperties": false
}| string |
| content_sha256 of the previous record in this run, to link the chain explicitly. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"server",
"tool"
],
"properties": {
"tool": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Name of the tool that was invoked."
},
"run_id": {
"type": "string",
"maxLength": 200,
"description": "Your identifier for this agent run. Reuse it across records to build one chain."
},
"server": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Identifier of the MCP server (or tool provider) the call went to, e.g. 'kamy'."
},
"status": {
"enum": [
"ok",
"error",
"flagged"
],
"type": "string",
"description": "Outcome of the call. Defaults to ok."
},
"tool_call": {
"description": "The request you sent — typically the arguments object, verbatim."
},
"latency_ms": {
"type": "integer",
"minimum": 0,
"description": "Wall-clock duration of the call."
},
"tool_result": {
"description": "The result you received back, verbatim."
},
"parent_sha256": {
"type": "string",
"pattern": "^[0-9a-f]{64}$",
"description": "content_sha256 of the previous record in this run, to link the chain explicitly."
}
},
"additionalProperties": false
}| template* |
| string |
| Template slug (e.g. 'invoice') or template UUID. Same values render_pdf accepts. |
| watermark | object | Draws your own diagonal watermark over every page. Unrelated to the free-plan Kamy watermark, which is applied regardless — see get_account.watermarkPolicy. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"template",
"data"
],
"properties": {
"data": {
"type": "object",
"description": "Data used to populate the template.",
"additionalProperties": {}
},
"name": {
"type": "string",
"maxLength": 120,
"minLength": 1,
"description": "Your own label for this document. Echoed back on the job result and stored on the render, so list_renders can be grepped by it later."
},
"pdf_a": {
"enum": [
"1b",
"2b",
"3b"
],
"type": "string",
"description": "Convert the output to a PDF/A archival conformance level."
},
"format": {
"enum": [
"a4",
"letter"
],
"type": "string",
"description": "Paper size. Defaults to a4."
},
"margin": {
"type": "object",
"properties": {
"top": {
"type": "string",
"maxLength": 20
},
"left": {
"type": "string",
"maxLength": 20
},
"right": {
"type": "string",
"maxLength": 20
},
"bottom": {
"type": "string",
"maxLength": 20
}
},
"description": "CSS lengths, e.g. { top: '20mm', bottom: '20mm' }.",
"additionalProperties": false
},
"metadata": {
"type": "object",
"properties": {
"title": {
"type": "string",
"maxLength": 500
},
"author": {
"type": "string",
"maxLength": 200
},
"creator": {
"type": "string",
"maxLength": 200
},
"subject": {
"type": "string",
"maxLength": 500
},
"keywords": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100
},
"maxItems": 50
}
},
"description": "PDF document properties written into the file's metadata dictionary.",
"additionalProperties": false
},
"template": {
"type": "string",
"minLength": 1,
"description": "Template slug (e.g. 'invoice') or template UUID. Same values render_pdf accepts."
},
"watermark": {
"type": "object",
"required": [
"text"
],
"properties": {
"text": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"angle": {
"type": "number",
"maximum": 180,
"minimum": -180
},
"opacity": {
"type": "number",
"maximum": 1,
"minimum": 0
},
"fontSize": {
"type": "number",
"maximum": 400,
"minimum": 4
}
},
"description": "Draws your own diagonal watermark over every page. Unrelated to the free-plan Kamy watermark, which is applied regardless — see get_account.watermarkPolicy.",
"additionalProperties": false
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"templateId",
"version"
],
"properties": {
"version": {
"type": "integer",
"description": "The known-good version to make live again. Get it from list_template_versions.",
"exclusiveMinimum": 0
},
"templateId": {
"type": "string",
"minLength": 1,
"description": "Template UUID or slug — every /v1/templates route resolves either."
},
"restoreDraft": {
"type": "boolean",
"description": "When true, also overwrite the working draft (html/css/schema) with that version's content. The current draft is auto-snapshotted into a new version first, unless it is already byte-identical. Defaults to false, which leaves in-flight edits alone."
},
"expectedPublishedVersion": {
"type": "integer",
"minimum": 0,
"description": "Optimistic fence: the published_version you believe is live (0 if never published). The call is rejected with 409 VERSION_CONFLICT if someone moved the pointer in the meantime. Pass it whenever you read the state in an earlier step."
}
},
"additionalProperties": false
}| Which model vendor served the call. Use 'custom' for anything self-hosted. |
| latency_ms | integer | Wall-clock duration of the call. |
| input_tokens | integer | Prompt tokens billed. |
| output_tokens | integer | Completion tokens billed. |
| status_detail | string | Why the call was flagged or failed. Free text. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"provider",
"model"
],
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 64
},
"maxItems": 20,
"description": "Up to 20 free-form labels. trace_search can filter on any one of them."
},
"model": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Model identifier exactly as the provider reports it, e.g. 'claude-sonnet-4-6'."
},
"output": {
"description": "The model's response, verbatim. Any JSON value."
},
"prompt": {
"description": "The prompt / request you sent, verbatim. Any JSON value (string, array, object)."
},
"status": {
"enum": [
"ok",
"flagged",
"error"
],
"type": "string",
"description": "Outcome. 'flagged' marks a call you want a human to review later. Defaults to 'ok'."
},
"feature": {
"type": "string",
"maxLength": 120,
"description": "Product area the call belongs to, e.g. 'support_reply'. Filterable in trace_search."
},
"provider": {
"enum": [
"anthropic",
"openai",
"custom"
],
"type": "string",
"description": "Which model vendor served the call. Use 'custom' for anything self-hosted."
},
"latency_ms": {
"type": "integer",
"minimum": 0,
"description": "Wall-clock duration of the call."
},
"input_tokens": {
"type": "integer",
"minimum": 0,
"description": "Prompt tokens billed."
},
"output_tokens": {
"type": "integer",
"minimum": 0,
"description": "Completion tokens billed."
},
"status_detail": {
"type": "string",
"maxLength": 500,
"description": "Why the call was flagged or failed. Free text."
}
},
"additionalProperties": false
}| Exact-match filter on provider. |
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"tag": {
"type": "string",
"maxLength": 64,
"description": "Return records whose tags array contains this tag."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Page size, 1-100. Default 25."
},
"since": {
"type": "string",
"description": "ISO-8601 timestamp, inclusive lower bound."
},
"until": {
"type": "string",
"description": "ISO-8601 timestamp, exclusive upper bound."
},
"cursor": {
"type": "string",
"description": "Pass the `next_cursor` from the previous response to fetch the next page."
},
"status": {
"enum": [
"ok",
"flagged",
"error"
],
"type": "string",
"description": "Exact-match filter on outcome."
},
"feature": {
"type": "string",
"maxLength": 120,
"description": "Exact-match filter on the feature label."
},
"provider": {
"enum": [
"anthropic",
"openai",
"custom"
],
"type": "string",
"description": "Exact-match filter on provider."
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"template"
],
"properties": {
"css": {
"type": "string",
"maxLength": 1000000,
"description": "Replaces the draft CSS entirely."
},
"html": {
"type": "string",
"maxLength": 5000000,
"minLength": 1,
"description": "Replaces the draft HTML entirely."
},
"name": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 10
},
"schema": {
"type": "object",
"description": "Replaces the draft JSON Schema entirely.",
"additionalProperties": {}
},
"isPublic": {
"type": "boolean"
},
"template": {
"type": "string",
"minLength": 1,
"description": "Template UUID or slug. This route accepts either."
},
"description": {
"type": "string",
"maxLength": 500
}
},
"additionalProperties": false
}{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"filename",
"contentType"
],
"properties": {
"filename": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Name to store the asset under. Characters outside [A-Za-z0-9._-] are replaced with '_'."
},
"sizeBytes": {
"type": "integer",
"maximum": 104857600,
"description": "Declared size in bytes. Computed automatically when contentBase64 is supplied. Max 100 MB.",
"exclusiveMinimum": 0
},
"contentType": {
"enum": [
"image/png",
"image/jpeg",
"image/webp",
"image/gif",
"image/svg+xml",
"application/pdf",
"font/woff",
"font/woff2",
"font/ttf",
"font/otf",
"application/octet-stream"
],
"type": "string",
"description": "MIME type. The API rejects anything outside this list."
},
"contentBase64": {
"type": "string",
"minLength": 1,
"description": "Base64 bytes to upload. When supplied, this server PUTs them to the pre-signed URL and the asset is immediately usable. Omit for files too large to pass through a tool call — you then get uploadUrl back and PUT the bytes yourself within 15 minutes."
}
},
"additionalProperties": false
}