{"openapi":"3.1.0","info":{"title":"Confident AI Red Teaming (BYOK) API","version":"0.1.0","description":"Confident AI Red Teaming (BYOK) lets an AI assistant read your own Confident AI Red Teaming data through the Confident AI Red Teaming API with a key you supply (Confident AI project API key). Read-only: 6 tools (list_rt_frameworks, get_rt_framework, list_risk_categories, list_attack_methods, list_vulnerabilities, get_vulnerability). The BYOK key travels with each request, is used for that one...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-confident-ai-redteam.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-confident-ai-redteam/docs"},"termsOfService":"https://connectorbay.com/byok-confident-ai-redteam/terms"},"servers":[{"url":"https://byok-confident-ai-redteam.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-confident-ai-redteam/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_rt_frameworks":{"post":{"operationId":"list_rt_frameworks","summary":"List the red teaming frameworks of the project (id, name, description) with each framework's risk categories and how man","description":"List the red teaming frameworks of the project (id, name, description) with each framework's risk categories and how many vulnerability types and attack methods they select. Use for \"Which red teaming frameworks are set up in my Confident AI project\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many frameworks per page (1 to 100).","title":"Page Size"}},"title":"list_rt_frameworksArguments","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_rt_framework":{"post":{"operationId":"get_rt_framework","summary":"Get one red teaming framework with each risk category resolved to the vulnerabilities it probes for (criteria, guideline","description":"Get one red teaming framework with each risk category resolved to the vulnerabilities it probes for (criteria, guidelines) and the attack methods it uses. Use for \"Show the details of the Confident AI red teaming framework fw_1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"framework_id":{"description":"Red teaming framework id, as returned by list_rt_frameworks.","maxLength":200,"title":"Framework Id","type":"string"}},"required":["framework_id"],"title":"get_rt_frameworkArguments","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_risk_categories":{"post":{"operationId":"list_risk_categories","summary":"List the risk categories of one framework (id, name, description, number of vulnerability types and attack methods), ord","description":"List the risk categories of one framework (id, name, description, number of vulnerability types and attack methods), ordered by name. Use for \"Which risk categories does the Confident AI framework fw_1 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"framework_id":{"description":"Red teaming framework id, as returned by list_rt_frameworks.","maxLength":200,"title":"Framework Id","type":"string"},"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many categories per page (1 to 100).","title":"Page Size"}},"required":["framework_id"],"title":"list_risk_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}},"/v1/tools/list_attack_methods":{"post":{"operationId":"list_attack_methods","summary":"List the catalog of attack methods (name, description, single or multi-turn, exploitability, configurable), ordered by n","description":"List the catalog of attack methods (name, description, single or multi-turn, exploitability, configurable), ordered by name. Use for \"Which attack methods can Confident AI red teaming use\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many attack methods per page (1 to 100).","title":"Page Size"},"multi_turn":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"Set to true for only multi-turn attack methods or false for only single-turn ones (leave empty for both).","title":"Multi Turn"}},"title":"list_attack_methodsArguments","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_vulnerabilities":{"post":{"operationId":"list_vulnerabilities","summary":"List the vulnerabilities probed for, built-in and your own (id, name, description, category, number of types). Use for \"","description":"List the vulnerabilities probed for, built-in and your own (id, name, description, category, number of types). Use for \"Which vulnerabilities can my Confident AI project red team for\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page":{"anyOf":[{"maximum":100000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":25,"description":"How many vulnerabilities per page (1 to 100).","title":"Page Size"},"category":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only vulnerabilities in this catalog category, for example Security.","title":"Category"},"built_in":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for only the vulnerabilities Confident AI ships, false for only your own (leave empty for both).","title":"Built In"}},"title":"list_vulnerabilitiesArguments","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_vulnerability":{"post":{"operationId":"get_vulnerability","summary":"Get one vulnerability with the evaluator criteria, guidelines, worked examples and the types it breaks down into. Use fo","description":"Get one vulnerability with the evaluator criteria, guidelines, worked examples and the types it breaks down into. Use for \"Show how Confident AI evaluates the vulnerability Prompt Leakage\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"vulnerability_id":{"description":"Vulnerability id or built-in catalog name, as returned by list_vulnerabilities.","maxLength":200,"title":"Vulnerability Id","type":"string"}},"required":["vulnerability_id"],"title":"get_vulnerabilityArguments","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}}}}