List Frameworks

GEThttps://api.confident-ai.com/v2/rt-frameworks

Lists the red teaming frameworks in your Confident AI project one page at a time, ordered by name. Each framework is returned with its risk categories counted; retrieve one by id to see what those categories select.

GET/v2/rt-frameworks

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

200

{
  "success": true,
  "data": {
    "rtFrameworks": [
      {
        "id": "<RT-FRAMEWORK-ID>",
        "name": "OWASP Top 10 for LLMs",
        "description": "Our baseline coverage before each release.",
        "riskCategories": [
          {
            "name": "Data protection",
            "numVulnerabilityTypes": 4,
            "numAttackMethods": 3
          }
        ]
      }
    ],
    "totalRTFrameworks": 3,
    "page": 1,
    "pageSize": 25
  },
  "link": "https://app.confident-ai.com/project/<PROJECT-ID>/frameworks",
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Query parameters

pageintegerdefault: 1
The page to return. Defaults to 1.
pageSizeintegerdefault: 25
The number of results per page, at most 100. Defaults to 25.

Response

List Frameworks succeeded.

successboolean
Indicates if the request was successful.
dataobject
One page of frameworks, with the total across all pages.
Show 4 propertiesHide 4 properties
- rtFrameworkslist of objects
  The frameworks for the current page, ordered by name.
  Show 4 propertiesHide 4 properties
  - idstring
    The id of the framework, generated by Confident AI.
  - namestring
    The name of the framework.
  - descriptionstring | null
    What the framework covers.
  - riskCategorieslist of objects
    The framework's risk categories, counted rather than resolved.
    Show 3 propertiesHide 3 properties
    namestring
    The name of the risk category.
    numVulnerabilityTypesinteger
    How many vulnerability types the category selects.
    numAttackMethodsinteger
    How many attack methods the category selects.
- totalRTFrameworksinteger
  The total number of frameworks in this project.
- pageinteger
  The page this response covers.
- pageSizeinteger
  The number of frameworks per page.
linkstring
This is the URL of the resource on the Confident AI platform.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI