{"openapi":"3.1.0","info":{"title":"PDFMonkey (BYOK) API","version":"0.1.0","description":"PDFMonkey (BYOK) lets an AI assistant read your own PDFMonkey data through the PDFMonkey API with a key you supply (PDFMonkey secret API key). Read-only: 5 tools (get_current_user, list_documents, get_document, list_templates, get_template). 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.pdfmonkey.io....\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-pdfmonkey.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-pdfmonkey/docs"},"termsOfService":"https://connectorbay.com/byok-pdfmonkey/terms"},"servers":[{"url":"https://byok-pdfmonkey.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-pdfmonkey/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/get_current_user":{"post":{"operationId":"get_current_user","summary":"Show the PDFMonkey account: plan, billing interval, remaining document quota and trial end (no email or token is returne","description":"Show the PDFMonkey account: plan, billing interval, remaining document quota and trial end (no email or token is returned). Use for \"How many PDFMonkey documents do I have left on my plan\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_current_userArguments","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_documents":{"post":{"operationId":"list_documents","summary":"List generated documents (24 per page) with status, template, file name and dates, filtered by template, status, workspa","description":"List generated documents (24 per page) with status, template, file name and dates, filtered by template, status, workspace, update time or search text. Payloads are not included. Use for \"Which PDFMonkey documents failed to generate recently\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_number":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page Number"},"template_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only documents of this template id (a comma-separated list is accepted).","title":"Template Id"},"status":{"anyOf":[{"enum":["draft","pending","generating","success","failure"],"type":"string"},{"type":"null"}],"default":null,"description":"Only this status: draft, pending, generating, success or failure.","title":"Status"},"workspace_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only documents of this workspace id.","title":"Workspace Id"},"updated_since":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only documents updated after this time (ISO 8601 or Unix timestamp).","title":"Updated Since"},"search":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Document id or part of the file name.","title":"Search"}},"title":"list_documentsArguments","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_document":{"post":{"operationId":"get_document","summary":"Get one generated document's status card: template, file name, failure cause and dates. Use for \"What is the status of t","description":"Get one generated document's status card: template, file name, failure cause and dates. Use for \"What is the status of this PDFMonkey document\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"PDFMonkey document id (UUID).","maxLength":200,"title":"Id","type":"string"}},"required":["id"],"title":"get_documentArguments","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_templates":{"post":{"operationId":"list_templates","summary":"List the templates of a workspace (without their body) with edition mode, draft flag, output type and PDF engine. Use fo","description":"List the templates of a workspace (without their body) with edition mode, draft flag, output type and PDF engine. Use for \"Which PDFMonkey templates do I have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Workspace id; it equals the app_id shown on documents and templates.","maxLength":200,"title":"Workspace Id","type":"string"},"folders":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Comma-separated folder ids, 'none' for templates outside any folder or 'all'.","title":"Folders"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["workspace_id"],"title":"list_templatesArguments","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_template":{"post":{"operationId":"get_template","summary":"Get one template with its HTML body, styles, sample data and settings. Use for \"Show the content of this PDFMonkey templ","description":"Get one template with its HTML body, styles, sample data and settings. Use for \"Show the content of this PDFMonkey template\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"PDFMonkey template id (UUID).","maxLength":200,"title":"Id","type":"string"}},"required":["id"],"title":"get_templateArguments","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}}}}