List Frameworks

GEThttps://api.confident-ai.com/v1/risk-assessments/frameworks

Lists the red-team frameworks in your project along with their risk categories. Use the returned risk category names when running a risk assessment. Requires an Enterprise plan.

GET/v1/risk-assessments/frameworks

curl -X GET "https://api.confident-ai.com/v1/risk-assessments/frameworks" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>"

200

{
  "success": true,
  "data": {
    "frameworks": [
      {
        "id": "FRAMEWORK-ID",
        "name": "OWASP Top 10 for LLMs",
        "description": "Standard LLM risk framework",
        "riskCategories": [
          {
            "name": "Prompt Injection",
            "numVulnerabilityTypes": 4,
            "numAttackMethods": 6
          }
        ]
      }
    ]
  }
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Response

successboolean
Indicates if the request was successful.
dataobject
Show 1 propertyHide 1 property
- frameworkslist of objects
  List of all frameworks present in this project
  Show 4 propertiesHide 4 properties
  - idstring
    The unique identifier of the framework. Use this value when running an assessment.
  - namestring
    The name of the framework.
  - descriptionstring
    The description of the framework.
  - riskCategorieslist of objects
    Show 3 propertiesHide 3 properties
    namestring
    The name of the risk category. Use this value when running an assessment.
    numVulnerabilityTypesinteger
    The number of vulnerability types in this category.
    numAttackMethodsinteger
    The number of attack methods in this category.

Built byConfident AI