Class: RedTeamReportsClient

Defined in: src/red-team/reports-client.ts:60

Client for Red Team data plane report operations.

Constructors

Constructor

new RedTeamReportsClient(opts): RedTeamReportsClient;

Defined in: src/red-team/reports-client.ts:65

Parameters

Parameter	Type
opts	RedTeamReportsClientOptions

Returns

RedTeamReportsClient

Methods

listAttacks()

listAttacks(jobId, opts?): Promise<objectOutputType<{
  pagination: ZodObject<{
     total_items: ZodOptional<ZodNullable<ZodNumber>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     total_items: ZodOptional<ZodNullable<ZodNumber>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     total_items: ZodOptional<ZodNullable<ZodNumber>>;
  }, ZodTypeAny, "passthrough">>;
  data: ZodArray<ZodObject<{
     uuid: ZodString;
     tsg_id: ZodString;
     job_id: ZodString;
     target_id: ZodString;
     prompt: ZodString;
     prompt_mapping_id: ZodString;
     prompt_id: ZodString;
     category: ZodString;
     sub_category: ZodString;
     category_display_name: ZodString;
     sub_category_display_name: ZodString;
     status: ZodOptional<ZodString>;
     marked_safe: ZodOptional<ZodNullable<ZodBoolean>>;
     extra_info: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
     threat: ZodOptional<ZodNullable<ZodBoolean>>;
     attack_type: ZodOptional<ZodString>;
     multi_turn: ZodOptional<ZodBoolean>;
     asr: ZodOptional<ZodNullable<ZodNumber>>;
     version: ZodOptional<ZodNullable<ZodNumber>>;
     severity: ZodOptional<ZodString>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     uuid: ZodString;
     tsg_id: ZodString;
     job_id: ZodString;
     target_id: ZodString;
     prompt: ZodString;
     prompt_mapping_id: ZodString;
     prompt_id: ZodString;
     category: ZodString;
     sub_category: ZodString;
     category_display_name: ZodString;
     sub_category_display_name: ZodString;
     status: ZodOptional<ZodString>;
     marked_safe: ZodOptional<ZodNullable<ZodBoolean>>;
     extra_info: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
     threat: ZodOptional<ZodNullable<ZodBoolean>>;
     attack_type: ZodOptional<ZodString>;
     multi_turn: ZodOptional<ZodBoolean>;
     asr: ZodOptional<ZodNullable<ZodNumber>>;
     version: ZodOptional<ZodNullable<ZodNumber>>;
     severity: ZodOptional<ZodString>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     uuid: ZodString;
     tsg_id: ZodString;
     job_id: ZodString;
     target_id: ZodString;
     prompt: ZodString;
     prompt_mapping_id: ZodString;
     prompt_id: ZodString;
     category: ZodString;
     sub_category: ZodString;
     category_display_name: ZodString;
     sub_category_display_name: ZodString;
     status: ZodOptional<ZodString>;
     marked_safe: ZodOptional<ZodNullable<ZodBoolean>>;
     extra_info: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
     threat: ZodOptional<ZodNullable<ZodBoolean>>;
     attack_type: ZodOptional<ZodString>;
     multi_turn: ZodOptional<ZodBoolean>;
     asr: ZodOptional<ZodNullable<ZodNumber>>;
     version: ZodOptional<ZodNullable<ZodNumber>>;
     severity: ZodOptional<ZodString>;
  }, ZodTypeAny, "passthrough">>, "many">;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/reports-client.ts:93

List attacks for a static scan.

Parameters

Parameter	Type	Description
jobId	string	The job UUID.
opts?	AttackListOptions	Optional pagination, search, and filter options.

Returns

Promise<objectOutputType<{ pagination: ZodObject<{ total_items: ZodOptional<ZodNullable<ZodNumber>>; }, "passthrough", ZodTypeAny, objectOutputType<{ total_items: ZodOptional<ZodNullable<ZodNumber>>; }, ZodTypeAny, "passthrough">, objectInputType<{ total_items: ZodOptional<ZodNullable<ZodNumber>>; }, ZodTypeAny, "passthrough">>; data: ZodArray<ZodObject<{ uuid: ZodString; tsg_id: ZodString; job_id: ZodString; target_id: ZodString; prompt: ZodString; prompt_mapping_id: ZodString; prompt_id: ZodString; category: ZodString; sub_category: ZodString; category_display_name: ZodString; sub_category_display_name: ZodString; status: ZodOptional<ZodString>; marked_safe: ZodOptional<ZodNullable<ZodBoolean>>; extra_info: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; threat: ZodOptional<ZodNullable<ZodBoolean>>; attack_type: ZodOptional<ZodString>; multi_turn: ZodOptional<ZodBoolean>; asr: ZodOptional<ZodNullable<ZodNumber>>; version: ZodOptional<ZodNullable<ZodNumber>>; severity: ZodOptional<ZodString>; }, "passthrough", ZodTypeAny, objectOutputType<{ uuid: ZodString; tsg_id: ZodString; job_id: ZodString; target_id: ZodString; prompt: ZodString; prompt_mapping_id: ZodString; prompt_id: ZodString; category: ZodString; sub_category: ZodString; category_display_name: ZodString; sub_category_display_name: ZodString; status: ZodOptional<ZodString>; marked_safe: ZodOptional<ZodNullable<ZodBoolean>>; extra_info: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; threat: ZodOptional<ZodNullable<ZodBoolean>>; attack_type: ZodOptional<ZodString>; multi_turn: ZodOptional<ZodBoolean>; asr: ZodOptional<ZodNullable<ZodNumber>>; version: ZodOptional<ZodNullable<ZodNumber>>; severity: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">, objectInputType<{ uuid: ZodString; tsg_id: ZodString; job_id: ZodString; target_id: ZodString; prompt: ZodString; prompt_mapping_id: ZodString; prompt_id: ZodString; category: ZodString; sub_category: ZodString; category_display_name: ZodString; sub_category_display_name: ZodString; status: ZodOptional<ZodString>; marked_safe: ZodOptional<ZodNullable<ZodBoolean>>; extra_info: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; threat: ZodOptional<ZodNullable<ZodBoolean>>; attack_type: ZodOptional<ZodString>; multi_turn: ZodOptional<ZodBoolean>; asr: ZodOptional<ZodNullable<ZodNumber>>; version: ZodOptional<ZodNullable<ZodNumber>>; severity: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">>, "many">; }, ZodTypeAny, "passthrough">>

The paginated list of attacks.

Example

import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();

const attacks = await rt.reports.listAttacks('550e8400-e29b-41d4-a716-446655440000', {
  threat: true,
  limit: 20,
});
// attacks =>
// { pagination: { total_items: 1 }, data: [{ uuid: '550e8400-...', category: 'jailbreak', prompt: '...' }] }

---

getAttackDetail()

getAttackDetail(jobId, attackId): Promise<objectOutputType<{
  uuid: ZodString;
  tsg_id: ZodString;
  job_id: ZodString;
  target_id: ZodString;
  prompt: ZodString;
  prompt_mapping_id: ZodString;
  prompt_id: ZodString;
  category: ZodString;
  sub_category: ZodString;
  category_display_name: ZodString;
  sub_category_display_name: ZodString;
  compliance_frameworks: ZodArray<ZodUnknown, "many">;
  goal: ZodNullable<ZodString>;
  status: ZodOptional<ZodString>;
  marked_safe: ZodOptional<ZodNullable<ZodBoolean>>;
  extra_info: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
  threat: ZodOptional<ZodNullable<ZodBoolean>>;
  attack_type: ZodOptional<ZodString>;
  multi_turn: ZodOptional<ZodBoolean>;
  asr: ZodOptional<ZodNullable<ZodNumber>>;
  version: ZodOptional<ZodNullable<ZodNumber>>;
  severity: ZodOptional<ZodString>;
  outputs: ZodOptional<ZodArray<ZodObject<{
     uuid: ZodString;
     tsg_id: ZodString;
     attack_id: ZodString;
     job_id: ZodString;
     target_id: ZodString;
     output: ZodString;
     threat: ZodOptional<ZodNullable<ZodBoolean>>;
     marked_safe: ZodOptional<ZodNullable<ZodBoolean>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     uuid: ZodString;
     tsg_id: ZodString;
     attack_id: ZodString;
     job_id: ZodString;
     target_id: ZodString;
     output: ZodString;
     threat: ZodOptional<ZodNullable<ZodBoolean>>;
     marked_safe: ZodOptional<ZodNullable<ZodBoolean>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     uuid: ZodString;
     tsg_id: ZodString;
     attack_id: ZodString;
     job_id: ZodString;
     target_id: ZodString;
     output: ZodString;
     threat: ZodOptional<ZodNullable<ZodBoolean>>;
     marked_safe: ZodOptional<ZodNullable<ZodBoolean>>;
  }, ZodTypeAny, "passthrough">>, "many">>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/reports-client.ts:132

Get attack details for a static scan.

Parameters

Parameter	Type	Description
jobId	string	The job UUID.
attackId	string	The attack UUID.

Returns

Promise<objectOutputType<{ uuid: ZodString; tsg_id: ZodString; job_id: ZodString; target_id: ZodString; prompt: ZodString; prompt_mapping_id: ZodString; prompt_id: ZodString; category: ZodString; sub_category: ZodString; category_display_name: ZodString; sub_category_display_name: ZodString; compliance_frameworks: ZodArray<ZodUnknown, "many">; goal: ZodNullable<ZodString>; status: ZodOptional<ZodString>; marked_safe: ZodOptional<ZodNullable<ZodBoolean>>; extra_info: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; threat: ZodOptional<ZodNullable<ZodBoolean>>; attack_type: ZodOptional<ZodString>; multi_turn: ZodOptional<ZodBoolean>; asr: ZodOptional<ZodNullable<ZodNumber>>; version: ZodOptional<ZodNullable<ZodNumber>>; severity: ZodOptional<ZodString>; outputs: ZodOptional<ZodArray<ZodObject<{ uuid: ZodString; tsg_id: ZodString; attack_id: ZodString; job_id: ZodString; target_id: ZodString; output: ZodString; threat: ZodOptional<ZodNullable<ZodBoolean>>; marked_safe: ZodOptional<ZodNullable<ZodBoolean>>; }, "passthrough", ZodTypeAny, objectOutputType<{ uuid: ZodString; tsg_id: ZodString; attack_id: ZodString; job_id: ZodString; target_id: ZodString; output: ZodString; threat: ZodOptional<ZodNullable<ZodBoolean>>; marked_safe: ZodOptional<ZodNullable<ZodBoolean>>; }, ZodTypeAny, "passthrough">, objectInputType<{ uuid: ZodString; tsg_id: ZodString; attack_id: ZodString; job_id: ZodString; target_id: ZodString; output: ZodString; threat: ZodOptional<ZodNullable<ZodBoolean>>; marked_safe: ZodOptional<ZodNullable<ZodBoolean>>; }, ZodTypeAny, "passthrough">>, "many">>; }, ZodTypeAny, "passthrough">>

The attack detail response.

Example

import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();

const detail = await rt.reports.getAttackDetail(
  '550e8400-e29b-41d4-a716-446655440000',
  '550e8400-e29b-41d4-a716-446655440000',
);
// detail =>
// { uuid: '550e8400-...', category: 'jailbreak', sub_category: 'jb-1', prompt: 'p', goal: null }

---

getMultiTurnAttackDetail()

getMultiTurnAttackDetail(jobId, attackId): Promise<objectOutputType<{
  uuid: ZodString;
  tsg_id: ZodString;
  job_id: ZodString;
  target_id: ZodString;
  prompt: ZodString;
  prompt_mapping_id: ZodString;
  prompt_id: ZodString;
  category: ZodString;
  sub_category: ZodString;
  category_display_name: ZodString;
  sub_category_display_name: ZodString;
  compliance_frameworks: ZodArray<ZodUnknown, "many">;
  goal: ZodNullable<ZodString>;
  status: ZodOptional<ZodString>;
  marked_safe: ZodOptional<ZodNullable<ZodBoolean>>;
  extra_info: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
  threat: ZodOptional<ZodNullable<ZodBoolean>>;
  attack_type: ZodOptional<ZodString>;
  multi_turn: ZodOptional<ZodBoolean>;
  asr: ZodOptional<ZodNullable<ZodNumber>>;
  version: ZodOptional<ZodNullable<ZodNumber>>;
  severity: ZodOptional<ZodString>;
  outputs: ZodOptional<ZodArray<ZodObject<{
     uuid: ZodString;
     tsg_id: ZodString;
     attack_id: ZodString;
     job_id: ZodString;
     target_id: ZodString;
     output: ZodString;
     prompt: ZodString;
     turn: ZodNumber;
     threat: ZodOptional<ZodNullable<ZodBoolean>>;
     marked_safe: ZodOptional<ZodNullable<ZodBoolean>>;
     generation: ZodOptional<ZodNumber>;
     multi_turn: ZodOptional<ZodBoolean>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     uuid: ZodString;
     tsg_id: ZodString;
     attack_id: ZodString;
     job_id: ZodString;
     target_id: ZodString;
     output: ZodString;
     prompt: ZodString;
     turn: ZodNumber;
     threat: ZodOptional<ZodNullable<ZodBoolean>>;
     marked_safe: ZodOptional<ZodNullable<ZodBoolean>>;
     generation: ZodOptional<ZodNumber>;
     multi_turn: ZodOptional<ZodBoolean>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     uuid: ZodString;
     tsg_id: ZodString;
     attack_id: ZodString;
     job_id: ZodString;
     target_id: ZodString;
     output: ZodString;
     prompt: ZodString;
     turn: ZodNumber;
     threat: ZodOptional<ZodNullable<ZodBoolean>>;
     marked_safe: ZodOptional<ZodNullable<ZodBoolean>>;
     generation: ZodOptional<ZodNumber>;
     multi_turn: ZodOptional<ZodBoolean>;
  }, ZodTypeAny, "passthrough">>, "many">>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/reports-client.ts:163

Get multi-turn attack details for a static scan.

Parameters

Parameter	Type	Description
jobId	string	The job UUID.
attackId	string	The attack UUID.

Returns

Promise<objectOutputType<{ uuid: ZodString; tsg_id: ZodString; job_id: ZodString; target_id: ZodString; prompt: ZodString; prompt_mapping_id: ZodString; prompt_id: ZodString; category: ZodString; sub_category: ZodString; category_display_name: ZodString; sub_category_display_name: ZodString; compliance_frameworks: ZodArray<ZodUnknown, "many">; goal: ZodNullable<ZodString>; status: ZodOptional<ZodString>; marked_safe: ZodOptional<ZodNullable<ZodBoolean>>; extra_info: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; threat: ZodOptional<ZodNullable<ZodBoolean>>; attack_type: ZodOptional<ZodString>; multi_turn: ZodOptional<ZodBoolean>; asr: ZodOptional<ZodNullable<ZodNumber>>; version: ZodOptional<ZodNullable<ZodNumber>>; severity: ZodOptional<ZodString>; outputs: ZodOptional<ZodArray<ZodObject<{ uuid: ZodString; tsg_id: ZodString; attack_id: ZodString; job_id: ZodString; target_id: ZodString; output: ZodString; prompt: ZodString; turn: ZodNumber; threat: ZodOptional<ZodNullable<ZodBoolean>>; marked_safe: ZodOptional<ZodNullable<ZodBoolean>>; generation: ZodOptional<ZodNumber>; multi_turn: ZodOptional<ZodBoolean>; }, "passthrough", ZodTypeAny, objectOutputType<{ uuid: ZodString; tsg_id: ZodString; attack_id: ZodString; job_id: ZodString; target_id: ZodString; output: ZodString; prompt: ZodString; turn: ZodNumber; threat: ZodOptional<ZodNullable<ZodBoolean>>; marked_safe: ZodOptional<ZodNullable<ZodBoolean>>; generation: ZodOptional<ZodNumber>; multi_turn: ZodOptional<ZodBoolean>; }, ZodTypeAny, "passthrough">, objectInputType<{ uuid: ZodString; tsg_id: ZodString; attack_id: ZodString; job_id: ZodString; target_id: ZodString; output: ZodString; prompt: ZodString; turn: ZodNumber; threat: ZodOptional<ZodNullable<ZodBoolean>>; marked_safe: ZodOptional<ZodNullable<ZodBoolean>>; generation: ZodOptional<ZodNumber>; multi_turn: ZodOptional<ZodBoolean>; }, ZodTypeAny, "passthrough">>, "many">>; }, ZodTypeAny, "passthrough">>

The multi-turn attack detail response.

Example

import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();

const detail = await rt.reports.getMultiTurnAttackDetail(
  '550e8400-e29b-41d4-a716-446655440000',
  '550e8400-e29b-41d4-a716-446655440000',
);
// detail =>
// { uuid: '550e8400-...', category: 'jailbreak', sub_category: 'jb-1', prompt: 'p' }

---

getStaticReport()

getStaticReport(jobId): Promise<objectOutputType<{
  severity_report: ZodObject<{
     stats: ZodArray<ZodObject<{
        severity: ZodString;
        successful: ZodOptional<ZodNumber>;
        failed: ZodOptional<ZodNumber>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        severity: ZodString;
        successful: ZodOptional<ZodNumber>;
        failed: ZodOptional<ZodNumber>;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        severity: ZodString;
        successful: ZodOptional<ZodNumber>;
        failed: ZodOptional<ZodNumber>;
     }, ZodTypeAny, "passthrough">>, "many">;
     successful: ZodOptional<ZodNumber>;
     failed: ZodOptional<ZodNumber>;
     total_attacks: ZodOptional<ZodNumber>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     stats: ZodArray<ZodObject<{
        severity: ZodString;
        successful: ZodOptional<ZodNumber>;
        failed: ZodOptional<ZodNumber>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        severity: ZodString;
        successful: ZodOptional<...>;
        failed: ZodOptional<...>;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        severity: ZodString;
        successful: ZodOptional<...>;
        failed: ZodOptional<...>;
     }, ZodTypeAny, "passthrough">>, "many">;
     successful: ZodOptional<ZodNumber>;
     failed: ZodOptional<ZodNumber>;
     total_attacks: ZodOptional<ZodNumber>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     stats: ZodArray<ZodObject<{
        severity: ZodString;
        successful: ZodOptional<ZodNumber>;
        failed: ZodOptional<ZodNumber>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        severity: ZodString;
        successful: ZodOptional<...>;
        failed: ZodOptional<...>;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        severity: ZodString;
        successful: ZodOptional<...>;
        failed: ZodOptional<...>;
     }, ZodTypeAny, "passthrough">>, "many">;
     successful: ZodOptional<ZodNumber>;
     failed: ZodOptional<ZodNumber>;
     total_attacks: ZodOptional<ZodNumber>;
  }, ZodTypeAny, "passthrough">>;
  asr: ZodOptional<ZodNullable<ZodNumber>>;
  score: ZodOptional<ZodNullable<ZodNumber>>;
  security_report: ZodOptional<ZodNullable<ZodObject<{
     id: ZodString;
     display_name: ZodString;
     description: ZodString;
     preselect: ZodOptional<ZodBoolean>;
     sub_categories: ZodArray<ZodObject<{
        id: ZodString;
        display_name: ZodString;
        description: ZodString;
        preselect: ZodOptional<...>;
        prerequisites: ZodOptional<...>;
        active: ZodOptional<...>;
        successful: ZodNumber;
        failed: ZodNumber;
        total: ZodOptional<...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        id: ...;
        display_name: ...;
        description: ...;
        preselect: ...;
        prerequisites: ...;
        active: ...;
        successful: ...;
        failed: ...;
        total: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        id: ...;
        display_name: ...;
        description: ...;
        preselect: ...;
        prerequisites: ...;
        active: ...;
        successful: ...;
        failed: ...;
        total: ...;
     }, ZodTypeAny, "passthrough">>, "many">;
     asr: ZodNumber;
     total_prompts: ZodNumber;
     total_attacks: ZodNumber;
     successful: ZodNumber;
     failed: ZodNumber;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     id: ZodString;
     display_name: ZodString;
     description: ZodString;
     preselect: ZodOptional<ZodBoolean>;
     sub_categories: ZodArray<ZodObject<{
        id: ...;
        display_name: ...;
        description: ...;
        preselect: ...;
        prerequisites: ...;
        active: ...;
        successful: ...;
        failed: ...;
        total: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">;
     asr: ZodNumber;
     total_prompts: ZodNumber;
     total_attacks: ZodNumber;
     successful: ZodNumber;
     failed: ZodNumber;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     id: ZodString;
     display_name: ZodString;
     description: ZodString;
     preselect: ZodOptional<ZodBoolean>;
     sub_categories: ZodArray<ZodObject<{
        id: ...;
        display_name: ...;
        description: ...;
        preselect: ...;
        prerequisites: ...;
        active: ...;
        successful: ...;
        failed: ...;
        total: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">;
     asr: ZodNumber;
     total_prompts: ZodNumber;
     total_attacks: ZodNumber;
     successful: ZodNumber;
     failed: ZodNumber;
  }, ZodTypeAny, "passthrough">>>>;
  safety_report: ZodOptional<ZodNullable<ZodObject<{
     id: ZodString;
     display_name: ZodString;
     description: ZodString;
     preselect: ZodOptional<ZodBoolean>;
     sub_categories: ZodArray<ZodObject<{
        id: ZodString;
        display_name: ZodString;
        description: ZodString;
        preselect: ZodOptional<...>;
        prerequisites: ZodOptional<...>;
        active: ZodOptional<...>;
        successful: ZodNumber;
        failed: ZodNumber;
        total: ZodOptional<...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        id: ...;
        display_name: ...;
        description: ...;
        preselect: ...;
        prerequisites: ...;
        active: ...;
        successful: ...;
        failed: ...;
        total: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        id: ...;
        display_name: ...;
        description: ...;
        preselect: ...;
        prerequisites: ...;
        active: ...;
        successful: ...;
        failed: ...;
        total: ...;
     }, ZodTypeAny, "passthrough">>, "many">;
     asr: ZodNumber;
     total_prompts: ZodNumber;
     total_attacks: ZodNumber;
     successful: ZodNumber;
     failed: ZodNumber;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     id: ZodString;
     display_name: ZodString;
     description: ZodString;
     preselect: ZodOptional<ZodBoolean>;
     sub_categories: ZodArray<ZodObject<{
        id: ...;
        display_name: ...;
        description: ...;
        preselect: ...;
        prerequisites: ...;
        active: ...;
        successful: ...;
        failed: ...;
        total: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">;
     asr: ZodNumber;
     total_prompts: ZodNumber;
     total_attacks: ZodNumber;
     successful: ZodNumber;
     failed: ZodNumber;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     id: ZodString;
     display_name: ZodString;
     description: ZodString;
     preselect: ZodOptional<ZodBoolean>;
     sub_categories: ZodArray<ZodObject<{
        id: ...;
        display_name: ...;
        description: ...;
        preselect: ...;
        prerequisites: ...;
        active: ...;
        successful: ...;
        failed: ...;
        total: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">;
     asr: ZodNumber;
     total_prompts: ZodNumber;
     total_attacks: ZodNumber;
     successful: ZodNumber;
     failed: ZodNumber;
  }, ZodTypeAny, "passthrough">>>>;
  brand_report: ZodOptional<ZodNullable<ZodObject<{
     id: ZodString;
     display_name: ZodString;
     description: ZodString;
     preselect: ZodOptional<ZodBoolean>;
     sub_categories: ZodArray<ZodObject<{
        id: ZodString;
        display_name: ZodString;
        description: ZodString;
        preselect: ZodOptional<...>;
        prerequisites: ZodOptional<...>;
        active: ZodOptional<...>;
        successful: ZodNumber;
        failed: ZodNumber;
        total: ZodOptional<...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        id: ...;
        display_name: ...;
        description: ...;
        preselect: ...;
        prerequisites: ...;
        active: ...;
        successful: ...;
        failed: ...;
        total: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        id: ...;
        display_name: ...;
        description: ...;
        preselect: ...;
        prerequisites: ...;
        active: ...;
        successful: ...;
        failed: ...;
        total: ...;
     }, ZodTypeAny, "passthrough">>, "many">;
     asr: ZodNumber;
     total_prompts: ZodNumber;
     total_attacks: ZodNumber;
     successful: ZodNumber;
     failed: ZodNumber;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     id: ZodString;
     display_name: ZodString;
     description: ZodString;
     preselect: ZodOptional<ZodBoolean>;
     sub_categories: ZodArray<ZodObject<{
        id: ...;
        display_name: ...;
        description: ...;
        preselect: ...;
        prerequisites: ...;
        active: ...;
        successful: ...;
        failed: ...;
        total: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">;
     asr: ZodNumber;
     total_prompts: ZodNumber;
     total_attacks: ZodNumber;
     successful: ZodNumber;
     failed: ZodNumber;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     id: ZodString;
     display_name: ZodString;
     description: ZodString;
     preselect: ZodOptional<ZodBoolean>;
     sub_categories: ZodArray<ZodObject<{
        id: ...;
        display_name: ...;
        description: ...;
        preselect: ...;
        prerequisites: ...;
        active: ...;
        successful: ...;
        failed: ...;
        total: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">;
     asr: ZodNumber;
     total_prompts: ZodNumber;
     total_attacks: ZodNumber;
     successful: ZodNumber;
     failed: ZodNumber;
  }, ZodTypeAny, "passthrough">>>>;
  compliance_report: ZodOptional<ZodNullable<ZodArray<ZodObject<{
     id: ZodString;
     display_name: ZodString;
     description: ZodString;
     active: ZodBoolean;
     version: ZodString;
     link: ZodString;
     techniques: ZodArray<ZodObject<{
        id: ...;
        display_name: ...;
        compliance_id: ...;
        description: ...;
        link: ...;
        version: ...;
        active: ...;
        successful: ...;
        failed: ...;
        total: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">;
     score: ZodOptional<ZodNumber>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     id: ZodString;
     display_name: ZodString;
     description: ZodString;
     active: ZodBoolean;
     version: ZodString;
     link: ZodString;
     techniques: ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">;
     score: ZodOptional<ZodNumber>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     id: ZodString;
     display_name: ZodString;
     description: ZodString;
     active: ZodBoolean;
     version: ZodString;
     link: ZodString;
     techniques: ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">;
     score: ZodOptional<ZodNumber>;
  }, ZodTypeAny, "passthrough">>, "many">>>;
  report_summary: ZodOptional<ZodNullable<ZodString>>;
  recommendations: ZodOptional<ZodNullable<ZodObject<{
     runtime_security_policy_configuration: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
     other_measures: ZodOptional<ZodArray<ZodObject<{
        remediation: ...;
        description: ...;
        mapping_remediation_id: ...;
        subcategories: ...;
        effectiveness: ...;
        ease_of_implementation: ...;
        priority: ...;
        resource_links: ...;
        categories: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     runtime_security_policy_configuration: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     other_measures: ZodOptional<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     runtime_security_policy_configuration: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     other_measures: ZodOptional<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>;
  }, ZodTypeAny, "passthrough">>>>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/reports-client.ts:193

Get the attack library report for a static scan.

Parameters

Parameter	Type	Description
jobId	string	The job UUID.

Returns

Promise<objectOutputType<{ severity_report: ZodObject<{ stats: ZodArray<ZodObject<{ severity: ZodString; successful: ZodOptional<ZodNumber>; failed: ZodOptional<ZodNumber>; }, "passthrough", ZodTypeAny, objectOutputType<{ severity: ZodString; successful: ZodOptional<ZodNumber>; failed: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">, objectInputType<{ severity: ZodString; successful: ZodOptional<ZodNumber>; failed: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">>, "many">; successful: ZodOptional<ZodNumber>; failed: ZodOptional<ZodNumber>; total_attacks: ZodOptional<ZodNumber>; }, "passthrough", ZodTypeAny, objectOutputType<{ stats: ZodArray<ZodObject<{ severity: ZodString; successful: ZodOptional<ZodNumber>; failed: ZodOptional<ZodNumber>; }, "passthrough", ZodTypeAny, objectOutputType<{ severity: ZodString; successful: ZodOptional<...>; failed: ZodOptional<...>; }, ZodTypeAny, "passthrough">, objectInputType<{ severity: ZodString; successful: ZodOptional<...>; failed: ZodOptional<...>; }, ZodTypeAny, "passthrough">>, "many">; successful: ZodOptional<ZodNumber>; failed: ZodOptional<ZodNumber>; total_attacks: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">, objectInputType<{ stats: ZodArray<ZodObject<{ severity: ZodString; successful: ZodOptional<ZodNumber>; failed: ZodOptional<ZodNumber>; }, "passthrough", ZodTypeAny, objectOutputType<{ severity: ZodString; successful: ZodOptional<...>; failed: ZodOptional<...>; }, ZodTypeAny, "passthrough">, objectInputType<{ severity: ZodString; successful: ZodOptional<...>; failed: ZodOptional<...>; }, ZodTypeAny, "passthrough">>, "many">; successful: ZodOptional<ZodNumber>; failed: ZodOptional<ZodNumber>; total_attacks: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">>; asr: ZodOptional<ZodNullable<ZodNumber>>; score: ZodOptional<ZodNullable<ZodNumber>>; security_report: ZodOptional<ZodNullable<ZodObject<{ id: ZodString; display_name: ZodString; description: ZodString; preselect: ZodOptional<ZodBoolean>; sub_categories: ZodArray<ZodObject<{ id: ZodString; display_name: ZodString; description: ZodString; preselect: ZodOptional<...>; prerequisites: ZodOptional<...>; active: ZodOptional<...>; successful: ZodNumber; failed: ZodNumber; total: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ id: ...; display_name: ...; description: ...; preselect: ...; prerequisites: ...; active: ...; successful: ...; failed: ...; total: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ id: ...; display_name: ...; description: ...; preselect: ...; prerequisites: ...; active: ...; successful: ...; failed: ...; total: ...; }, ZodTypeAny, "passthrough">>, "many">; asr: ZodNumber; total_prompts: ZodNumber; total_attacks: ZodNumber; successful: ZodNumber; failed: ZodNumber; }, "passthrough", ZodTypeAny, objectOutputType<{ id: ZodString; display_name: ZodString; description: ZodString; preselect: ZodOptional<ZodBoolean>; sub_categories: ZodArray<ZodObject<{ id: ...; display_name: ...; description: ...; preselect: ...; prerequisites: ...; active: ...; successful: ...; failed: ...; total: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">; asr: ZodNumber; total_prompts: ZodNumber; total_attacks: ZodNumber; successful: ZodNumber; failed: ZodNumber; }, ZodTypeAny, "passthrough">, objectInputType<{ id: ZodString; display_name: ZodString; description: ZodString; preselect: ZodOptional<ZodBoolean>; sub_categories: ZodArray<ZodObject<{ id: ...; display_name: ...; description: ...; preselect: ...; prerequisites: ...; active: ...; successful: ...; failed: ...; total: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">; asr: ZodNumber; total_prompts: ZodNumber; total_attacks: ZodNumber; successful: ZodNumber; failed: ZodNumber; }, ZodTypeAny, "passthrough">>>>; safety_report: ZodOptional<ZodNullable<ZodObject<{ id: ZodString; display_name: ZodString; description: ZodString; preselect: ZodOptional<ZodBoolean>; sub_categories: ZodArray<ZodObject<{ id: ZodString; display_name: ZodString; description: ZodString; preselect: ZodOptional<...>; prerequisites: ZodOptional<...>; active: ZodOptional<...>; successful: ZodNumber; failed: ZodNumber; total: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ id: ...; display_name: ...; description: ...; preselect: ...; prerequisites: ...; active: ...; successful: ...; failed: ...; total: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ id: ...; display_name: ...; description: ...; preselect: ...; prerequisites: ...; active: ...; successful: ...; failed: ...; total: ...; }, ZodTypeAny, "passthrough">>, "many">; asr: ZodNumber; total_prompts: ZodNumber; total_attacks: ZodNumber; successful: ZodNumber; failed: ZodNumber; }, "passthrough", ZodTypeAny, objectOutputType<{ id: ZodString; display_name: ZodString; description: ZodString; preselect: ZodOptional<ZodBoolean>; sub_categories: ZodArray<ZodObject<{ id: ...; display_name: ...; description: ...; preselect: ...; prerequisites: ...; active: ...; successful: ...; failed: ...; total: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">; asr: ZodNumber; total_prompts: ZodNumber; total_attacks: ZodNumber; successful: ZodNumber; failed: ZodNumber; }, ZodTypeAny, "passthrough">, objectInputType<{ id: ZodString; display_name: ZodString; description: ZodString; preselect: ZodOptional<ZodBoolean>; sub_categories: ZodArray<ZodObject<{ id: ...; display_name: ...; description: ...; preselect: ...; prerequisites: ...; active: ...; successful: ...; failed: ...; total: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">; asr: ZodNumber; total_prompts: ZodNumber; total_attacks: ZodNumber; successful: ZodNumber; failed: ZodNumber; }, ZodTypeAny, "passthrough">>>>; brand_report: ZodOptional<ZodNullable<ZodObject<{ id: ZodString; display_name: ZodString; description: ZodString; preselect: ZodOptional<ZodBoolean>; sub_categories: ZodArray<ZodObject<{ id: ZodString; display_name: ZodString; description: ZodString; preselect: ZodOptional<...>; prerequisites: ZodOptional<...>; active: ZodOptional<...>; successful: ZodNumber; failed: ZodNumber; total: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ id: ...; display_name: ...; description: ...; preselect: ...; prerequisites: ...; active: ...; successful: ...; failed: ...; total: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ id: ...; display_name: ...; description: ...; preselect: ...; prerequisites: ...; active: ...; successful: ...; failed: ...; total: ...; }, ZodTypeAny, "passthrough">>, "many">; asr: ZodNumber; total_prompts: ZodNumber; total_attacks: ZodNumber; successful: ZodNumber; failed: ZodNumber; }, "passthrough", ZodTypeAny, objectOutputType<{ id: ZodString; display_name: ZodString; description: ZodString; preselect: ZodOptional<ZodBoolean>; sub_categories: ZodArray<ZodObject<{ id: ...; display_name: ...; description: ...; preselect: ...; prerequisites: ...; active: ...; successful: ...; failed: ...; total: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">; asr: ZodNumber; total_prompts: ZodNumber; total_attacks: ZodNumber; successful: ZodNumber; failed: ZodNumber; }, ZodTypeAny, "passthrough">, objectInputType<{ id: ZodString; display_name: ZodString; description: ZodString; preselect: ZodOptional<ZodBoolean>; sub_categories: ZodArray<ZodObject<{ id: ...; display_name: ...; description: ...; preselect: ...; prerequisites: ...; active: ...; successful: ...; failed: ...; total: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">; asr: ZodNumber; total_prompts: ZodNumber; total_attacks: ZodNumber; successful: ZodNumber; failed: ZodNumber; }, ZodTypeAny, "passthrough">>>>; compliance_report: ZodOptional<ZodNullable<ZodArray<ZodObject<{ id: ZodString; display_name: ZodString; description: ZodString; active: ZodBoolean; version: ZodString; link: ZodString; techniques: ZodArray<ZodObject<{ id: ...; display_name: ...; compliance_id: ...; description: ...; link: ...; version: ...; active: ...; successful: ...; failed: ...; total: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">; score: ZodOptional<ZodNumber>; }, "passthrough", ZodTypeAny, objectOutputType<{ id: ZodString; display_name: ZodString; description: ZodString; active: ZodBoolean; version: ZodString; link: ZodString; techniques: ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">; score: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">, objectInputType<{ id: ZodString; display_name: ZodString; description: ZodString; active: ZodBoolean; version: ZodString; link: ZodString; techniques: ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">; score: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">>, "many">>>; report_summary: ZodOptional<ZodNullable<ZodString>>; recommendations: ZodOptional<ZodNullable<ZodObject<{ runtime_security_policy_configuration: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>; other_measures: ZodOptional<ZodArray<ZodObject<{ remediation: ...; description: ...; mapping_remediation_id: ...; subcategories: ...; effectiveness: ...; ease_of_implementation: ...; priority: ...; resource_links: ...; categories: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">>; }, "passthrough", ZodTypeAny, objectOutputType<{ runtime_security_policy_configuration: ZodOptional<ZodNullable<ZodArray<..., ...>>>; other_measures: ZodOptional<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>; }, ZodTypeAny, "passthrough">, objectInputType<{ runtime_security_policy_configuration: ZodOptional<ZodNullable<ZodArray<..., ...>>>; other_measures: ZodOptional<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>; }, ZodTypeAny, "passthrough">>>>; }, ZodTypeAny, "passthrough">>

The static job report.

Example

import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();

const report = await rt.reports.getStaticReport('550e8400-e29b-41d4-a716-446655440000');
// report =>
// { severity_report: { stats: [{ severity: 'high', count: 3 }] } }

---

getStaticRemediation()

getStaticRemediation(jobId): Promise<objectOutputType<{
  remediations: ZodOptional<ZodArray<ZodObject<{
     remediation: ZodString;
     description: ZodString;
     resource_links: ZodOptional<ZodArray<ZodString, "many">>;
     priority_level: ZodOptional<ZodString>;
     ease_of_implementation_level: ZodOptional<ZodString>;
     effectiveness_level: ZodOptional<ZodString>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     remediation: ZodString;
     description: ZodString;
     resource_links: ZodOptional<ZodArray<ZodString, "many">>;
     priority_level: ZodOptional<ZodString>;
     ease_of_implementation_level: ZodOptional<ZodString>;
     effectiveness_level: ZodOptional<ZodString>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     remediation: ZodString;
     description: ZodString;
     resource_links: ZodOptional<ZodArray<ZodString, "many">>;
     priority_level: ZodOptional<ZodString>;
     ease_of_implementation_level: ZodOptional<ZodString>;
     effectiveness_level: ZodOptional<ZodString>;
  }, ZodTypeAny, "passthrough">>, "many">>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/reports-client.ts:219

Get remediation recommendations for a static scan.

Parameters

Parameter	Type	Description
jobId	string	The job UUID.

Returns

Promise<objectOutputType<{ remediations: ZodOptional<ZodArray<ZodObject<{ remediation: ZodString; description: ZodString; resource_links: ZodOptional<ZodArray<ZodString, "many">>; priority_level: ZodOptional<ZodString>; ease_of_implementation_level: ZodOptional<ZodString>; effectiveness_level: ZodOptional<ZodString>; }, "passthrough", ZodTypeAny, objectOutputType<{ remediation: ZodString; description: ZodString; resource_links: ZodOptional<ZodArray<ZodString, "many">>; priority_level: ZodOptional<ZodString>; ease_of_implementation_level: ZodOptional<ZodString>; effectiveness_level: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">, objectInputType<{ remediation: ZodString; description: ZodString; resource_links: ZodOptional<ZodArray<ZodString, "many">>; priority_level: ZodOptional<ZodString>; ease_of_implementation_level: ZodOptional<ZodString>; effectiveness_level: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">>, "many">>; }, ZodTypeAny, "passthrough">>

The remediation response.

Example

import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();

const remediation = await rt.reports.getStaticRemediation('550e8400-e29b-41d4-a716-446655440000');
// remediation =>
// { remediations: [{ remediation: 'Add input filtering', description: '...', priority_level: 'high' }] }

---

getStaticRuntimePolicy()

getStaticRuntimePolicy(jobId): Promise<objectOutputType<{
  runtime_security_profile: ZodOptional<ZodNullable<ZodArray<ZodObject<{
     policy_id: ZodString;
     display_name: ZodString;
     config: ZodRecord<ZodString, ZodUnknown>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     policy_id: ZodString;
     display_name: ZodString;
     config: ZodRecord<ZodString, ZodUnknown>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     policy_id: ZodString;
     display_name: ZodString;
     config: ZodRecord<ZodString, ZodUnknown>;
  }, ZodTypeAny, "passthrough">>, "many">>>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/reports-client.ts:245

Get runtime security profile config for a static scan.

Parameters

Parameter	Type	Description
jobId	string	The job UUID.

Returns

Promise<objectOutputType<{ runtime_security_profile: ZodOptional<ZodNullable<ZodArray<ZodObject<{ policy_id: ZodString; display_name: ZodString; config: ZodRecord<ZodString, ZodUnknown>; }, "passthrough", ZodTypeAny, objectOutputType<{ policy_id: ZodString; display_name: ZodString; config: ZodRecord<ZodString, ZodUnknown>; }, ZodTypeAny, "passthrough">, objectInputType<{ policy_id: ZodString; display_name: ZodString; config: ZodRecord<ZodString, ZodUnknown>; }, ZodTypeAny, "passthrough">>, "many">>>; }, ZodTypeAny, "passthrough">>

The runtime security profile response.

Example

import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();

const policy = await rt.reports.getStaticRuntimePolicy('550e8400-e29b-41d4-a716-446655440000');
// policy =>
// { runtime_security_profile: null }

---

getDynamicReport()

getDynamicReport(jobId): Promise<objectOutputType<{
  total_goals: ZodOptional<ZodNumber>;
  total_streams: ZodOptional<ZodNumber>;
  total_threats: ZodOptional<ZodNumber>;
  goals_achieved: ZodOptional<ZodNumber>;
  report_summary: ZodOptional<ZodNullable<ZodString>>;
  score: ZodOptional<ZodNumber>;
  asr: ZodOptional<ZodNumber>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/reports-client.ts:275

Get the agent scan report for a dynamic scan.

Parameters

Parameter	Type	Description
jobId	string	The job UUID.

Returns

Promise<objectOutputType<{ total_goals: ZodOptional<ZodNumber>; total_streams: ZodOptional<ZodNumber>; total_threats: ZodOptional<ZodNumber>; goals_achieved: ZodOptional<ZodNumber>; report_summary: ZodOptional<ZodNullable<ZodString>>; score: ZodOptional<ZodNumber>; asr: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">>

The dynamic job report.

Example

import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();

const report = await rt.reports.getDynamicReport('550e8400-e29b-41d4-a716-446655440000');
// report =>
// { total_goals: 12, goals_achieved: 3, total_threats: 5, score: 75, asr: 0.25 }

---

getDynamicRemediation()

getDynamicRemediation(jobId): Promise<objectOutputType<{
  remediations: ZodOptional<ZodArray<ZodObject<{
     remediation: ZodString;
     description: ZodString;
     resource_links: ZodOptional<ZodArray<ZodString, "many">>;
     priority_level: ZodOptional<ZodString>;
     ease_of_implementation_level: ZodOptional<ZodString>;
     effectiveness_level: ZodOptional<ZodString>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     remediation: ZodString;
     description: ZodString;
     resource_links: ZodOptional<ZodArray<ZodString, "many">>;
     priority_level: ZodOptional<ZodString>;
     ease_of_implementation_level: ZodOptional<ZodString>;
     effectiveness_level: ZodOptional<ZodString>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     remediation: ZodString;
     description: ZodString;
     resource_links: ZodOptional<ZodArray<ZodString, "many">>;
     priority_level: ZodOptional<ZodString>;
     ease_of_implementation_level: ZodOptional<ZodString>;
     effectiveness_level: ZodOptional<ZodString>;
  }, ZodTypeAny, "passthrough">>, "many">>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/reports-client.ts:301

Get remediation recommendations for a dynamic scan.

Parameters

Parameter	Type	Description
jobId	string	The job UUID.

Returns

Promise<objectOutputType<{ remediations: ZodOptional<ZodArray<ZodObject<{ remediation: ZodString; description: ZodString; resource_links: ZodOptional<ZodArray<ZodString, "many">>; priority_level: ZodOptional<ZodString>; ease_of_implementation_level: ZodOptional<ZodString>; effectiveness_level: ZodOptional<ZodString>; }, "passthrough", ZodTypeAny, objectOutputType<{ remediation: ZodString; description: ZodString; resource_links: ZodOptional<ZodArray<ZodString, "many">>; priority_level: ZodOptional<ZodString>; ease_of_implementation_level: ZodOptional<ZodString>; effectiveness_level: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">, objectInputType<{ remediation: ZodString; description: ZodString; resource_links: ZodOptional<ZodArray<ZodString, "many">>; priority_level: ZodOptional<ZodString>; ease_of_implementation_level: ZodOptional<ZodString>; effectiveness_level: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">>, "many">>; }, ZodTypeAny, "passthrough">>

The remediation response.

Example

import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();

const remediation = await rt.reports.getDynamicRemediation('550e8400-e29b-41d4-a716-446655440000');
// remediation =>
// { remediations: [{ remediation: 'Add input filtering', description: '...', priority_level: 'high' }] }

---

getDynamicRuntimePolicy()

getDynamicRuntimePolicy(jobId): Promise<objectOutputType<{
  runtime_security_profile: ZodOptional<ZodNullable<ZodArray<ZodObject<{
     policy_id: ZodString;
     display_name: ZodString;
     config: ZodRecord<ZodString, ZodUnknown>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     policy_id: ZodString;
     display_name: ZodString;
     config: ZodRecord<ZodString, ZodUnknown>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     policy_id: ZodString;
     display_name: ZodString;
     config: ZodRecord<ZodString, ZodUnknown>;
  }, ZodTypeAny, "passthrough">>, "many">>>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/reports-client.ts:327

Get runtime security profile config for a dynamic scan.

Parameters

Parameter	Type	Description
jobId	string	The job UUID.

Returns

Promise<objectOutputType<{ runtime_security_profile: ZodOptional<ZodNullable<ZodArray<ZodObject<{ policy_id: ZodString; display_name: ZodString; config: ZodRecord<ZodString, ZodUnknown>; }, "passthrough", ZodTypeAny, objectOutputType<{ policy_id: ZodString; display_name: ZodString; config: ZodRecord<ZodString, ZodUnknown>; }, ZodTypeAny, "passthrough">, objectInputType<{ policy_id: ZodString; display_name: ZodString; config: ZodRecord<ZodString, ZodUnknown>; }, ZodTypeAny, "passthrough">>, "many">>>; }, ZodTypeAny, "passthrough">>

The runtime security profile response.

Example

import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();

const policy = await rt.reports.getDynamicRuntimePolicy('550e8400-e29b-41d4-a716-446655440000');
// policy =>
// { runtime_security_profile: null }

---

listGoals()

listGoals(jobId, opts?): Promise<objectOutputType<{
  pagination: ZodObject<{
     total_items: ZodOptional<ZodNullable<ZodNumber>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     total_items: ZodOptional<ZodNullable<ZodNumber>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     total_items: ZodOptional<ZodNullable<ZodNumber>>;
  }, ZodTypeAny, "passthrough">>;
  data: ZodArray<ZodObject<{
     goal: ZodString;
     safe_response: ZodString;
     jailbroken_response: ZodString;
     goal_metadata: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
     custom_goal: ZodOptional<ZodBoolean>;
     goal_type: ZodOptional<ZodString>;
     uuid: ZodString;
     tsg_id: ZodString;
     job_id: ZodString;
     goal_to_show: ZodOptional<ZodNullable<ZodString>>;
     threat: ZodOptional<ZodBoolean>;
     version: ZodOptional<ZodNullable<ZodNumber>>;
     extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     goal: ZodString;
     safe_response: ZodString;
     jailbroken_response: ZodString;
     goal_metadata: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
     custom_goal: ZodOptional<ZodBoolean>;
     goal_type: ZodOptional<ZodString>;
     uuid: ZodString;
     tsg_id: ZodString;
     job_id: ZodString;
     goal_to_show: ZodOptional<ZodNullable<ZodString>>;
     threat: ZodOptional<ZodBoolean>;
     version: ZodOptional<ZodNullable<ZodNumber>>;
     extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     goal: ZodString;
     safe_response: ZodString;
     jailbroken_response: ZodString;
     goal_metadata: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
     custom_goal: ZodOptional<ZodBoolean>;
     goal_type: ZodOptional<ZodString>;
     uuid: ZodString;
     tsg_id: ZodString;
     job_id: ZodString;
     goal_to_show: ZodOptional<ZodNullable<ZodString>>;
     threat: ZodOptional<ZodBoolean>;
     version: ZodOptional<ZodNullable<ZodNumber>>;
     extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
  }, ZodTypeAny, "passthrough">>, "many">;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/reports-client.ts:354

List goals for a dynamic scan.

Parameters

Parameter	Type	Description
jobId	string	The job UUID.
opts?	GoalListOptions	Optional pagination, search, and filter options.

Returns

Promise<objectOutputType<{ pagination: ZodObject<{ total_items: ZodOptional<ZodNullable<ZodNumber>>; }, "passthrough", ZodTypeAny, objectOutputType<{ total_items: ZodOptional<ZodNullable<ZodNumber>>; }, ZodTypeAny, "passthrough">, objectInputType<{ total_items: ZodOptional<ZodNullable<ZodNumber>>; }, ZodTypeAny, "passthrough">>; data: ZodArray<ZodObject<{ goal: ZodString; safe_response: ZodString; jailbroken_response: ZodString; goal_metadata: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; custom_goal: ZodOptional<ZodBoolean>; goal_type: ZodOptional<ZodString>; uuid: ZodString; tsg_id: ZodString; job_id: ZodString; goal_to_show: ZodOptional<ZodNullable<ZodString>>; threat: ZodOptional<ZodBoolean>; version: ZodOptional<ZodNullable<ZodNumber>>; extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; }, "passthrough", ZodTypeAny, objectOutputType<{ goal: ZodString; safe_response: ZodString; jailbroken_response: ZodString; goal_metadata: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; custom_goal: ZodOptional<ZodBoolean>; goal_type: ZodOptional<ZodString>; uuid: ZodString; tsg_id: ZodString; job_id: ZodString; goal_to_show: ZodOptional<ZodNullable<ZodString>>; threat: ZodOptional<ZodBoolean>; version: ZodOptional<ZodNullable<ZodNumber>>; extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; }, ZodTypeAny, "passthrough">, objectInputType<{ goal: ZodString; safe_response: ZodString; jailbroken_response: ZodString; goal_metadata: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; custom_goal: ZodOptional<ZodBoolean>; goal_type: ZodOptional<ZodString>; uuid: ZodString; tsg_id: ZodString; job_id: ZodString; goal_to_show: ZodOptional<ZodNullable<ZodString>>; threat: ZodOptional<ZodBoolean>; version: ZodOptional<ZodNullable<ZodNumber>>; extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; }, ZodTypeAny, "passthrough">>, "many">; }, ZodTypeAny, "passthrough">>

The paginated list of goals.

Example

import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();

const goals = await rt.reports.listGoals('550e8400-e29b-41d4-a716-446655440000', { limit: 10 });
// goals =>
// { pagination: { total_items: 4 }, data: [{ uuid: '550e8400-...', goal: 'Extract secrets', status: 'ACHIEVED' }] }

---

listGoalStreams()

listGoalStreams(
   jobId, 
   goalId, 
   opts?): Promise<objectOutputType<{
  pagination: ZodObject<{
     total_items: ZodOptional<ZodNullable<ZodNumber>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     total_items: ZodOptional<ZodNullable<ZodNumber>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     total_items: ZodOptional<ZodNullable<ZodNumber>>;
  }, ZodTypeAny, "passthrough">>;
  data: ZodArray<ZodObject<{
     uuid: ZodString;
     tsg_id: ZodString;
     job_id: ZodString;
     target_id: ZodString;
     goal_id: ZodString;
     stream_idx: ZodOptional<ZodNumber>;
     iteration: ZodOptional<ZodNumber>;
     goal: ZodOptional<ZodUnknown>;
     marked_safe: ZodOptional<ZodBoolean>;
     stream_type: ZodOptional<ZodNullable<ZodString>>;
     threat: ZodOptional<ZodBoolean>;
     first_threat_iteration: ZodOptional<ZodNullable<ZodObject<{
        uuid: ZodString;
        tsg_id: ZodString;
        job_id: ZodString;
        stream_id: ZodString;
        goal_id: ZodString;
        iteration: ZodNumber;
        prompt: ZodString;
        techniques: ZodString;
        improvement: ZodString;
        prompts_objective: ZodString;
        summary: ZodString;
        output: ZodOptional<...>;
        score: ZodOptional<...>;
        judge_reasoning: ZodOptional<...>;
        threat: ZodOptional<...>;
        created_at: ZodOptional<...>;
        updated_at: ZodOptional<...>;
        extra_info: ZodOptional<...>;
        version: ZodOptional<...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        uuid: ...;
        tsg_id: ...;
        job_id: ...;
        stream_id: ...;
        goal_id: ...;
        iteration: ...;
        prompt: ...;
        techniques: ...;
        improvement: ...;
        prompts_objective: ...;
        summary: ...;
        output: ...;
        score: ...;
        judge_reasoning: ...;
        threat: ...;
        created_at: ...;
        updated_at: ...;
        extra_info: ...;
        version: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        uuid: ...;
        tsg_id: ...;
        job_id: ...;
        stream_id: ...;
        goal_id: ...;
        iteration: ...;
        prompt: ...;
        techniques: ...;
        improvement: ...;
        prompts_objective: ...;
        summary: ...;
        output: ...;
        score: ...;
        judge_reasoning: ...;
        threat: ...;
        created_at: ...;
        updated_at: ...;
        extra_info: ...;
        version: ...;
     }, ZodTypeAny, "passthrough">>>>;
     created_at: ZodOptional<ZodNullable<ZodString>>;
     updated_at: ZodOptional<ZodNullable<ZodString>>;
     extra_info: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
     version: ZodOptional<ZodNullable<ZodNumber>>;
     iterations: ZodOptional<ZodArray<ZodObject<{
        uuid: ZodString;
        tsg_id: ZodString;
        job_id: ZodString;
        stream_id: ZodString;
        goal_id: ZodString;
        iteration: ZodNumber;
        prompt: ZodString;
        techniques: ZodString;
        improvement: ZodString;
        prompts_objective: ZodString;
        summary: ZodString;
        output: ZodOptional<...>;
        score: ZodOptional<...>;
        judge_reasoning: ZodOptional<...>;
        threat: ZodOptional<...>;
        created_at: ZodOptional<...>;
        updated_at: ZodOptional<...>;
        extra_info: ZodOptional<...>;
        version: ZodOptional<...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        uuid: ...;
        tsg_id: ...;
        job_id: ...;
        stream_id: ...;
        goal_id: ...;
        iteration: ...;
        prompt: ...;
        techniques: ...;
        improvement: ...;
        prompts_objective: ...;
        summary: ...;
        output: ...;
        score: ...;
        judge_reasoning: ...;
        threat: ...;
        created_at: ...;
        updated_at: ...;
        extra_info: ...;
        version: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        uuid: ...;
        tsg_id: ...;
        job_id: ...;
        stream_id: ...;
        goal_id: ...;
        iteration: ...;
        prompt: ...;
        techniques: ...;
        improvement: ...;
        prompts_objective: ...;
        summary: ...;
        output: ...;
        score: ...;
        judge_reasoning: ...;
        threat: ...;
        created_at: ...;
        updated_at: ...;
        extra_info: ...;
        version: ...;
     }, ZodTypeAny, "passthrough">>, "many">>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     uuid: ZodString;
     tsg_id: ZodString;
     job_id: ZodString;
     target_id: ZodString;
     goal_id: ZodString;
     stream_idx: ZodOptional<ZodNumber>;
     iteration: ZodOptional<ZodNumber>;
     goal: ZodOptional<ZodUnknown>;
     marked_safe: ZodOptional<ZodBoolean>;
     stream_type: ZodOptional<ZodNullable<ZodString>>;
     threat: ZodOptional<ZodBoolean>;
     first_threat_iteration: ZodOptional<ZodNullable<ZodObject<{
        uuid: ...;
        tsg_id: ...;
        job_id: ...;
        stream_id: ...;
        goal_id: ...;
        iteration: ...;
        prompt: ...;
        techniques: ...;
        improvement: ...;
        prompts_objective: ...;
        summary: ...;
        output: ...;
        score: ...;
        judge_reasoning: ...;
        threat: ...;
        created_at: ...;
        updated_at: ...;
        extra_info: ...;
        version: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
     created_at: ZodOptional<ZodNullable<ZodString>>;
     updated_at: ZodOptional<ZodNullable<ZodString>>;
     extra_info: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
     version: ZodOptional<ZodNullable<ZodNumber>>;
     iterations: ZodOptional<ZodArray<ZodObject<{
        uuid: ...;
        tsg_id: ...;
        job_id: ...;
        stream_id: ...;
        goal_id: ...;
        iteration: ...;
        prompt: ...;
        techniques: ...;
        improvement: ...;
        prompts_objective: ...;
        summary: ...;
        output: ...;
        score: ...;
        judge_reasoning: ...;
        threat: ...;
        created_at: ...;
        updated_at: ...;
        extra_info: ...;
        version: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     uuid: ZodString;
     tsg_id: ZodString;
     job_id: ZodString;
     target_id: ZodString;
     goal_id: ZodString;
     stream_idx: ZodOptional<ZodNumber>;
     iteration: ZodOptional<ZodNumber>;
     goal: ZodOptional<ZodUnknown>;
     marked_safe: ZodOptional<ZodBoolean>;
     stream_type: ZodOptional<ZodNullable<ZodString>>;
     threat: ZodOptional<ZodBoolean>;
     first_threat_iteration: ZodOptional<ZodNullable<ZodObject<{
        uuid: ...;
        tsg_id: ...;
        job_id: ...;
        stream_id: ...;
        goal_id: ...;
        iteration: ...;
        prompt: ...;
        techniques: ...;
        improvement: ...;
        prompts_objective: ...;
        summary: ...;
        output: ...;
        score: ...;
        judge_reasoning: ...;
        threat: ...;
        created_at: ...;
        updated_at: ...;
        extra_info: ...;
        version: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
     created_at: ZodOptional<ZodNullable<ZodString>>;
     updated_at: ZodOptional<ZodNullable<ZodString>>;
     extra_info: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
     version: ZodOptional<ZodNullable<ZodNumber>>;
     iterations: ZodOptional<ZodArray<ZodObject<{
        uuid: ...;
        tsg_id: ...;
        job_id: ...;
        stream_id: ...;
        goal_id: ...;
        iteration: ...;
        prompt: ...;
        techniques: ...;
        improvement: ...;
        prompts_objective: ...;
        summary: ...;
        output: ...;
        score: ...;
        judge_reasoning: ...;
        threat: ...;
        created_at: ...;
        updated_at: ...;
        extra_info: ...;
        version: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">>;
  }, ZodTypeAny, "passthrough">>, "many">;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/reports-client.ts:391

List streams for a goal in a dynamic scan.

Parameters

Parameter	Type	Description
jobId	string	The job UUID.
goalId	string	The goal UUID.
opts?	ListingOptions	Optional pagination and search options.

Returns

Promise<objectOutputType<{ pagination: ZodObject<{ total_items: ZodOptional<ZodNullable<ZodNumber>>; }, "passthrough", ZodTypeAny, objectOutputType<{ total_items: ZodOptional<ZodNullable<ZodNumber>>; }, ZodTypeAny, "passthrough">, objectInputType<{ total_items: ZodOptional<ZodNullable<ZodNumber>>; }, ZodTypeAny, "passthrough">>; data: ZodArray<ZodObject<{ uuid: ZodString; tsg_id: ZodString; job_id: ZodString; target_id: ZodString; goal_id: ZodString; stream_idx: ZodOptional<ZodNumber>; iteration: ZodOptional<ZodNumber>; goal: ZodOptional<ZodUnknown>; marked_safe: ZodOptional<ZodBoolean>; stream_type: ZodOptional<ZodNullable<ZodString>>; threat: ZodOptional<ZodBoolean>; first_threat_iteration: ZodOptional<ZodNullable<ZodObject<{ uuid: ZodString; tsg_id: ZodString; job_id: ZodString; stream_id: ZodString; goal_id: ZodString; iteration: ZodNumber; prompt: ZodString; techniques: ZodString; improvement: ZodString; prompts_objective: ZodString; summary: ZodString; output: ZodOptional<...>; score: ZodOptional<...>; judge_reasoning: ZodOptional<...>; threat: ZodOptional<...>; created_at: ZodOptional<...>; updated_at: ZodOptional<...>; extra_info: ZodOptional<...>; version: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ uuid: ...; tsg_id: ...; job_id: ...; stream_id: ...; goal_id: ...; iteration: ...; prompt: ...; techniques: ...; improvement: ...; prompts_objective: ...; summary: ...; output: ...; score: ...; judge_reasoning: ...; threat: ...; created_at: ...; updated_at: ...; extra_info: ...; version: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ uuid: ...; tsg_id: ...; job_id: ...; stream_id: ...; goal_id: ...; iteration: ...; prompt: ...; techniques: ...; improvement: ...; prompts_objective: ...; summary: ...; output: ...; score: ...; judge_reasoning: ...; threat: ...; created_at: ...; updated_at: ...; extra_info: ...; version: ...; }, ZodTypeAny, "passthrough">>>>; created_at: ZodOptional<ZodNullable<ZodString>>; updated_at: ZodOptional<ZodNullable<ZodString>>; extra_info: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; version: ZodOptional<ZodNullable<ZodNumber>>; iterations: ZodOptional<ZodArray<ZodObject<{ uuid: ZodString; tsg_id: ZodString; job_id: ZodString; stream_id: ZodString; goal_id: ZodString; iteration: ZodNumber; prompt: ZodString; techniques: ZodString; improvement: ZodString; prompts_objective: ZodString; summary: ZodString; output: ZodOptional<...>; score: ZodOptional<...>; judge_reasoning: ZodOptional<...>; threat: ZodOptional<...>; created_at: ZodOptional<...>; updated_at: ZodOptional<...>; extra_info: ZodOptional<...>; version: ZodOptional<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ uuid: ...; tsg_id: ...; job_id: ...; stream_id: ...; goal_id: ...; iteration: ...; prompt: ...; techniques: ...; improvement: ...; prompts_objective: ...; summary: ...; output: ...; score: ...; judge_reasoning: ...; threat: ...; created_at: ...; updated_at: ...; extra_info: ...; version: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ uuid: ...; tsg_id: ...; job_id: ...; stream_id: ...; goal_id: ...; iteration: ...; prompt: ...; techniques: ...; improvement: ...; prompts_objective: ...; summary: ...; output: ...; score: ...; judge_reasoning: ...; threat: ...; created_at: ...; updated_at: ...; extra_info: ...; version: ...; }, ZodTypeAny, "passthrough">>, "many">>; }, "passthrough", ZodTypeAny, objectOutputType<{ uuid: ZodString; tsg_id: ZodString; job_id: ZodString; target_id: ZodString; goal_id: ZodString; stream_idx: ZodOptional<ZodNumber>; iteration: ZodOptional<ZodNumber>; goal: ZodOptional<ZodUnknown>; marked_safe: ZodOptional<ZodBoolean>; stream_type: ZodOptional<ZodNullable<ZodString>>; threat: ZodOptional<ZodBoolean>; first_threat_iteration: ZodOptional<ZodNullable<ZodObject<{ uuid: ...; tsg_id: ...; job_id: ...; stream_id: ...; goal_id: ...; iteration: ...; prompt: ...; techniques: ...; improvement: ...; prompts_objective: ...; summary: ...; output: ...; score: ...; judge_reasoning: ...; threat: ...; created_at: ...; updated_at: ...; extra_info: ...; version: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>; created_at: ZodOptional<ZodNullable<ZodString>>; updated_at: ZodOptional<ZodNullable<ZodString>>; extra_info: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; version: ZodOptional<ZodNullable<ZodNumber>>; iterations: ZodOptional<ZodArray<ZodObject<{ uuid: ...; tsg_id: ...; job_id: ...; stream_id: ...; goal_id: ...; iteration: ...; prompt: ...; techniques: ...; improvement: ...; prompts_objective: ...; summary: ...; output: ...; score: ...; judge_reasoning: ...; threat: ...; created_at: ...; updated_at: ...; extra_info: ...; version: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">>; }, ZodTypeAny, "passthrough">, objectInputType<{ uuid: ZodString; tsg_id: ZodString; job_id: ZodString; target_id: ZodString; goal_id: ZodString; stream_idx: ZodOptional<ZodNumber>; iteration: ZodOptional<ZodNumber>; goal: ZodOptional<ZodUnknown>; marked_safe: ZodOptional<ZodBoolean>; stream_type: ZodOptional<ZodNullable<ZodString>>; threat: ZodOptional<ZodBoolean>; first_threat_iteration: ZodOptional<ZodNullable<ZodObject<{ uuid: ...; tsg_id: ...; job_id: ...; stream_id: ...; goal_id: ...; iteration: ...; prompt: ...; techniques: ...; improvement: ...; prompts_objective: ...; summary: ...; output: ...; score: ...; judge_reasoning: ...; threat: ...; created_at: ...; updated_at: ...; extra_info: ...; version: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>; created_at: ZodOptional<ZodNullable<ZodString>>; updated_at: ZodOptional<ZodNullable<ZodString>>; extra_info: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; version: ZodOptional<ZodNullable<ZodNumber>>; iterations: ZodOptional<ZodArray<ZodObject<{ uuid: ...; tsg_id: ...; job_id: ...; stream_id: ...; goal_id: ...; iteration: ...; prompt: ...; techniques: ...; improvement: ...; prompts_objective: ...; summary: ...; output: ...; score: ...; judge_reasoning: ...; threat: ...; created_at: ...; updated_at: ...; extra_info: ...; version: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">>; }, ZodTypeAny, "passthrough">>, "many">; }, ZodTypeAny, "passthrough">>

The paginated list of streams.

Example

import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();

const streams = await rt.reports.listGoalStreams(
  '550e8400-e29b-41d4-a716-446655440000',
  '550e8400-e29b-41d4-a716-446655440000',
);
// streams =>
// { pagination: { total_items: 2 }, data: [{ uuid: '550e8400-...', goal_id: '550e8400-...' }] }

---

getStreamDetail()

getStreamDetail(streamId): Promise<objectOutputType<{
  uuid: ZodString;
  tsg_id: ZodString;
  job_id: ZodString;
  target_id: ZodString;
  goal_id: ZodString;
  stream_idx: ZodOptional<ZodNumber>;
  iteration: ZodOptional<ZodNumber>;
  goal: ZodOptional<ZodUnknown>;
  marked_safe: ZodOptional<ZodBoolean>;
  stream_type: ZodOptional<ZodNullable<ZodString>>;
  threat: ZodOptional<ZodBoolean>;
  first_threat_iteration: ZodOptional<ZodNullable<ZodObject<{
     uuid: ZodString;
     tsg_id: ZodString;
     job_id: ZodString;
     stream_id: ZodString;
     goal_id: ZodString;
     iteration: ZodNumber;
     prompt: ZodString;
     techniques: ZodString;
     improvement: ZodString;
     prompts_objective: ZodString;
     summary: ZodString;
     output: ZodOptional<ZodNullable<ZodString>>;
     score: ZodOptional<ZodNullable<ZodNumber>>;
     judge_reasoning: ZodOptional<ZodNullable<ZodString>>;
     threat: ZodOptional<ZodBoolean>;
     created_at: ZodOptional<ZodNullable<ZodString>>;
     updated_at: ZodOptional<ZodNullable<ZodString>>;
     extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     version: ZodOptional<ZodNullable<ZodNumber>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     uuid: ZodString;
     tsg_id: ZodString;
     job_id: ZodString;
     stream_id: ZodString;
     goal_id: ZodString;
     iteration: ZodNumber;
     prompt: ZodString;
     techniques: ZodString;
     improvement: ZodString;
     prompts_objective: ZodString;
     summary: ZodString;
     output: ZodOptional<ZodNullable<ZodString>>;
     score: ZodOptional<ZodNullable<ZodNumber>>;
     judge_reasoning: ZodOptional<ZodNullable<ZodString>>;
     threat: ZodOptional<ZodBoolean>;
     created_at: ZodOptional<ZodNullable<ZodString>>;
     updated_at: ZodOptional<ZodNullable<ZodString>>;
     extra_info: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
     version: ZodOptional<ZodNullable<ZodNumber>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     uuid: ZodString;
     tsg_id: ZodString;
     job_id: ZodString;
     stream_id: ZodString;
     goal_id: ZodString;
     iteration: ZodNumber;
     prompt: ZodString;
     techniques: ZodString;
     improvement: ZodString;
     prompts_objective: ZodString;
     summary: ZodString;
     output: ZodOptional<ZodNullable<ZodString>>;
     score: ZodOptional<ZodNullable<ZodNumber>>;
     judge_reasoning: ZodOptional<ZodNullable<ZodString>>;
     threat: ZodOptional<ZodBoolean>;
     created_at: ZodOptional<ZodNullable<ZodString>>;
     updated_at: ZodOptional<ZodNullable<ZodString>>;
     extra_info: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
     version: ZodOptional<ZodNullable<ZodNumber>>;
  }, ZodTypeAny, "passthrough">>>>;
  created_at: ZodOptional<ZodNullable<ZodString>>;
  updated_at: ZodOptional<ZodNullable<ZodString>>;
  extra_info: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
  version: ZodOptional<ZodNullable<ZodNumber>>;
  iterations: ZodOptional<ZodArray<ZodObject<{
     uuid: ZodString;
     tsg_id: ZodString;
     job_id: ZodString;
     stream_id: ZodString;
     goal_id: ZodString;
     iteration: ZodNumber;
     prompt: ZodString;
     techniques: ZodString;
     improvement: ZodString;
     prompts_objective: ZodString;
     summary: ZodString;
     output: ZodOptional<ZodNullable<ZodString>>;
     score: ZodOptional<ZodNullable<ZodNumber>>;
     judge_reasoning: ZodOptional<ZodNullable<ZodString>>;
     threat: ZodOptional<ZodBoolean>;
     created_at: ZodOptional<ZodNullable<ZodString>>;
     updated_at: ZodOptional<ZodNullable<ZodString>>;
     extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     version: ZodOptional<ZodNullable<ZodNumber>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     uuid: ZodString;
     tsg_id: ZodString;
     job_id: ZodString;
     stream_id: ZodString;
     goal_id: ZodString;
     iteration: ZodNumber;
     prompt: ZodString;
     techniques: ZodString;
     improvement: ZodString;
     prompts_objective: ZodString;
     summary: ZodString;
     output: ZodOptional<ZodNullable<ZodString>>;
     score: ZodOptional<ZodNullable<ZodNumber>>;
     judge_reasoning: ZodOptional<ZodNullable<ZodString>>;
     threat: ZodOptional<ZodBoolean>;
     created_at: ZodOptional<ZodNullable<ZodString>>;
     updated_at: ZodOptional<ZodNullable<ZodString>>;
     extra_info: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
     version: ZodOptional<ZodNullable<ZodNumber>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     uuid: ZodString;
     tsg_id: ZodString;
     job_id: ZodString;
     stream_id: ZodString;
     goal_id: ZodString;
     iteration: ZodNumber;
     prompt: ZodString;
     techniques: ZodString;
     improvement: ZodString;
     prompts_objective: ZodString;
     summary: ZodString;
     output: ZodOptional<ZodNullable<ZodString>>;
     score: ZodOptional<ZodNullable<ZodNumber>>;
     judge_reasoning: ZodOptional<ZodNullable<ZodString>>;
     threat: ZodOptional<ZodBoolean>;
     created_at: ZodOptional<ZodNullable<ZodString>>;
     updated_at: ZodOptional<ZodNullable<ZodString>>;
     extra_info: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
     version: ZodOptional<ZodNullable<ZodNumber>>;
  }, ZodTypeAny, "passthrough">>, "many">>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/reports-client.ts:427

Get stream details by stream ID.

Parameters

Parameter	Type	Description
streamId	string	The stream UUID.

Returns

Promise<objectOutputType<{ uuid: ZodString; tsg_id: ZodString; job_id: ZodString; target_id: ZodString; goal_id: ZodString; stream_idx: ZodOptional<ZodNumber>; iteration: ZodOptional<ZodNumber>; goal: ZodOptional<ZodUnknown>; marked_safe: ZodOptional<ZodBoolean>; stream_type: ZodOptional<ZodNullable<ZodString>>; threat: ZodOptional<ZodBoolean>; first_threat_iteration: ZodOptional<ZodNullable<ZodObject<{ uuid: ZodString; tsg_id: ZodString; job_id: ZodString; stream_id: ZodString; goal_id: ZodString; iteration: ZodNumber; prompt: ZodString; techniques: ZodString; improvement: ZodString; prompts_objective: ZodString; summary: ZodString; output: ZodOptional<ZodNullable<ZodString>>; score: ZodOptional<ZodNullable<ZodNumber>>; judge_reasoning: ZodOptional<ZodNullable<ZodString>>; threat: ZodOptional<ZodBoolean>; created_at: ZodOptional<ZodNullable<ZodString>>; updated_at: ZodOptional<ZodNullable<ZodString>>; extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; version: ZodOptional<ZodNullable<ZodNumber>>; }, "passthrough", ZodTypeAny, objectOutputType<{ uuid: ZodString; tsg_id: ZodString; job_id: ZodString; stream_id: ZodString; goal_id: ZodString; iteration: ZodNumber; prompt: ZodString; techniques: ZodString; improvement: ZodString; prompts_objective: ZodString; summary: ZodString; output: ZodOptional<ZodNullable<ZodString>>; score: ZodOptional<ZodNullable<ZodNumber>>; judge_reasoning: ZodOptional<ZodNullable<ZodString>>; threat: ZodOptional<ZodBoolean>; created_at: ZodOptional<ZodNullable<ZodString>>; updated_at: ZodOptional<ZodNullable<ZodString>>; extra_info: ZodOptional<ZodNullable<ZodRecord<..., ...>>>; version: ZodOptional<ZodNullable<ZodNumber>>; }, ZodTypeAny, "passthrough">, objectInputType<{ uuid: ZodString; tsg_id: ZodString; job_id: ZodString; stream_id: ZodString; goal_id: ZodString; iteration: ZodNumber; prompt: ZodString; techniques: ZodString; improvement: ZodString; prompts_objective: ZodString; summary: ZodString; output: ZodOptional<ZodNullable<ZodString>>; score: ZodOptional<ZodNullable<ZodNumber>>; judge_reasoning: ZodOptional<ZodNullable<ZodString>>; threat: ZodOptional<ZodBoolean>; created_at: ZodOptional<ZodNullable<ZodString>>; updated_at: ZodOptional<ZodNullable<ZodString>>; extra_info: ZodOptional<ZodNullable<ZodRecord<..., ...>>>; version: ZodOptional<ZodNullable<ZodNumber>>; }, ZodTypeAny, "passthrough">>>>; created_at: ZodOptional<ZodNullable<ZodString>>; updated_at: ZodOptional<ZodNullable<ZodString>>; extra_info: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; version: ZodOptional<ZodNullable<ZodNumber>>; iterations: ZodOptional<ZodArray<ZodObject<{ uuid: ZodString; tsg_id: ZodString; job_id: ZodString; stream_id: ZodString; goal_id: ZodString; iteration: ZodNumber; prompt: ZodString; techniques: ZodString; improvement: ZodString; prompts_objective: ZodString; summary: ZodString; output: ZodOptional<ZodNullable<ZodString>>; score: ZodOptional<ZodNullable<ZodNumber>>; judge_reasoning: ZodOptional<ZodNullable<ZodString>>; threat: ZodOptional<ZodBoolean>; created_at: ZodOptional<ZodNullable<ZodString>>; updated_at: ZodOptional<ZodNullable<ZodString>>; extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; version: ZodOptional<ZodNullable<ZodNumber>>; }, "passthrough", ZodTypeAny, objectOutputType<{ uuid: ZodString; tsg_id: ZodString; job_id: ZodString; stream_id: ZodString; goal_id: ZodString; iteration: ZodNumber; prompt: ZodString; techniques: ZodString; improvement: ZodString; prompts_objective: ZodString; summary: ZodString; output: ZodOptional<ZodNullable<ZodString>>; score: ZodOptional<ZodNullable<ZodNumber>>; judge_reasoning: ZodOptional<ZodNullable<ZodString>>; threat: ZodOptional<ZodBoolean>; created_at: ZodOptional<ZodNullable<ZodString>>; updated_at: ZodOptional<ZodNullable<ZodString>>; extra_info: ZodOptional<ZodNullable<ZodRecord<..., ...>>>; version: ZodOptional<ZodNullable<ZodNumber>>; }, ZodTypeAny, "passthrough">, objectInputType<{ uuid: ZodString; tsg_id: ZodString; job_id: ZodString; stream_id: ZodString; goal_id: ZodString; iteration: ZodNumber; prompt: ZodString; techniques: ZodString; improvement: ZodString; prompts_objective: ZodString; summary: ZodString; output: ZodOptional<ZodNullable<ZodString>>; score: ZodOptional<ZodNullable<ZodNumber>>; judge_reasoning: ZodOptional<ZodNullable<ZodString>>; threat: ZodOptional<ZodBoolean>; created_at: ZodOptional<ZodNullable<ZodString>>; updated_at: ZodOptional<ZodNullable<ZodString>>; extra_info: ZodOptional<ZodNullable<ZodRecord<..., ...>>>; version: ZodOptional<ZodNullable<ZodNumber>>; }, ZodTypeAny, "passthrough">>, "many">>; }, ZodTypeAny, "passthrough">>

The stream detail response.

Example

import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();

const stream = await rt.reports.getStreamDetail('550e8400-e29b-41d4-a716-446655440000');
// stream =>
// { uuid: '550e8400-...', job_id: '550e8400-...', target_id: '550e8400-...', goal_id: '550e8400-...' }

---

downloadReport()

downloadReport(jobId, format): Promise<unknown>;

Defined in: src/red-team/reports-client.ts:453

Download a report in the specified format.

Parameters

Parameter	Type	Description
jobId	string	The job UUID.
format	string	The file format (e.g. "pdf", "csv").

Returns

Promise<unknown>

The report data in the requested format (untyped — shape depends on format).

Example

import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();

const data = await rt.reports.downloadReport('550e8400-e29b-41d4-a716-446655440000', 'pdf');
// data => raw report payload (shape depends on the requested file_format)

---

generatePartialReport()

generatePartialReport(jobId): Promise<unknown>;

Defined in: src/red-team/reports-client.ts:479

Generate a partial report for a running scan.

Parameters

Parameter	Type	Description
jobId	string	The job UUID.

Returns

Promise<unknown>

The partial report payload (untyped — schema not yet defined by the API).

Example

import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();

const partial = await rt.reports.generatePartialReport('550e8400-e29b-41d4-a716-446655440000');
// partial => partial report payload (untyped; schema not yet defined by the API)