Skip to content

Runs a battery against an AUTHORIZED target and records the scorecard.

POST
/v1/m/redteam/runs
curl --request POST \
--url https://example.com/v1/m/redteam/runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "suite": "example", "target_ref": "example" }'

Runs a battery against an AUTHORIZED target and records the scorecard.

X-Olivares-Tenant
string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Media type application/json
object
suite
Any of:

After trimming, empty defaults to all; otherwise must be exactly all, injection, jailbreak, exfil or tool_poisoning.

string
target_ref
required

Must parse as a non-zero target identifier.

string
Example generated
{
"suite": "example",
"target_ref": "example"
}

OK

Media type application/json
object
Example generated
{}

Bad request

Media type application/json
object
Example generated
{}

Unauthenticated

Media type application/json
object
Example generated
{}

Forbidden

Media type application/json
object
Example generated
{}

Not found

Media type application/json
object
Example generated
{}

Conflict / setup required

Media type application/json
object
Example generated
{}

Rate limited

Media type application/json
object
Example generated
{}