Skip to main content
PATCH
Python

Authorizations

Authorization
string
header
required

API Key authentication. Format: "Bearer YOUR_API_KEY"

Path Parameters

spec_id
string<uuid>
required

UUID of the red team spec

Body

application/json

Request body for updating a red team spec (all fields optional)

name
string

New name for the spec (will be converted to snake_case)

domain_description
string

Updated domain description

app_description
string

Updated application description

concerns
string

Updated security concerns

Response

Red team spec updated successfully

A red team specification defining the application context for adversarial prompt generation

id
string<uuid>
read-only

Unique identifier for the red team spec

name
string

Name of the red team spec (auto-converted to snake_case)

domain_description
string

Description of the domain or industry the application operates in

app_description
string

Description of the application being tested, including its purpose and functionality

concerns
string | null

Specific security concerns or behaviors to focus on during red teaming

created_at
string<date-time>
read-only

Timestamp when the spec was created

updated_at
string<date-time>
read-only

Timestamp when the spec was last modified

company_id
string<uuid>
read-only

ID of the company that owns this spec

company_name
string
read-only

Name of the company that owns this spec

created_by
integer
read-only

ID of the user who created this spec

created_by_email
string
read-only

Email of the user who created this spec