Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

Formfeed (BYOK) — connector documentation

  • MCP endpoint: https://byok-formfeed.connectorbay.com/mcp
  • REST API: POST https://byok-formfeed.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-formfeed.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own Formfeed Formfeed API key (ff_live_ or ff_test_; reads need the render:read, template:read and account:read scopes), sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-formfeed.connectorbay.com/health · Tool schemas: https://byok-formfeed.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-formfeed · agent@connectorbay.com

What Formfeed (BYOK) is for

Formfeed (BYOK) lets an AI assistant read your own Formfeed data through the Formfeed API with a key you supply (Formfeed API key (ff_live_ or ff_test_; reads need the render:read, template:read and account:read scopes)). Read-only: 11 tools (list_renders, get_render, get_batch_job, list_templates, get_template_schema, list_template_channels, get_usage, get_account, get_brand_kit, list_partials, list_library_files). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to api.formfeed.dev. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Formfeed. Formfeed and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Which PDF renders failed recently?"
  • "What is the status of render rnd_01J8ZK4M3Q7X?"
  • "Did batch job job_01J8ZK4M3Q finish?"
  • "Which document templates do I have?"
  • "What data fields does the invoice template need?"
  • "Which release channels does the invoice template have?"

What it does

  • list_renders: List the documents rendered in the workspace, newest first, with status, output type, size, page count, units used, the template and version used, any error, your own meta values and times. Download links are left out.
  • get_render: Get one render by its id (starts with rnd_): status, output type, size, pages, units, template and version, error and meta values. The download link is not returned.
  • get_batch_job: Get a batch render job by its id (starts with job_): status (queued, processing, completed, partially_failed, failed), how many items there are and how many succeeded or failed.
  • list_templates: List the document templates of the workspace (archived ones are left out). Needs the template:read scope.
  • get_template_schema: Get the JSON Schema of the data a template expects, for the published version or a chosen version or release channel. Answers 404 when the template has no stored or inferred schema.
  • list_template_channels: List a template's release channels (published and named ones such as staging) with the version each points to, canary settings, renders of the last 24 hours and the plan's channel limits.
  • get_usage: Get the workspace's metered usage for a billing period: units included, used, overage used, prepaid overage balance, a daily series of units and renders, and units per template.
  • get_account: Get the workspace, its plan with limits (requests per second, concurrency, page and size limits) and the dates of the current billing period. Needs the account:read scope.
  • get_brand_kit: Get the organisation's brand kit: name, colours, fonts, font size, logo links, legal footer, default page settings and version.
  • list_partials: List the organisation's shared template partials (reusable fragments such as letterheads) with name, template engine, description, version and times. Sources are not included.
  • list_library_files: List files in the workspace's asset library (images and PDFs used by templates), newest first, optionally under a name prefix.

BYOK key

You bring your own Formfeed Formfeed API key (ff_live_ or ff_test_; reads need the render:read, template:read and account:read scopes) (https://docs.formfeed.dev/api/authentication). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to api.formfeed.dev over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the Formfeed API (api.formfeed.dev) with a BYOK key; documentation: https://docs.formfeed.dev/api/overview. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Formfeed. Formfeed and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your Formfeed account.

Built for: Worldwide. Languages: English.