Galley Render
JSON in, PDF out. Render invoices, certificates, reports and cards from a template and a payload.
- 0.2.0
- Version
- remote
- Transport
- 20
- Tools
Security review
Review passedReviewed 1d ago.
- tools: 20 tools scanned
- metadata: scanned
No findings.
Tools (20)
list_templates
List the templates on this account, with their latest version number. Start here: rendering needs a template, and this says which ones exist. A brand-new trial account starts with the starter library (invoice, quote, receipt, og-card, certificate and more) already loaded. Each template says where it came from in `origin`: `library` (a starter), `import` (made from the person's own document by import_document) or `own` (made with create_template). Free.
get_template
Fetch one template version: its JSON Schema, its default render options, an example payload and its HTML source. Read the schema before rendering — it is the contract for the `data` argument. Free.
create_template
Create a new template at version 1 from an HTML document with Liquid expressions, plus a JSON Schema for its data. Use this when nothing in list_templates fits. The name must be free on this account — publishing a change to an existing template is `update_template`, not this. Free, but each plan keeps a limited number of templates of your own (the starter library never counts): at the limit this returns `plan_required` with how many the account has, and `update_template` still works.
update_template
Publish a new immutable version of an existing template. Versions are never edited in place: `invoice@2` keeps rendering exactly as it did, and anything pinned to it is unaffected. Renders cached against the old version stay valid, and the new version starts with a cold cache. `engine`, `schema`, `options` and `example` are inherited from the previous version unless you send them, so a source-only change needs only `template` and `source`. Free.
validate_data
Dry-run a `data` payload against a template's JSON Schema and get back exactly the errors a render would raise — field path, expected type, what was received and a value that would be accepted. Costs nothing and renders nothing. Use it before a batch, or whenever you are assembling a payload from somewhere you do not control. `warnings` lists fields the template would not use, each with a `did_you_mean` where there is a near match, and, where the template's schema declares `lang`, what `data.lang` would do.
render
Render a template plus a JSON payload into a PDF, PNG or JPG and return a signed URL. This is the one tool most calls need. Small jobs finish inside the call and come back `status: "succeeded"` with a `url` you can hand straight to a user. Anything with a `webhook_url`, `async: true` or a large payload comes back `status: "queued"` with an id for get_render. Renders are deterministic and cached: the same template version, data and options return the stored object with `cached: true`, free and instant. Billing is per PNG or JPG and per PDF page; cache hits are never billed. For a reader who is not in the US, send `data.lang` (a BCP 47 tag such as `fi` or `pt-BR`) if the template's schema has a `lang` property (check get_template first; the starter library's templates do for new accounts and after a library refresh): the document's fixed text, dates, money and paper size follow it, and `data.labels` overrides single strings. On a template that does not declare them they are ordinary u
get_render
Fetch a render by id: its status, and a freshly signed URL once it has succeeded. Use it to poll a queued render, or to re-sign a URL that has expired — signed URLs last an hour, the stored file lasts until the render's `expires_at` (the plan's retention). Past `expires_at` the file is deleted and this returns `retention_expired` (410) with the render and the template version to render again. Free, and never re-renders.
list_renders
Recent renders on this account, newest first, with status, template version and a signed URL for each that succeeded. Useful for finding a render whose id you lost, or checking what a batch did. Free.
usage
What this account has spent this period and what is left: renders, billable units by format, cost, the free-tier allowance, the monthly spend cap and — on a keyless trial — how much of the trial's 10 PDF pages or 10 images remains. Check it before a large batch. Free.
upgrade
Get a Stripe Checkout link for a paid plan, for a human to open. **This tool cannot subscribe anybody.** It returns a `url`; a person has to open it and enter a card on Stripe's own page. Hand the URL to the human you are working for and say what it costs. Nothing is charged, and no plan changes, until they finish on that page — at which point Stripe tells Galley and the new plan is live within a second or two. Confirm with `usage`. Use it when a render was refused with `quota_exceeded`, or with `plan_required` because the account is on Free and asked for webhooks or cloud delivery. The error body names the plan that would have worked. The account needs a verified email address first — invoices and receipts go to it — so call `create_account` before this if you are on the keyless trial. Changing or cancelling an existing plan is `billing_portal`, never this. Free. **If billing is not enabled on the deployment this is pointed at, the call is refused with `billing_unavailable` (503)
billing_portal
Get a link to the Stripe customer portal, for a human to open: change plan, update the card, download invoices, or cancel. This is the only way any of those happen. Galley's API cannot change or cancel a subscription and cannot issue a refund — deliberately — so if you are asked to downgrade or cancel, the answer is this link and a human on the other end of it. The link is single-use and short-lived, so fetch a fresh one rather than storing it. Only works once the account has subscribed at least once; before that, use `upgrade`. Free. **If billing is not enabled on the deployment this is pointed at, the call is refused with `billing_unavailable` (503) rather than answered with a link.** Say so and point the human at support@galleyrender.com. Do not construct a portal URL yourself and do not retry.
whoami
The account this connection is acting on: its id, its plan, how many PDF pages or images its trial or free tier has left (`renders_remaining`, one per page or image), and — the part no other tool answers — **how this request authenticated**: `header` (a key on the HTTP connection), `binding` (this client was linked with `link_account`), or `trial` (the keyless trial). Call it before a batch, and call it the moment anything about quota surprises you. A `quota_exceeded` that quotes a limit you do not recognise almost always means `trial`: the key never reached this server, and the renders are coming out of a throwaway account rather than yours. Free, and it renders nothing.
link_account
Point this MCP client at an account you already have, so header-less calls from it stop spending the keyless trial. **This is for clients that cannot set HTTP headers** — Claude.ai custom connectors and ChatGPT apps. If your client *can* set a header, prefer that: it is per-connection, it is not tied to a network address, and it needs no tool call at all. **Only a client with an identity of its own can be linked.** A connector added with the shared URL and no client id is recognised by its IP address and User-Agent, and every user of a hosted connector shares those: they call from their vendor's servers. Linking that would link all of them, so it is refused. Add this server with a personal URL instead — `https://mcp.galleyrender.com/mcp/c/<id>`, with a random `<id>` of your own (https://galleyrender.com/docs/connect makes one) — or send `X-Galley-Client-Id` with at least 128 random bits, then link. Two ways to prove the account is yours. `api_key`, if you have the key to hand. Or `l
unlink_account
Undo `link_account`. The binding is deleted and the key that was minted for this client is revoked, so the client can no longer reach the account. Your own API key is untouched — this disconnects a client, it does not close an account. Do this on any machine that is not yours, and whenever a personal connector URL or a client id may have been seen by somebody else. Calls afterwards fall back to the keyless trial. Safe to call when nothing is linked. Free.
rotate_key
Get a fresh API key for the account this connection is already acting on — the answer to a key that has been lost, leaked, pasted into a chat window, or left on a machine that is not yours. **Two calls, on purpose.** `rotate_key({})` mints the new key and shows it **once**; it revokes nothing, so whatever is running on the old key keeps running. Give the new key to the person, wait until they tell you it is saved, then call `rotate_key({ confirm_saved: true, revoke_key_id: "…" })` with the id from `other_live_keys` to kill the old one. Revoking first would take their integration down between the two calls, and revoking without asking would do it without them knowing why. **The key is shown once and cannot be recovered.** Hand it over immediately and do not repeat it in any later message, summary, log or file. Needs a key on the connection or a linked client — it cannot help somebody holding nothing. That case starts at `create_account` with the account's verified address, which mail
create_account
Turn the keyless trial into a real account and get a permanent API key. Call it once with an email. A link is mailed to that address and the tool returns `status: "pending_verification"` with a four-character `request_code`. **Tell the person the code.** The link opens a page that names who asked, when, and the code, and nothing happens until the person answers it: they confirm the request only if it shows the code you gave them. After they confirm, call this again with the same email, from this same client, and it returns the API key, once. The key goes only to the client whose request was confirmed, and that client is then bound to the account, so a connector that cannot send headers is connected from then on. **A client with no identity of its own can't be handed the key** (`can_receive_key: false`). That is any client that sent no key and no client id — every hosted connector added with the shared URL, because they all call from their vendor's servers. Its person verifies the add
import_document
Turn a document the person already sends — their invoice, letterhead, minutes, a form — into a Galley template that reproduces its look, with a JSON Schema you can fill. PDF only (exported from the program that made it, not a scan), up to 10 pages and 20 MB. **Getting the file to Galley — send exactly one:** - `upload: true`, the usual answer in a chat. A file the person dropped into the conversation reaches you as pages to read, not as bytes you can pass on, so this returns a one-time upload link (15 minutes, one use) for the person and a curl line for an agent with a shell. Ask the person to open the link and drop the file; then call `get_import`. - `file_url`, a public https link to the PDF (a share link the person pasted). - `file_base64`, the bytes, up to 5 MB — only for a client that already holds them in code. Then poll `get_import` every few seconds; an import is usually ready in a few minutes. Galley may ask up to three questions about what on the page is fixed and what chan
get_import
The state of a document import and what to do next (`next_step`). Poll it after import_document and after answer_import. - `awaiting_answers`: up to three questions, each with its options, the recommended one, and its evidence — the words on the page (`evidence.text`) and an image of the region. The rule for who answers: answer a question yourself when the evidence decides it (a paragraph of payment terms is `field_with_default`; a table with a quantity column is `repeating`); ask the person when it is about their business (which party they are, whether to keep a signature image). Then answer_import. - `ready`: an image of the preview (page 1, the template rendered with its example data), Galley's checks (`verdict`, `review_recommended`, `differences`) and which starter's field names the schema uses. Show the person the preview before saving: save_import if it is right; if it is not, answer_import cannot fix layout, but you can edit the draft (`include_draft: true`) and create_templat
answer_import
Answer the questions get_import shows on an import in `awaiting_answers`. Each answer is one of its question's option values — nothing else is accepted — plus `path`, a lowercase dotted field name such as `payment_terms`, when the answer makes a paragraph a field. Who answers: answer a question yourself when the evidence decides it (a paragraph of payment terms is `field_with_default`; a table with a quantity column is `repeating`); ask the person when it is about their business (which party they are, whether to keep a signature image). Mark each answer `answered_by: "agent"` (the default) when you decided it from the evidence, or `"user"` when the person gave it to you. Send every answer in one call: a question left out takes its recommended answer, and a second call is refused, so ask the person first. Then poll get_import; the template is usually written in a few minutes. Free.
save_import
Save a `ready` import as a template on this account, once the person has seen the preview and says it is right. Returns the template's ref (`name@1`), its fields, and how to render it. `name` defaults to the one import_document was given, then the draft's own. It counts against the plan's template limit like any template of the account's own (`plan_required` at the limit). Saving again returns the same template. The import's copy of the document is deleted 7 days after it finished; the template stays, and `update_template` publishes changes to it. Free; its renders bill as renders.