Create Framework

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

Creates a red teaming framework in your Confident AI project and returns its id. Send template to fill it from a Confident AI template, which creates its risk categories with vulnerability types and attack methods already selected.

POST/v2/rt-frameworks

curl -X POST "https://api.confident-ai.com/v2/rt-frameworks" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "OWASP Top 10 for LLMs",
  "description": "Our baseline coverage before each release.",
  "template": "EU Artificial Intelligence Act"
}'

200

{
  "success": true,
  "data": {
    "id": "<RT-FRAMEWORK-ID>"
  },
  "link": "https://app.confident-ai.com/project/<PROJECT-ID>/frameworks/<RT-FRAMEWORK-ID>",
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Request body

namestringRequired
The name of the framework, unique within the project.
descriptionstring | null
What the framework covers. Send null to leave it unset.
templatestring
A Confident AI template to fill the framework from, which creates its risk categories with vulnerability types and attack methods already selected. Omit it for an empty framework.

Response

Create Framework succeeded.

successboolean
Indicates if the request was successful.
dataobject
A reference to a red teaming framework by its id.
Show 1 propertyHide 1 property
- idstring
  The id of the framework, generated by Confident AI.
linkstring
This is the URL of the resource on the Confident AI platform.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI