{"openapi":"3.1.0","info":{"title":"Perma.cc (BYOK) API","version":"0.1.0","description":"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...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-perma.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-perma/docs"},"termsOfService":"https://connectorbay.com/byok-perma/terms"},"servers":[{"url":"https://byok-perma.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-perma/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_public_archives":{"post":{"operationId":"list_public_archives","summary":"List the most recently created public Perma.cc archives (permalinks) with title, source URL and capture details. Use for","description":"List the most recently created public Perma.cc archives (permalinks) with title, source URL and capture details. Use for \"What public archives were just made on Perma.cc\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":300,"minimum":1,"type":"integer"},{"type":"null"}],"default":300,"description":"Items per page (1 to 300, default 300).","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Page number counted from 0; each step moves one full page of limit items.","title":"Offset"}},"title":"list_public_archivesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_account":{"post":{"operationId":"get_account","summary":"Get your Perma.cc account id and the top-level folders you can use. Use for \"Which top-level folders do I have in Perma.","description":"Get your Perma.cc account id and the top-level folders you can use. Use for \"Which top-level folders do I have in Perma.cc\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_accountArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_organizations":{"post":{"operationId":"list_organizations","summary":"List the organizations you belong to or manage, each with its shared folder. Use for \"Which Perma.cc organizations do I ","description":"List the organizations you belong to or manage, each with its shared folder. Use for \"Which Perma.cc organizations do I manage\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":300,"minimum":1,"type":"integer"},{"type":"null"}],"default":300,"description":"Items per page (1 to 300, default 300).","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Page number counted from 0; each step moves one full page of limit items.","title":"Offset"}},"title":"list_organizationsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_organization":{"post":{"operationId":"get_organization","summary":"Get one organization and the id of its shared folder. Use for \"Show Perma.cc organization 9\".","description":"Get one organization and the id of its shared folder. Use for \"Show Perma.cc organization 9\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization_id":{"description":"Organization id from list_organizations.","title":"Organization Id","type":"integer"}},"required":["organization_id"],"title":"get_organizationArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_archives":{"post":{"operationId":"list_archives","summary":"List every archive you can access (public and private, all folders), newest first, with capture status and sizes. Use fo","description":"List every archive you can access (public and private, all folders), newest first, with capture status and sizes. Use for \"Which of my Perma.cc archives are private\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":300,"minimum":1,"type":"integer"},{"type":"null"}],"default":300,"description":"Items per page (1 to 300, default 300).","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Page number counted from 0; each step moves one full page of limit items.","title":"Offset"}},"title":"list_archivesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_archive":{"post":{"operationId":"get_archive","summary":"Get one archive by its GUID: source URL, title, capture roles and statuses, sizes, privacy and download links. Use for \"","description":"Get one archive by its GUID: source URL, title, capture roles and statuses, sizes, privacy and download links. Use for \"Show Perma.cc archive W6PY-UZ99\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"guid":{"description":"Archive GUID such as W6PY-UZ99.","maxLength":200,"title":"Guid","type":"string"}},"required":["guid"],"title":"get_archiveArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_folders":{"post":{"operationId":"list_folders","summary":"List your top-level folders. Use for \"What folders do I have in Perma.cc\".","description":"List your top-level folders. Use for \"What folders do I have in Perma.cc\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":300,"minimum":1,"type":"integer"},{"type":"null"}],"default":300,"description":"Items per page (1 to 300, default 300).","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Page number counted from 0; each step moves one full page of limit items.","title":"Offset"}},"title":"list_foldersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_folder":{"post":{"operationId":"get_folder","summary":"Get one folder with its path and whether it has subfolders. Use for \"Show Perma.cc folder 24\".","description":"Get one folder with its path and whether it has subfolders. Use for \"Show Perma.cc folder 24\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"folder_id":{"description":"Folder id (from list_folders or the account).","title":"Folder Id","type":"integer"}},"required":["folder_id"],"title":"get_folderArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_subfolders":{"post":{"operationId":"list_subfolders","summary":"List the subfolders of a folder. Use for \"What subfolders does Perma.cc folder 24 have\".","description":"List the subfolders of a folder. Use for \"What subfolders does Perma.cc folder 24 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"folder_id":{"description":"Folder id (from list_folders or the account).","title":"Folder Id","type":"integer"},"limit":{"anyOf":[{"maximum":300,"minimum":1,"type":"integer"},{"type":"null"}],"default":300,"description":"Items per page (1 to 300, default 300).","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Page number counted from 0; each step moves one full page of limit items.","title":"Offset"}},"required":["folder_id"],"title":"list_subfoldersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_folder_archives":{"post":{"operationId":"list_folder_archives","summary":"List the archives stored directly in a folder (subfolders are not included). Use for \"Which archives are in Perma.cc fol","description":"List the archives stored directly in a folder (subfolders are not included). Use for \"Which archives are in Perma.cc folder 24\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"folder_id":{"description":"Folder id (from list_folders or the account).","title":"Folder Id","type":"integer"},"limit":{"anyOf":[{"maximum":300,"minimum":1,"type":"integer"},{"type":"null"}],"default":300,"description":"Items per page (1 to 300, default 300).","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Page number counted from 0; each step moves one full page of limit items.","title":"Offset"}},"required":["folder_id"],"title":"list_folder_archivesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_capture_job":{"post":{"operationId":"get_capture_job","summary":"Check how the capture of an archive is going: status, step, timing and queue position. Use for \"Has Perma.cc finished ca","description":"Check how the capture of an archive is going: status, step, timing and queue position. Use for \"Has Perma.cc finished capturing F42B-NZ6G\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"guid":{"description":"GUID of the archive being captured.","maxLength":200,"title":"Guid","type":"string"}},"required":["guid"],"title":"get_capture_jobArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_batch":{"post":{"operationId":"get_batch","summary":"Get a batch of archive requests with the capture job of each URL and the links you have left. Use for \"How is Perma.cc b","description":"Get a batch of archive requests with the capture job of each URL and the links you have left. Use for \"How is Perma.cc batch 268 going\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"batch_id":{"description":"Batch id returned when the batch was created.","title":"Batch Id","type":"integer"}},"required":["batch_id"],"title":"get_batchArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}