Skip to content
DreadnodeDreadnodeDreadnode

Create run

POST
/api/v1/org/{org}/ws/{workspace}/airt/runs
curl --request POST \
  --url https://example.com/api/v1/org/example/ws/example/airt/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "project_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "secret_ids": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "spec": { "attacker_model": "example", "goals": [ { "attacks": [ { "early_stopping": 0.9, "n_iterations": 15, "transforms": [ "example" ], "type": "example" } ], "category": "example", "goal": "example", "goal_category": "example", "sub_category": "example" } ], "judge_model": "example", "max_tokens": 1024, "target_model": "example" }, "timeout_sec": 1 }'

Queue a red-team suite for the platform to run in its own sandbox. Each goal becomes one assessment.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
org
required
Org

Organization slug

string

Organization slug

workspace
required
Workspace

Workspace slug

string

Workspace slug

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
CreateAirtRunRequest
object
name
required
Name
string
>= 1 characters <= 255 characters
project_id
required
Project Id
string format: uuid
secret_ids
Any of:
Array<string>
spec
required
AirtRunSpec

The suite to run: dn airt run-suite’s config file, as JSON.

Targets are model ids only, reached through the platform’s model gateway or the provider’s own API.

object
attacker_model
Any of:
string
>= 1 characters <= 255 characters
goals
required
Goals
Array<object>
>= 1 items <= 50 items
AirtRunGoalSpec

One goal, which becomes one assessment holding each of its attacks.

object
attacks
required
Attacks
Array<object>
>= 1 items <= 20 items
AirtRunAttackSpec

One attack against a goal, as dn airt run-suite takes it.

object
early_stopping
Early Stopping
number
default: 0.9 <= 1
n_iterations
N Iterations
integer
default: 15 >= 1 <= 100
transforms
Transforms
Array<string>
<= 10 items
type
required
Type

Attack name from GET .../airt/catalog, e.g. tap

string
>= 1 characters <= 64 characters
category
Any of:
string
<= 100 characters
goal
required
Goal
string
>= 1 characters <= 4000 characters
goal_category
Any of:
string
<= 100 characters
sub_category
Any of:
string
<= 100 characters
judge_model
Any of:
string
>= 1 characters <= 255 characters
max_tokens
Max Tokens
integer
default: 1024 >= 1 <= 32768
target_model
required
Target Model
string
>= 1 characters <= 255 characters
timeout_sec
Any of:
integer
>= 60

Responses

Section titled “ Responses ”

201

Section titled “201”

Successful Response

Media typeapplication/json
AirtRunResponse
object
attacks_total
required
Attacks Total
integer
cancel_requested_at
Any of:
string format: date-time
completed_at
Any of:
string format: date-time
created_at
required
Created At
string format: date-time
created_by_user
Any of:
UserIdentityResponse

Small denormalized user identity for cross-domain byline display.

object
email
required
Email
string
full_name
Any of:
string
id
required
Id
string format: uuid
username
required
Username
string
error
Any of:
string
id
required
Id
string format: uuid
name
required
Name
string
organization_id
required
Organization Id
string format: uuid
progress
required
AirtRunProgress

What a run has done so far, kept on the run row.

object
assessments
Assessments
Array<object>
AirtRunAssessmentRef
object
assessment_id
required
Assessment Id
string format: uuid
goal_index
required
Goal Index
integer
attacks_completed
Attacks Completed
integer
0
attacks_failed
Attacks Failed
integer
0
project_id
required
Project Id
string format: uuid
spec
required
AirtRunSpec

The suite to run: dn airt run-suite’s config file, as JSON.

Targets are model ids only, reached through the platform’s model gateway or the provider’s own API.

object
attacker_model
Any of:
string
>= 1 characters <= 255 characters
goals
required
Goals
Array<object>
>= 1 items <= 50 items
AirtRunGoalSpec

One goal, which becomes one assessment holding each of its attacks.

object
attacks
required
Attacks
Array<object>
>= 1 items <= 20 items
AirtRunAttackSpec

One attack against a goal, as dn airt run-suite takes it.

object
early_stopping
Early Stopping
number
default: 0.9 <= 1
n_iterations
N Iterations
integer
default: 15 >= 1 <= 100
transforms
Transforms
Array<string>
<= 10 items
type
required
Type

Attack name from GET .../airt/catalog, e.g. tap

string
>= 1 characters <= 64 characters
category
Any of:
string
<= 100 characters
goal
required
Goal
string
>= 1 characters <= 4000 characters
goal_category
Any of:
string
<= 100 characters
sub_category
Any of:
string
<= 100 characters
judge_model
Any of:
string
>= 1 characters <= 255 characters
max_tokens
Max Tokens
integer
default: 1024 >= 1 <= 32768
target_model
required
Target Model
string
>= 1 characters <= 255 characters
started_at
Any of:
string format: date-time
status
required
Status
string
Allowed values: queued running completed failed cancelled
workspace_id
required
Workspace Id
string format: uuid
Example
{
  "progress": {
    "attacks_completed": 0,
    "attacks_failed": 0
  },
  "spec": {
    "goals": [
      {
        "attacks": [
          {
            "early_stopping": 0.9,
            "n_iterations": 15
          }
        ]
      }
    ],
    "max_tokens": 1024
  },
  "status": "queued"
}

400

Section titled “400”

Invalid request

Media typeapplication/json
APIErrorPayload

Canonical API error envelope returned by the API.

object
code
required
Code

HTTP status code

integer
Allowed values: 400 401 403 404 409 422 426 429 500 502 504
detail
required
Detail

Human-readable error message

string
errors
Any of:
Array<object>
ValidationErrorItem
object
loc
required
Loc

Where the validation error occurred

Array
msg
required
Msg

Human-readable validation message

string
type
required
Type

Machine-readable validation error type

string
type
required
Type

Stable machine-readable error type

string
Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error task_set_not_found token_error upgrade_required_error usage_limit_exceeded_error user_suspended user_verification_error validation_error
Example
{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

401

Section titled “401”

Authentication failed

Media typeapplication/json
APIErrorPayload

Canonical API error envelope returned by the API.

object
code
required
Code

HTTP status code

integer
Allowed values: 400 401 403 404 409 422 426 429 500 502 504
detail
required
Detail

Human-readable error message

string
errors
Any of:
Array<object>
ValidationErrorItem
object
loc
required
Loc

Where the validation error occurred

Array
msg
required
Msg

Human-readable validation message

string
type
required
Type

Machine-readable validation error type

string
type
required
Type

Stable machine-readable error type

string
Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error task_set_not_found token_error upgrade_required_error usage_limit_exceeded_error user_suspended user_verification_error validation_error
Example
{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

403

Section titled “403”

Access forbidden

Media typeapplication/json
APIErrorPayload

Canonical API error envelope returned by the API.

object
code
required
Code

HTTP status code

integer
Allowed values: 400 401 403 404 409 422 426 429 500 502 504
detail
required
Detail

Human-readable error message

string
errors
Any of:
Array<object>
ValidationErrorItem
object
loc
required
Loc

Where the validation error occurred

Array
msg
required
Msg

Human-readable validation message

string
type
required
Type

Machine-readable validation error type

string
type
required
Type

Stable machine-readable error type

string
Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error task_set_not_found token_error upgrade_required_error usage_limit_exceeded_error user_suspended user_verification_error validation_error
Example
{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

404

Section titled “404”

Not found

Media typeapplication/json
APIErrorPayload

Canonical API error envelope returned by the API.

object
code
required
Code

HTTP status code

integer
Allowed values: 400 401 403 404 409 422 426 429 500 502 504
detail
required
Detail

Human-readable error message

string
errors
Any of:
Array<object>
ValidationErrorItem
object
loc
required
Loc

Where the validation error occurred

Array
msg
required
Msg

Human-readable validation message

string
type
required
Type

Machine-readable validation error type

string
type
required
Type

Stable machine-readable error type

string
Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error task_set_not_found token_error upgrade_required_error usage_limit_exceeded_error user_suspended user_verification_error validation_error
Example
{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

409

Section titled “409”

Already exists

Media typeapplication/json
APIErrorPayload

Canonical API error envelope returned by the API.

object
code
required
Code

HTTP status code

integer
Allowed values: 400 401 403 404 409 422 426 429 500 502 504
detail
required
Detail

Human-readable error message

string
errors
Any of:
Array<object>
ValidationErrorItem
object
loc
required
Loc

Where the validation error occurred

Array
msg
required
Msg

Human-readable validation message

string
type
required
Type

Machine-readable validation error type

string
type
required
Type

Stable machine-readable error type

string
Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error task_set_not_found token_error upgrade_required_error usage_limit_exceeded_error user_suspended user_verification_error validation_error
Example
{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

422

Section titled “422”

Validation error

Media typeapplication/json
APIErrorPayload

Canonical API error envelope returned by the API.

object
code
required
Code

HTTP status code

integer
Allowed values: 400 401 403 404 409 422 426 429 500 502 504
detail
required
Detail

Human-readable error message

string
errors
Any of:
Array<object>
ValidationErrorItem
object
loc
required
Loc

Where the validation error occurred

Array
msg
required
Msg

Human-readable validation message

string
type
required
Type

Machine-readable validation error type

string
type
required
Type

Stable machine-readable error type

string
Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error task_set_not_found token_error upgrade_required_error usage_limit_exceeded_error user_suspended user_verification_error validation_error
Example
{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

426

Section titled “426”

Upgrade required

Media typeapplication/json
APIErrorPayload

Canonical API error envelope returned by the API.

object
code
required
Code

HTTP status code

integer
Allowed values: 400 401 403 404 409 422 426 429 500 502 504
detail
required
Detail

Human-readable error message

string
errors
Any of:
Array<object>
ValidationErrorItem
object
loc
required
Loc

Where the validation error occurred

Array
msg
required
Msg

Human-readable validation message

string
type
required
Type

Machine-readable validation error type

string
type
required
Type

Stable machine-readable error type

string
Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error task_set_not_found token_error upgrade_required_error usage_limit_exceeded_error user_suspended user_verification_error validation_error
Example
{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

429

Section titled “429”

Rate limited

Media typeapplication/json
APIErrorPayload

Canonical API error envelope returned by the API.

object
code
required
Code

HTTP status code

integer
Allowed values: 400 401 403 404 409 422 426 429 500 502 504
detail
required
Detail

Human-readable error message

string
errors
Any of:
Array<object>
ValidationErrorItem
object
loc
required
Loc

Where the validation error occurred

Array
msg
required
Msg

Human-readable validation message

string
type
required
Type

Machine-readable validation error type

string
type
required
Type

Stable machine-readable error type

string
Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error task_set_not_found token_error upgrade_required_error usage_limit_exceeded_error user_suspended user_verification_error validation_error
Example
{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

500

Section titled “500”

Internal server error

Media typeapplication/json
APIErrorPayload

Canonical API error envelope returned by the API.

object
code
required
Code

HTTP status code

integer
Allowed values: 400 401 403 404 409 422 426 429 500 502 504
detail
required
Detail

Human-readable error message

string
errors
Any of:
Array<object>
ValidationErrorItem
object
loc
required
Loc

Where the validation error occurred

Array
msg
required
Msg

Human-readable validation message

string
type
required
Type

Machine-readable validation error type

string
type
required
Type

Stable machine-readable error type

string
Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error task_set_not_found token_error upgrade_required_error usage_limit_exceeded_error user_suspended user_verification_error validation_error
Example
{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

502

Section titled “502”

Bad gateway

Media typeapplication/json
APIErrorPayload

Canonical API error envelope returned by the API.

object
code
required
Code

HTTP status code

integer
Allowed values: 400 401 403 404 409 422 426 429 500 502 504
detail
required
Detail

Human-readable error message

string
errors
Any of:
Array<object>
ValidationErrorItem
object
loc
required
Loc

Where the validation error occurred

Array
msg
required
Msg

Human-readable validation message

string
type
required
Type

Machine-readable validation error type

string
type
required
Type

Stable machine-readable error type

string
Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error task_set_not_found token_error upgrade_required_error usage_limit_exceeded_error user_suspended user_verification_error validation_error
Example
{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}

504

Section titled “504”

Gateway timeout

Media typeapplication/json
APIErrorPayload

Canonical API error envelope returned by the API.

object
code
required
Code

HTTP status code

integer
Allowed values: 400 401 403 404 409 422 426 429 500 502 504
detail
required
Detail

Human-readable error message

string
errors
Any of:
Array<object>
ValidationErrorItem
object
loc
required
Loc

Where the validation error occurred

Array
msg
required
Msg

Human-readable validation message

string
type
required
Type

Machine-readable validation error type

string
type
required
Type

Stable machine-readable error type

string
Allowed values: already_exists_error app_error authentication_error conflict_error aws_error configuration_error database_error dynamodb_error e2b_error e2b_rate_limit_error expired_signature_error expired_token_error forbidden_error group_error invalid_error invalid_flag_error invalid_username_error mail_error member_exists_error member_limit_exceeded_error migration_lock_timeout_error not_found_error oauth_config_error org_sandbox_capacity_exceeded_error bad_gateway_error gateway_timeout_error s3_error server_error task_error stripe_error task_set_not_found token_error upgrade_required_error usage_limit_exceeded_error user_suspended user_verification_error validation_error
Example
{
  "code": 401,
  "detail": "Authentication failed",
  "type": "authentication_error"
}