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

Perma.cc (BYOK) — connector documentation

  • MCP endpoint: https://byok-perma.connectorbay.com/mcp
  • REST API: POST https://byok-perma.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-perma.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own Perma.cc Perma.cc API key (Settings > Tools), sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-perma.connectorbay.com/health · Tool schemas: https://byok-perma.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-perma · agent@connectorbay.com

What Perma.cc (BYOK) is for

Perma.cc (BYOK) lets an AI assistant read your own Perma.cc data through the Perma.cc API with a key you supply (Perma.cc API key (Settings > Tools)). Read-only: 12 tools (list_public_archives, get_account, list_organizations, get_organization, list_archives, get_archive, list_folders, get_folder, list_subfolders, list_folder_archives, get_capture_job, get_batch). 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.perma.cc. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Perma.cc. Perma.cc 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:

  • "What public archives were just made on Perma.cc?"
  • "Which top-level folders do I have in Perma.cc?"
  • "Which Perma.cc organizations do I manage?"
  • "Show Perma.cc organization 9"
  • "Which of my Perma.cc archives are private?"
  • "Show Perma.cc archive W6PY-UZ99"

What it does

  • list_public_archives: List the most recently created public Perma.cc archives (permalinks) with title, source URL and capture details.
  • get_account: Get your Perma.cc account id and the top-level folders you can use.
  • list_organizations: List the organizations you belong to or manage, each with its shared folder.
  • get_organization: Get one organization and the id of its shared folder.
  • list_archives: List every archive you can access (public and private, all folders), newest first, with capture status and sizes.
  • get_archive: Get one archive by its GUID: source URL, title, capture roles and statuses, sizes, privacy and download links.
  • list_folders: List your top-level folders.
  • get_folder: Get one folder with its path and whether it has subfolders.
  • list_subfolders: List the subfolders of a folder.
  • list_folder_archives: List the archives stored directly in a folder (subfolders are not included).
  • get_capture_job: Check how the capture of an archive is going: status, step, timing and queue position.
  • get_batch: Get a batch of archive requests with the capture job of each URL and the links you have left.

BYOK key

You bring your own Perma.cc Perma.cc API key (Settings > Tools) (https://perma.cc/settings/tools). 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.perma.cc 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 Perma.cc API (api.perma.cc) with a BYOK key; documentation: https://github.com/harvard-lil/perma/blob/develop/perma_web/perma/templates/docs/developer/index.html. 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 Perma.cc. Perma.cc 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 Perma.cc account.

Built for: Worldwide. Languages: English.