Add Task with saved model

POST

redteam

model

add-task

curl --request POST \
  --url https://api.enkryptai.com/redteam/v2/model/add-task \
  --header 'Content-Type: application/json' \
  --header 'X-Enkrypt-Model: <x-enkrypt-model>' \
  --header 'X-Enkrypt-Model-Version: <x-enkrypt-model-version>' \
  --header 'apikey: <api-key>' \
  --data '{
  "test_name": "Test 1",
  "dataset_name": "standard",
  "redteam_test_configurations": {
    "bias_test": {
      "sample_percentage": 1,
      "attack_methods": {
        "basic": [
          "basic"
        ]
      }
    },
    "cbrn_test": {
      "sample_percentage": 1,
      "attack_methods": {
        "basic": [
          "basic"
        ]
      }
    },
    "harmful_test": {
      "sample_percentage": 1,
      "attack_methods": {
        "basic": [
          "basic"
        ]
      }
    },
    "insecure_code_test": {
      "sample_percentage": 1,
      "attack_methods": {
        "basic": [
          "basic"
        ]
      }
    },
    "toxicity_test": {
      "sample_percentage": 1,
      "attack_methods": {
        "basic": [
          "basic"
        ]
      }
    },
    "adv_bias_test": {
      "sample_percentage": 1,
      "attack_methods": {
        "basic": [
          "basic"
        ]
      }
    },
    "adv_info_test": {
      "sample_percentage": 1,
      "attack_methods": {
        "basic": [
          "basic"
        ]
      }
    },
    "adv_tool_test": {
      "sample_percentage": 1,
      "attack_methods": {
        "basic": [
          "basic"
        ]
      }
    },
    "adv_command_test": {
      "sample_percentage": 1,
      "attack_methods": {
        "basic": [
          "basic"
        ]
      }
    },
    "adv_pii_test": {
      "sample_percentage": 1,
      "attack_methods": {
        "basic": [
          "basic"
        ]
      }
    },
    "adv_competitor_test": {
      "sample_percentage": 1,
      "attack_methods": {
        "basic": [
          "basic"
        ]
      }
    }
  }
}'

{
  "status": "Success",
  "message": "Redteam task has been added successfully",
  "task_id": "red-team-6c3babbe-3bc4-4553-a0b7-454df720579f",
  "data": {
    "status": "Success",
    "message": "Redteam task has been added successfully",
    "task_id": "red-team-dd42eac8-ce07-4e79-8ee2-8b7dba083a76",
    "data": {
      "id": "9a010225-ca18-456b-9513-xxxxxxx",
      "test_name": "Test Old v2",
      "created_at": "2025-04-16T16:33:36.009729+00:00",
      "job_id": "red-team-dd42eac8-ce07-4e79-8ee2-8b7dba083a76",
      "dataset_name": "standard",
      "model_name": "Mistral-7B-Instruct-v0.1",
      "model_config": {
        "testing_for": "foundationModels",
        "model_name": "mistralai/Mistral-7B-Instruct-v0.1",
        "rpm": null,
        "model_version": null,
        "system_prompt": "",
        "conversation_template": null,
        "model_source": null,
        "model_provider": "together",
        "model_endpoint_url": "https://api.together.xyz/v1/chat/completions",
        "rate_per_min": 10,
        "input_modalities": null,
        "output_modalities": null,
        "custom_headers": null,
        "custom_payload": null,
        "custom_curl_command": null,
        "custom_response_content_type": null,
        "custom_response_format": null,
        "tools": null,
        "metadata": null
      },
      "redteam_config": {
        "harmful_test": {
          "sample_percentage": 1,
          "attack_methods": {
            "basic": [
              "basic"
            ]
          }
        }
      },
      "status": "Queued",
      "location": "9a010225-ca18-456b-9513-xxxxxxx/red-team-dd42eac8-ce07-4e79-8ee2-8b7dba083a76",
      "run_name": null,
      "project_name": "default",
      "actioner_email": null,
      "test_version": 3,
      "model_saved_name": null,
      "model_version": null,
      "coc_policy_name": null
    }
  }
}

Authorizations

apikey

string

header

required

Headers

X-Enkrypt-Model

string

required

The model saved name. E.g. Test Model

Example:

"Test Model"

X-Enkrypt-Model-Version

string

required

The model version. Default is 'v1'

Example:

"v1"

Body

application/json

redteam_test_configurations

object

required

redteam_test_configurations.bias_test

object

redteam_test_configurations.bias_test.sample_percentage

integer

required

Example:

1

redteam_test_configurations.bias_test.attack_methods

object

redteam_test_configurations.bias_test.attack_methods.basic

enum<string>[]

Available options:

basic

Example:

["basic"]

redteam_test_configurations.bias_test.attack_methods.advanced

object

redteam_test_configurations.bias_test.attack_methods.advanced.static

enum<string>[]

Available options:

encoding,

single_shot

Example:

["encoding"]

redteam_test_configurations.bias_test.attack_methods.advanced.dynamic

enum<string>[]

Available options:

iterative

Example:

["iterative"]

Example:

{
  "sample_percentage": 1,
  "attack_methods": { "basic": ["basic"] }
}

redteam_test_configurations.cbrn_test

object

redteam_test_configurations.cbrn_test.sample_percentage

integer

required

Example:

1

redteam_test_configurations.cbrn_test.attack_methods

object

redteam_test_configurations.cbrn_test.attack_methods.basic

enum<string>[]

Available options:

basic

Example:

["basic"]

redteam_test_configurations.cbrn_test.attack_methods.advanced

object

redteam_test_configurations.cbrn_test.attack_methods.advanced.static

enum<string>[]

Available options:

encoding,

single_shot

Example:

["encoding"]

redteam_test_configurations.cbrn_test.attack_methods.advanced.dynamic

enum<string>[]

Available options:

iterative

Example:

["iterative"]

Example:

{
  "sample_percentage": 1,
  "attack_methods": { "basic": ["basic"] }
}

redteam_test_configurations.harmful_test

object

redteam_test_configurations.harmful_test.sample_percentage

integer

required

Example:

1

redteam_test_configurations.harmful_test.attack_methods

object

redteam_test_configurations.harmful_test.attack_methods.basic

enum<string>[]

Available options:

basic

Example:

["basic"]

redteam_test_configurations.harmful_test.attack_methods.advanced

object

redteam_test_configurations.harmful_test.attack_methods.advanced.static

enum<string>[]

Available options:

encoding,

single_shot

Example:

["encoding"]

redteam_test_configurations.harmful_test.attack_methods.advanced.dynamic

enum<string>[]

Available options:

iterative

Example:

["iterative"]

Example:

{
  "sample_percentage": 1,
  "attack_methods": { "basic": ["basic"] }
}

redteam_test_configurations.insecure_code_test

object

redteam_test_configurations.insecure_code_test.sample_percentage

integer

required

Example:

1

redteam_test_configurations.insecure_code_test.attack_methods

object

redteam_test_configurations.insecure_code_test.attack_methods.basic

enum<string>[]

Available options:

basic

Example:

["basic"]

redteam_test_configurations.insecure_code_test.attack_methods.advanced

object

redteam_test_configurations.insecure_code_test.attack_methods.advanced.static

enum<string>[]

Available options:

encoding,

single_shot

Example:

["encoding"]

redteam_test_configurations.insecure_code_test.attack_methods.advanced.dynamic

enum<string>[]

Available options:

iterative

Example:

["iterative"]

Example:

{
  "sample_percentage": 1,
  "attack_methods": { "basic": ["basic"] }
}

redteam_test_configurations.toxicity_test

object

redteam_test_configurations.toxicity_test.sample_percentage

integer

required

Example:

1

redteam_test_configurations.toxicity_test.attack_methods

object

redteam_test_configurations.toxicity_test.attack_methods.basic

enum<string>[]

Available options:

basic

Example:

["basic"]

redteam_test_configurations.toxicity_test.attack_methods.advanced

object

redteam_test_configurations.toxicity_test.attack_methods.advanced.static

enum<string>[]

Available options:

encoding,

single_shot

Example:

["encoding"]

redteam_test_configurations.toxicity_test.attack_methods.advanced.dynamic

enum<string>[]

Available options:

iterative

Example:

["iterative"]

Example:

{
  "sample_percentage": 1,
  "attack_methods": { "basic": ["basic"] }
}

redteam_test_configurations.adv_bias_test

object

redteam_test_configurations.adv_bias_test.sample_percentage

integer

required

Example:

1

redteam_test_configurations.adv_bias_test.attack_methods

object

redteam_test_configurations.adv_bias_test.attack_methods.basic

enum<string>[]

Available options:

basic

Example:

["basic"]

redteam_test_configurations.adv_bias_test.attack_methods.advanced

object

redteam_test_configurations.adv_bias_test.attack_methods.advanced.static

enum<string>[]

Available options:

encoding,

single_shot

Example:

["encoding"]

redteam_test_configurations.adv_bias_test.attack_methods.advanced.dynamic

enum<string>[]

Available options:

iterative

Example:

["iterative"]

Example:

{
  "sample_percentage": 1,
  "attack_methods": { "basic": ["basic"] }
}

redteam_test_configurations.adv_info_test

object

redteam_test_configurations.adv_info_test.sample_percentage

integer

required

Example:

1

redteam_test_configurations.adv_info_test.attack_methods

object

redteam_test_configurations.adv_info_test.attack_methods.basic

enum<string>[]

Available options:

basic

Example:

["basic"]

redteam_test_configurations.adv_info_test.attack_methods.advanced

object

redteam_test_configurations.adv_info_test.attack_methods.advanced.static

enum<string>[]

Available options:

encoding,

single_shot

Example:

["encoding"]

redteam_test_configurations.adv_info_test.attack_methods.advanced.dynamic

enum<string>[]

Available options:

iterative

Example:

["iterative"]

Example:

{
  "sample_percentage": 1,
  "attack_methods": { "basic": ["basic"] }
}

redteam_test_configurations.adv_tool_test

object

redteam_test_configurations.adv_tool_test.sample_percentage

integer

required

Example:

1

redteam_test_configurations.adv_tool_test.attack_methods

object

redteam_test_configurations.adv_tool_test.attack_methods.basic

enum<string>[]

Available options:

basic

Example:

["basic"]

redteam_test_configurations.adv_tool_test.attack_methods.advanced

object

redteam_test_configurations.adv_tool_test.attack_methods.advanced.static

enum<string>[]

Available options:

encoding,

single_shot

Example:

["encoding"]

redteam_test_configurations.adv_tool_test.attack_methods.advanced.dynamic

enum<string>[]

Available options:

iterative

Example:

["iterative"]

Example:

{
  "sample_percentage": 1,
  "attack_methods": { "basic": ["basic"] }
}

redteam_test_configurations.adv_command_test

object

redteam_test_configurations.adv_command_test.sample_percentage

integer

required

Example:

1

redteam_test_configurations.adv_command_test.attack_methods

object

redteam_test_configurations.adv_command_test.attack_methods.basic

enum<string>[]

Available options:

basic

Example:

["basic"]

redteam_test_configurations.adv_command_test.attack_methods.advanced

object

redteam_test_configurations.adv_command_test.attack_methods.advanced.static

enum<string>[]

Available options:

encoding,

single_shot

Example:

["encoding"]

redteam_test_configurations.adv_command_test.attack_methods.advanced.dynamic

enum<string>[]

Available options:

iterative

Example:

["iterative"]

Example:

{
  "sample_percentage": 1,
  "attack_methods": { "basic": ["basic"] }
}

redteam_test_configurations.adv_pii_test

object

redteam_test_configurations.adv_pii_test.sample_percentage

integer

required

Example:

1

redteam_test_configurations.adv_pii_test.attack_methods

object

redteam_test_configurations.adv_pii_test.attack_methods.basic

enum<string>[]

Available options:

basic

Example:

["basic"]

redteam_test_configurations.adv_pii_test.attack_methods.advanced

object

redteam_test_configurations.adv_pii_test.attack_methods.advanced.static

enum<string>[]

Available options:

encoding,

single_shot

Example:

["encoding"]

redteam_test_configurations.adv_pii_test.attack_methods.advanced.dynamic

enum<string>[]

Available options:

iterative

Example:

["iterative"]

Example:

{
  "sample_percentage": 1,
  "attack_methods": { "basic": ["basic"] }
}

redteam_test_configurations.adv_competitor_test

object

redteam_test_configurations.adv_competitor_test.sample_percentage

integer

required

Example:

1

redteam_test_configurations.adv_competitor_test.attack_methods

object

redteam_test_configurations.adv_competitor_test.attack_methods.basic

enum<string>[]

Available options:

basic

Example:

["basic"]

redteam_test_configurations.adv_competitor_test.attack_methods.advanced

object

redteam_test_configurations.adv_competitor_test.attack_methods.advanced.static

enum<string>[]

Available options:

encoding,

single_shot

Example:

["encoding"]

redteam_test_configurations.adv_competitor_test.attack_methods.advanced.dynamic

enum<string>[]

Available options:

iterative

Example:

["iterative"]

Example:

{
  "sample_percentage": 1,
  "attack_methods": { "basic": ["basic"] }
}

test_name

string

Example:

"Test 1"

dataset_name

string

Example:

"standard"

Response

200 - application/json

Successful Response

task_id

string

required

Example:

"red-team-6c3babbe-3bc4-4553-a0b7-454df720579f"

status

enum<string>

Status of the task

Available options:

Success,

Failed

Example:

"Success"

message

string

Example:

"Redteam task has been added successfully"

data

object

data.test_name

string

Example:

"Test 1"

data.dataset_name

string

Example:

"standard"

data.created_at

string

Example:

"2025-04-16T16:33:36.009729+00:00"

data.model_name

string

Example:

"mistralai/Mistral-7B-Instruct-v0.1"

data.id

string

Example:

"9a010225-ca18-456b-9513-xxxxxxx"

data.status

enum<string>

Status of the task

Available options:

Queued,

Running,

Finished,

Failed

Example:

"Queued"

data.redteam_config

object

data.redteam_config.bias_test

object

data.redteam_config.bias_test.sample_percentage

integer

required

Example:

1

data.redteam_config.bias_test.attack_methods

object

Example:

{
  "sample_percentage": 1,
  "attack_methods": { "basic": ["basic"] }
}

data.redteam_config.cbrn_test

object

data.redteam_config.cbrn_test.sample_percentage

integer

required

Example:

1

data.redteam_config.cbrn_test.attack_methods

object

Example:

{
  "sample_percentage": 1,
  "attack_methods": { "basic": ["basic"] }
}

data.redteam_config.harmful_test

object

data.redteam_config.harmful_test.sample_percentage

integer

required

Example:

1

data.redteam_config.harmful_test.attack_methods

object

Example:

{
  "sample_percentage": 1,
  "attack_methods": { "basic": ["basic"] }
}

data.redteam_config.insecure_code_test

object

data.redteam_config.insecure_code_test.sample_percentage

integer

required

Example:

1

data.redteam_config.insecure_code_test.attack_methods

object

data.redteam_config.insecure_code_test.attack_methods.basic

enum<string>[]

Available options:

basic

Example:

["basic"]

data.redteam_config.insecure_code_test.attack_methods.advanced

object

Example:

{
  "sample_percentage": 1,
  "attack_methods": { "basic": ["basic"] }
}

data.redteam_config.toxicity_test

object

data.redteam_config.toxicity_test.sample_percentage

integer

required

Example:

1

data.redteam_config.toxicity_test.attack_methods

object

data.redteam_config.toxicity_test.attack_methods.basic

enum<string>[]

Available options:

basic

Example:

["basic"]

data.redteam_config.toxicity_test.attack_methods.advanced

object

Example:

{
  "sample_percentage": 1,
  "attack_methods": { "basic": ["basic"] }
}

data.redteam_config.adv_bias_test

object

data.redteam_config.adv_bias_test.sample_percentage

integer

required

Example:

1

data.redteam_config.adv_bias_test.attack_methods

object

data.redteam_config.adv_bias_test.attack_methods.basic

enum<string>[]

Available options:

basic

Example:

["basic"]

data.redteam_config.adv_bias_test.attack_methods.advanced

object

Example:

{
  "sample_percentage": 1,
  "attack_methods": { "basic": ["basic"] }
}

data.redteam_config.adv_info_test

object

data.redteam_config.adv_info_test.sample_percentage

integer

required

Example:

1

data.redteam_config.adv_info_test.attack_methods

object

data.redteam_config.adv_info_test.attack_methods.basic

enum<string>[]

Available options:

basic

Example:

["basic"]

data.redteam_config.adv_info_test.attack_methods.advanced

object

Example:

{
  "sample_percentage": 1,
  "attack_methods": { "basic": ["basic"] }
}

data.redteam_config.adv_tool_test

object

data.redteam_config.adv_tool_test.sample_percentage

integer

required

Example:

1

data.redteam_config.adv_tool_test.attack_methods

object

data.redteam_config.adv_tool_test.attack_methods.basic

enum<string>[]

Available options:

basic

Example:

["basic"]

data.redteam_config.adv_tool_test.attack_methods.advanced

object

Example:

{
  "sample_percentage": 1,
  "attack_methods": { "basic": ["basic"] }
}

data.redteam_config.adv_command_test

object

data.redteam_config.adv_command_test.sample_percentage

integer

required

Example:

1

data.redteam_config.adv_command_test.attack_methods

object

data.redteam_config.adv_command_test.attack_methods.basic

enum<string>[]

Available options:

basic

Example:

["basic"]

data.redteam_config.adv_command_test.attack_methods.advanced

object

Example:

{
  "sample_percentage": 1,
  "attack_methods": { "basic": ["basic"] }
}

data.redteam_config.adv_pii_test

object

data.redteam_config.adv_pii_test.sample_percentage

integer

required

Example:

1

data.redteam_config.adv_pii_test.attack_methods

object

Example:

{
  "sample_percentage": 1,
  "attack_methods": { "basic": ["basic"] }
}

data.redteam_config.adv_competitor_test

object

data.redteam_config.adv_competitor_test.sample_percentage

integer

required

Example:

1

data.redteam_config.adv_competitor_test.attack_methods

object

data.redteam_config.adv_competitor_test.attack_methods.basic

enum<string>[]

Available options:

basic

Example:

["basic"]

data.redteam_config.adv_competitor_test.attack_methods.advanced

object

Example:

{
  "sample_percentage": 1,
  "attack_methods": { "basic": ["basic"] }
}

data.model_config

object

Example:

{
  "status": "Success",
  "message": "Redteam task has been added successfully",
  "task_id": "red-team-dd42eac8-ce07-4e79-8ee2-8b7dba083a76",
  "data": {
    "id": "9a010225-ca18-456b-9513-xxxxxxx",
    "test_name": "Test Old v2",
    "created_at": "2025-04-16T16:33:36.009729+00:00",
    "job_id": "red-team-dd42eac8-ce07-4e79-8ee2-8b7dba083a76",
    "dataset_name": "standard",
    "model_name": "Mistral-7B-Instruct-v0.1",
    "model_config": {
      "testing_for": "foundationModels",
      "model_name": "mistralai/Mistral-7B-Instruct-v0.1",
      "rpm": null,
      "model_version": null,
      "system_prompt": "",
      "conversation_template": null,
      "model_source": null,
      "model_provider": "together",
      "model_endpoint_url": "https://api.together.xyz/v1/chat/completions",
      "rate_per_min": 10,
      "input_modalities": null,
      "output_modalities": null,
      "custom_headers": null,
      "custom_payload": null,
      "custom_curl_command": null,
      "custom_response_content_type": null,
      "custom_response_format": null,
      "tools": null,
      "metadata": null
    },
    "redteam_config": {
      "harmful_test": {
        "sample_percentage": 1,
        "attack_methods": { "basic": ["basic"] }
      }
    },
    "status": "Queued",
    "location": "9a010225-ca18-456b-9513-xxxxxxx/red-team-dd42eac8-ce07-4e79-8ee2-8b7dba083a76",
    "run_name": null,
    "project_name": "default",
    "actioner_email": null,
    "test_version": 3,
    "model_saved_name": null,
    "model_version": null,
    "coc_policy_name": null
  }
}

Add Task Add Custom Task

curl --request POST \
  --url https://api.enkryptai.com/redteam/v2/model/add-task \
  --header 'Content-Type: application/json' \
  --header 'X-Enkrypt-Model: <x-enkrypt-model>' \
  --header 'X-Enkrypt-Model-Version: <x-enkrypt-model-version>' \
  --header 'apikey: <api-key>' \
  --data '{
  "test_name": "Test 1",
  "dataset_name": "standard",
  "redteam_test_configurations": {
    "bias_test": {
      "sample_percentage": 1,
      "attack_methods": {
        "basic": [
          "basic"
        ]
      }
    },
    "cbrn_test": {
      "sample_percentage": 1,
      "attack_methods": {
        "basic": [
          "basic"
        ]
      }
    },
    "harmful_test": {
      "sample_percentage": 1,
      "attack_methods": {
        "basic": [
          "basic"
        ]
      }
    },
    "insecure_code_test": {
      "sample_percentage": 1,
      "attack_methods": {
        "basic": [
          "basic"
        ]
      }
    },
    "toxicity_test": {
      "sample_percentage": 1,
      "attack_methods": {
        "basic": [
          "basic"
        ]
      }
    },
    "adv_bias_test": {
      "sample_percentage": 1,
      "attack_methods": {
        "basic": [
          "basic"
        ]
      }
    },
    "adv_info_test": {
      "sample_percentage": 1,
      "attack_methods": {
        "basic": [
          "basic"
        ]
      }
    },
    "adv_tool_test": {
      "sample_percentage": 1,
      "attack_methods": {
        "basic": [
          "basic"
        ]
      }
    },
    "adv_command_test": {
      "sample_percentage": 1,
      "attack_methods": {
        "basic": [
          "basic"
        ]
      }
    },
    "adv_pii_test": {
      "sample_percentage": 1,
      "attack_methods": {
        "basic": [
          "basic"
        ]
      }
    },
    "adv_competitor_test": {
      "sample_percentage": 1,
      "attack_methods": {
        "basic": [
          "basic"
        ]
      }
    }
  }
}'

{
  "status": "Success",
  "message": "Redteam task has been added successfully",
  "task_id": "red-team-6c3babbe-3bc4-4553-a0b7-454df720579f",
  "data": {
    "status": "Success",
    "message": "Redteam task has been added successfully",
    "task_id": "red-team-dd42eac8-ce07-4e79-8ee2-8b7dba083a76",
    "data": {
      "id": "9a010225-ca18-456b-9513-xxxxxxx",
      "test_name": "Test Old v2",
      "created_at": "2025-04-16T16:33:36.009729+00:00",
      "job_id": "red-team-dd42eac8-ce07-4e79-8ee2-8b7dba083a76",
      "dataset_name": "standard",
      "model_name": "Mistral-7B-Instruct-v0.1",
      "model_config": {
        "testing_for": "foundationModels",
        "model_name": "mistralai/Mistral-7B-Instruct-v0.1",
        "rpm": null,
        "model_version": null,
        "system_prompt": "",
        "conversation_template": null,
        "model_source": null,
        "model_provider": "together",
        "model_endpoint_url": "https://api.together.xyz/v1/chat/completions",
        "rate_per_min": 10,
        "input_modalities": null,
        "output_modalities": null,
        "custom_headers": null,
        "custom_payload": null,
        "custom_curl_command": null,
        "custom_response_content_type": null,
        "custom_response_format": null,
        "tools": null,
        "metadata": null
      },
      "redteam_config": {
        "harmful_test": {
          "sample_percentage": 1,
          "attack_methods": {
            "basic": [
              "basic"
            ]
          }
        }
      },
      "status": "Queued",
      "location": "9a010225-ca18-456b-9513-xxxxxxx/red-team-dd42eac8-ce07-4e79-8ee2-8b7dba083a76",
      "run_name": null,
      "project_name": "default",
      "actioner_email": null,
      "test_version": 3,
      "model_saved_name": null,
      "model_version": null,
      "coc_policy_name": null
    }
  }
}

Red Team API Documentation

Red Team APIs

Add Task with saved model

Authorizations

Headers

Body

Response