List Methods

GEThttps://api.confident-ai.com/v2/attack-methods

Lists the attack methods available to your Confident AI project one page at a time, ordered by name. The list covers the whole catalog, whether or not this project has configured a method; retrieve one by id for the parameters it takes.

GET/v2/attack-methods

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

200

{
  "success": true,
  "data": {
    "attackMethods": [
      {
        "id": "Prompt Injection",
        "name": "Prompt Injection",
        "description": "Embeds instructions in the input that try to override the system prompt.",
        "multiTurn": false,
        "exploitability": "LOW",
        "configurable": true
      }
    ],
    "totalAttackMethods": 42,
    "page": 1,
    "pageSize": 25
  },
  "link": "https://app.confident-ai.com/project/<PROJECT-ID>/threats/attacks",
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Query parameters

pageintegerdefault: 1
The page of attack methods to return. Defaults to 1.
pageSizeintegerdefault: 25
The number of attack methods per page, at most 100. Defaults to 25.
multiTurnenum
When true, returns only multi-turn attack methods; when false, only single-turn ones. Omit to return both.

Response

List Methods succeeded.

successboolean
Indicates if the request was successful.
dataobject
One page of attack methods, with the total across all pages.
Show 4 propertiesHide 4 properties
- attackMethodslist of objects
  The attack methods for the current page, ordered by name.
  Show 6 propertiesHide 6 properties
  - idstring
    The id of the attack method. It is the method's catalog name until this project configures it, and its generated id afterwards; both keep resolving.
  - namestring
    The name of the attack method, as the catalog spells it.
  - descriptionstring | null
    What the attack method does to the system under test.
  - multiTurnboolean
    Whether the attack plays out over a conversation rather than a single request.
  - exploitabilityenum | null
    A three-step scale, LOW to HIGH, used for how exposed a system under test is and how easily an attack method exploits it.
    Show 3 enum valuesHide 3 enum values
    LOW
    MEDIUM
    HIGH
  - configurableboolean
    Whether the attack method takes parameters. Updating one that takes none is rejected.
- totalAttackMethodsinteger
  The total number of attack methods matching the query across all pages.
- pageinteger
  The page this response covers.
- pageSizeinteger
  The number of attack methods 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