v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-21149158448.6 KB
Red Team
redteam

Create Campaign

Create a new red team campaign.

Launches a K8s Job to run the selected tool against the target agent. Returns immediately with a pending status; poll via GET for updates.

post/v1/campaigns

Request body

team_idstring uuid required

Team that owns this campaign

tool'diamond_security' | 'promptfoo' | 'garak' | 'pyrit' | 'unknown' required

Supported red team tools.

agent_urlstring uri nullable

Target agent endpoint URL

agent_idstring uuid nullable

Agent ID from Agent Registry (resolves URL)

agent_api_keystring nullable

API key for the target agent

agent_model_namestring nullable

Model name if agent is an LLM gateway

purposestring required

Agent purpose description (for context-aware attacks)

categoriesAttackCategory[] required

Attack categories to test

custom_pluginsstring[] nullable

Custom plugin/probe names (for CUSTOM category)

strategiesstring[] nullable

Evaluation strategies (tool-specific)

num_testsinteger

Number of test cases per category

provider_configobject nullable

Provider-specific configuration

Response

Successful Response

campaign_idstring uuid required
statusstring required