{"openapi":"3.1.0","info":{"title":"Regulations.gov (BYOK) API","version":"0.1.0","description":"Regulations.gov (BYOK) lets an AI assistant read your own Regulations.gov data through the Regulations.gov API with a key you supply (Regulations.gov API key). Read-only: 7 tools (search_documents, get_document, search_dockets, get_docket, search_comments, get_comment, list_agency_categories). The BYOK key travels with each request, is used for that one call only and is never stored, logged or...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-regulationsgov.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-regulationsgov/docs"},"termsOfService":"https://connectorbay.com/byok-regulationsgov/terms"},"servers":[{"url":"https://byok-regulationsgov.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-regulationsgov/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/search_documents":{"post":{"operationId":"search_documents","summary":"Search rulemaking documents (proposed rules, rules, notices) by keyword, agency, docket, type or comment period. Use for","description":"Search rulemaking documents (proposed rules, rules, notices) by keyword, agency, docket, type or comment period. Use for \"Which EPA proposed rules are open for comment right now\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"search_term":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Keyword search term.","title":"Search Term"},"agency_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Agency acronym such as EPA, FDA or SEC.","title":"Agency Id"},"docket_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Docket id such as EPA-HQ-OW-2024-0001.","title":"Docket Id"},"document_type":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Document type: Notice, Rule, Proposed Rule, Supporting & Related Material or Other.","title":"Document Type"},"fr_doc_num":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Federal Register document number.","title":"Fr Doc Num"},"posted_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Posted date, yyyy-MM-dd.","title":"Posted Date"},"within_comment_period":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to keep only documents currently open for comment.","title":"Within Comment Period"},"sort":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Sort field, prefix with - for descending, for example -postedDate or lastModifiedDate.","title":"Sort"},"page_number":{"anyOf":[{"maximum":20,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page Number"},"page_size":{"anyOf":[{"maximum":250,"minimum":5,"type":"integer"},{"type":"null"}],"default":25,"description":"Results per page, 5 to 250.","title":"Page Size"}},"title":"search_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 rulemaking document by id with title, type, agency, docket, Federal Register number, comment window and dates. U","description":"Get one rulemaking document by id with title, type, agency, docket, Federal Register number, comment window and dates. Use for \"Show Regulations.gov document EPA-HQ-OW-2024-0001-0001\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"document_id":{"description":"Document id such as EPA-HQ-OW-2024-0001-0001.","maxLength":200,"title":"Document Id","type":"string"}},"required":["document_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/search_dockets":{"post":{"operationId":"search_dockets","summary":"Search rulemaking dockets by keyword, agency or type. Use for \"Find SEC dockets about climate disclosure\".","description":"Search rulemaking dockets by keyword, agency or type. Use for \"Find SEC dockets about climate disclosure\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"search_term":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Keyword search term.","title":"Search Term"},"agency_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Agency acronym such as EPA, FDA or SEC.","title":"Agency Id"},"docket_type":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Docket type: Rulemaking or Nonrulemaking.","title":"Docket Type"},"sort":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Sort field, prefix with - for descending, for example -lastModifiedDate.","title":"Sort"},"page_number":{"anyOf":[{"maximum":20,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page Number"},"page_size":{"anyOf":[{"maximum":250,"minimum":5,"type":"integer"},{"type":"null"}],"default":25,"description":"Results per page, 5 to 250.","title":"Page Size"}},"title":"search_docketsArguments","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_docket":{"post":{"operationId":"get_docket","summary":"Get one docket by id: title, short title, type, agency, abstract, keywords and rule identifier number. Use for \"Show Reg","description":"Get one docket by id: title, short title, type, agency, abstract, keywords and rule identifier number. Use for \"Show Regulations.gov docket EPA-HQ-OW-2024-0001\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"docket_id":{"description":"Docket id such as EPA-HQ-OW-2024-0001.","maxLength":200,"title":"Docket Id","type":"string"}},"required":["docket_id"],"title":"get_docketArguments","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/search_comments":{"post":{"operationId":"search_comments","summary":"Search public comment records by keyword, agency or the document commented on (titles and dates only, no commenter detai","description":"Search public comment records by keyword, agency or the document commented on (titles and dates only, no commenter details). Use for \"How many public comments were posted on document EPA-HQ-OW-2024-0001-0001\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"search_term":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Keyword search term.","title":"Search Term"},"agency_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Agency acronym such as EPA, FDA or SEC.","title":"Agency Id"},"comment_on_id":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Object id of the document commented on (the objectId of a document).","title":"Comment On Id"},"posted_date":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Posted date, yyyy-MM-dd.","title":"Posted Date"},"sort":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Sort field, prefix with - for descending, for example -postedDate.","title":"Sort"},"page_number":{"anyOf":[{"maximum":20,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page Number"},"page_size":{"anyOf":[{"maximum":250,"minimum":5,"type":"integer"},{"type":"null"}],"default":25,"description":"Results per page, 5 to 250.","title":"Page Size"}},"title":"search_commentsArguments","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_comment":{"post":{"operationId":"get_comment","summary":"Get one public comment by id: title, comment text, agency, docket, category and posted date (commenter name, email and a","description":"Get one public comment by id: title, comment text, agency, docket, category and posted date (commenter name, email and address left out). Use for \"Show the text of Regulations.gov comment EPA-HQ-OW-2024-0001-0100\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"comment_id":{"description":"Comment id such as EPA-HQ-OW-2024-0001-0100.","maxLength":200,"title":"Comment Id","type":"string"}},"required":["comment_id"],"title":"get_commentArguments","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_agency_categories":{"post":{"operationId":"list_agency_categories","summary":"List the comment categories each agency uses, optionally for one agency. Use for \"Which comment categories does the EPA ","description":"List the comment categories each agency uses, optionally for one agency. Use for \"Which comment categories does the EPA use on Regulations.gov\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"acronym":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Agency acronym such as EPA.","title":"Acronym"}},"title":"list_agency_categoriesArguments","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}}}}