{"openapi":"3.1.0","info":{"title":"Beeceptor (BYOK) API","version":"0.1.0","description":"Beeceptor (BYOK) lets an AI assistant read your own Beeceptor data through the Beeceptor API with a key you supply (Beeceptor endpoint API key (Team plan or higher)). Read-only: 8 tools (list_rules, get_rule, list_requests, get_request, get_settings, list_state, get_state_item, get_spec_info). 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-beeceptor.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-beeceptor/docs"},"termsOfService":"https://connectorbay.com/byok-beeceptor/terms"},"servers":[{"url":"https://byok-beeceptor.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-beeceptor/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_rules":{"post":{"operationId":"list_rules","summary":"List the mock rules of a Beeceptor endpoint with method, description, match conditions and response action. Use for \"Wha","description":"List the mock rules of a Beeceptor endpoint with method, description, match conditions and response action. Use for \"What mock rules does my Beeceptor endpoint my-mock have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"endpoint":{"description":"Beeceptor endpoint name (the subdomain of your mock server, for example 'my-mock'); the API key is tied to this one endpoint.","maxLength":60,"title":"Endpoint","type":"string"}},"required":["endpoint"],"title":"list_rulesArguments","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_rule":{"post":{"operationId":"get_rule","summary":"Get one Beeceptor mock rule by id: method, conditions and response action. Use for \"Show Beeceptor rule 1ua4j6kb1e2 of m","description":"Get one Beeceptor mock rule by id: method, conditions and response action. Use for \"Show Beeceptor rule 1ua4j6kb1e2 of my-mock\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"endpoint":{"description":"Beeceptor endpoint name (the subdomain of your mock server, for example 'my-mock'); the API key is tied to this one endpoint.","maxLength":60,"title":"Endpoint","type":"string"},"rule_id":{"description":"Rule id, from list_rules.","maxLength":40,"title":"Rule Id","type":"string"}},"required":["endpoint","rule_id"],"title":"get_ruleArguments","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_requests":{"post":{"operationId":"list_requests","summary":"List requests received by a Beeceptor endpoint (newest first) with method, path, status code, time taken and which rule ","description":"List requests received by a Beeceptor endpoint (newest first) with method, path, status code, time taken and which rule matched. Bodies are not included. Use for \"What requests did my Beeceptor endpoint my-mock receive recently\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"endpoint":{"description":"Beeceptor endpoint name (the subdomain of your mock server, for example 'my-mock'); the API key is tied to this one endpoint.","maxLength":60,"title":"Endpoint","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many requests to return (1 to 100; the API default is 20).","title":"Limit"},"cursor":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Cursor from pagination.cursor of the previous answer, for the next page.","title":"Cursor"},"method":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Only requests with this HTTP method, for example POST.","title":"Method"},"status":{"anyOf":[{"maximum":599,"minimum":100,"type":"integer"},{"type":"null"}],"default":null,"description":"Only requests answered with this status code.","title":"Status"},"path":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only requests whose path matches this text.","title":"Path"},"behavior":{"anyOf":[{"enum":["mock-rule","proxy","callout","grpc","wsdl","graphql","tunnel","oas"],"type":"string"},{"type":"null"}],"default":null,"description":"Only requests handled this way.","title":"Behavior"},"date_from":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only requests from this ISO 8601 time on.","title":"Date From"},"date_to":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only requests up to this ISO 8601 time.","title":"Date To"}},"required":["endpoint"],"title":"list_requestsArguments","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_request":{"post":{"operationId":"get_request","summary":"Get one request received by a Beeceptor endpoint with method, path, status, matched rule and the request and response bo","description":"Get one request received by a Beeceptor endpoint with method, path, status, matched rule and the request and response bodies. Use for \"Show the body of Beeceptor request r1 on my-mock\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"endpoint":{"description":"Beeceptor endpoint name (the subdomain of your mock server, for example 'my-mock'); the API key is tied to this one endpoint.","maxLength":60,"title":"Endpoint","type":"string"},"request_id":{"description":"Request id, from list_requests.","maxLength":60,"title":"Request Id","type":"string"}},"required":["endpoint","request_id"],"title":"get_requestArguments","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_settings":{"post":{"operationId":"get_settings","summary":"Get the settings of a Beeceptor endpoint: CORS origins, rate limit, locale, latency, proxy target and custom domain. The","description":"Get the settings of a Beeceptor endpoint: CORS origins, rate limit, locale, latency, proxy target and custom domain. The endpoint's access header value is left out. Use for \"How is my Beeceptor endpoint my-mock configured\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"endpoint":{"description":"Beeceptor endpoint name (the subdomain of your mock server, for example 'my-mock'); the API key is tied to this one endpoint.","maxLength":60,"title":"Endpoint","type":"string"}},"required":["endpoint"],"title":"get_settingsArguments","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_state":{"post":{"operationId":"list_state","summary":"List the persistent state variables (strings, counters, lists) stored by a Beeceptor endpoint, optionally by type or key","description":"List the persistent state variables (strings, counters, lists) stored by a Beeceptor endpoint, optionally by type or key prefix. Use for \"What state variables does my Beeceptor endpoint my-mock hold\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"endpoint":{"description":"Beeceptor endpoint name (the subdomain of your mock server, for example 'my-mock'); the API key is tied to this one endpoint.","maxLength":60,"title":"Endpoint","type":"string"},"type":{"anyOf":[{"enum":["string","counter","list"],"type":"string"},{"type":"null"}],"default":null,"description":"Only variables of this type.","title":"Type"},"key_prefix":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only variables whose key starts with this text.","title":"Key Prefix"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many variables to return (1 to 100).","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many variables to skip, for paging.","title":"Offset"}},"required":["endpoint"],"title":"list_stateArguments","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_state_item":{"post":{"operationId":"get_state_item","summary":"Get one state variable of a Beeceptor endpoint by type and key. Use for \"What is the value of counter visits on Beecepto","description":"Get one state variable of a Beeceptor endpoint by type and key. Use for \"What is the value of counter visits on Beeceptor endpoint my-mock\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"endpoint":{"description":"Beeceptor endpoint name (the subdomain of your mock server, for example 'my-mock'); the API key is tied to this one endpoint.","maxLength":60,"title":"Endpoint","type":"string"},"type":{"description":"Variable type: string, counter or list.","enum":["string","counter","list"],"title":"Type","type":"string"},"key":{"description":"Variable key.","maxLength":100,"title":"Key","type":"string"}},"required":["endpoint","type","key"],"title":"get_state_itemArguments","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_spec_info":{"post":{"operationId":"get_spec_info","summary":"Get the type of API specification (OpenAPI, gRPC, GraphQL or WSDL) uploaded to a Beeceptor endpoint and whether intellig","description":"Get the type of API specification (OpenAPI, gRPC, GraphQL or WSDL) uploaded to a Beeceptor endpoint and whether intelligent mocking is on. Use for \"Has my Beeceptor endpoint my-mock got an API spec uploaded\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"endpoint":{"description":"Beeceptor endpoint name (the subdomain of your mock server, for example 'my-mock'); the API key is tied to this one endpoint.","maxLength":60,"title":"Endpoint","type":"string"}},"required":["endpoint"],"title":"get_spec_infoArguments","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}}}}