Class: RedTeamScansClient
Defined in: src/red-team/scans-client.ts:45
Client for Red Team data plane scan operations.
Constructors
Constructor
new RedTeamScansClient(opts): RedTeamScansClient;
Defined in: src/red-team/scans-client.ts:50
Parameters
| Parameter | Type |
|---|---|
opts | RedTeamScansClientOptions |
Returns
RedTeamScansClient
Methods
create()
create(body): Promise<objectOutputType<{
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
target: ZodObject<{
adapter_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
canonical_id: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
adapter_secret_version: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
profiling_progress: ZodOptional<ZodUnion<[ZodNumber, ZodNull]>>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<ZodNullable<ZodString>>;
target_type: ZodOptional<ZodNullable<ZodString>>;
connection_type: ZodOptional<ZodNullable<ZodString>>;
api_endpoint_type: ZodOptional<ZodNullable<ZodString>>;
response_mode: ZodOptional<ZodNullable<ZodString>>;
session_supported: ZodOptional<ZodBoolean>;
extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<ZodNullable<ZodNumber>>;
secret_version: ZodOptional<ZodNullable<ZodString>>;
created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
updated_by_user_id: ZodOptional<ZodNullable<ZodString>>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<ZodObject<{
supports_multimodal_files: ZodOptional<ZodBoolean>;
supports_multimodal_files_error_message: ZodOptional<ZodUnion<[..., ...]>>;
multi_turn: ZodOptional<ZodBoolean>;
multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
probe_message: ZodOptional<ZodString>;
request_timeout: ZodOptional<ZodNumber>;
}, "passthrough", ZodTypeAny, objectOutputType<{
supports_multimodal_files: ZodOptional<ZodBoolean>;
supports_multimodal_files_error_message: ZodOptional<ZodUnion<...>>;
multi_turn: ZodOptional<ZodBoolean>;
multi_turn_error_message: ZodOptional<ZodNullable<...>>;
rate_limit: ZodOptional<ZodNullable<...>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit_error_code: ZodOptional<ZodNullable<...>>;
rate_limit_error_json: ZodOptional<ZodNullable<...>>;
rate_limit_error_message: ZodOptional<ZodNullable<...>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<...>>;
content_filter_error_json: ZodOptional<ZodNullable<...>>;
content_filter_error_message: ZodOptional<ZodNullable<...>>;
probe_message: ZodOptional<ZodString>;
request_timeout: ZodOptional<ZodNumber>;
}, ZodTypeAny, "passthrough">, objectInputType<{
supports_multimodal_files: ZodOptional<ZodBoolean>;
supports_multimodal_files_error_message: ZodOptional<ZodUnion<...>>;
multi_turn: ZodOptional<ZodBoolean>;
multi_turn_error_message: ZodOptional<ZodNullable<...>>;
rate_limit: ZodOptional<ZodNullable<...>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit_error_code: ZodOptional<ZodNullable<...>>;
rate_limit_error_json: ZodOptional<ZodNullable<...>>;
rate_limit_error_message: ZodOptional<ZodNullable<...>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<...>>;
content_filter_error_json: ZodOptional<ZodNullable<...>>;
content_filter_error_message: ZodOptional<ZodNullable<...>>;
probe_message: ZodOptional<ZodString>;
request_timeout: ZodOptional<ZodNumber>;
}, ZodTypeAny, "passthrough">>>;
target_background: ZodOptional<ZodNullable<ZodObject<{
agentic_profiling_enabled: ZodOptional<ZodBoolean>;
industry: ZodOptional<ZodNullable<...>>;
use_case: ZodOptional<ZodNullable<...>>;
competitors: ZodOptional<ZodNullable<...>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
agentic_profiling_enabled: ZodOptional<...>;
industry: ZodOptional<...>;
use_case: ZodOptional<...>;
competitors: ZodOptional<...>;
}, ZodTypeAny, "passthrough">, objectInputType<{
agentic_profiling_enabled: ZodOptional<...>;
industry: ZodOptional<...>;
use_case: ZodOptional<...>;
competitors: ZodOptional<...>;
}, ZodTypeAny, "passthrough">>>>;
profiling_status: ZodOptional<ZodNullable<ZodString>>;
additional_context: ZodOptional<ZodNullable<ZodObject<{
base_model: ZodOptional<ZodNullable<...>>;
core_architecture: ZodOptional<ZodNullable<...>>;
system_prompt: ZodOptional<ZodNullable<...>>;
languages_supported: ZodOptional<ZodNullable<...>>;
banned_keywords: ZodOptional<ZodNullable<...>>;
tools_accessible: ZodOptional<ZodNullable<...>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
base_model: ZodOptional<...>;
core_architecture: ZodOptional<...>;
system_prompt: ZodOptional<...>;
languages_supported: ZodOptional<...>;
banned_keywords: ZodOptional<...>;
tools_accessible: ZodOptional<...>;
}, ZodTypeAny, "passthrough">, objectInputType<{
base_model: ZodOptional<...>;
core_architecture: ZodOptional<...>;
system_prompt: ZodOptional<...>;
languages_supported: ZodOptional<...>;
banned_keywords: ZodOptional<...>;
tools_accessible: ZodOptional<...>;
}, ZodTypeAny, "passthrough">>>>;
auth_type: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
adapter_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
canonical_id: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
adapter_secret_version: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
profiling_progress: ZodOptional<ZodUnion<[ZodNumber, ZodNull]>>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<ZodNullable<ZodString>>;
target_type: ZodOptional<ZodNullable<ZodString>>;
connection_type: ZodOptional<ZodNullable<ZodString>>;
api_endpoint_type: ZodOptional<ZodNullable<ZodString>>;
response_mode: ZodOptional<ZodNullable<ZodString>>;
session_supported: ZodOptional<ZodBoolean>;
extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<ZodNullable<ZodNumber>>;
secret_version: ZodOptional<ZodNullable<ZodString>>;
created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
updated_by_user_id: ZodOptional<ZodNullable<ZodString>>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<ZodObject<{
supports_multimodal_files: ZodOptional<ZodBoolean>;
supports_multimodal_files_error_message: ZodOptional<ZodUnion<...>>;
multi_turn: ZodOptional<ZodBoolean>;
multi_turn_error_message: ZodOptional<ZodNullable<...>>;
rate_limit: ZodOptional<ZodNullable<...>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit_error_code: ZodOptional<ZodNullable<...>>;
rate_limit_error_json: ZodOptional<ZodNullable<...>>;
rate_limit_error_message: ZodOptional<ZodNullable<...>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<...>>;
content_filter_error_json: ZodOptional<ZodNullable<...>>;
content_filter_error_message: ZodOptional<ZodNullable<...>>;
probe_message: ZodOptional<ZodString>;
request_timeout: ZodOptional<ZodNumber>;
}, "passthrough", ZodTypeAny, objectOutputType<{
supports_multimodal_files: ZodOptional<...>;
supports_multimodal_files_error_message: ZodOptional<...>;
multi_turn: ZodOptional<...>;
multi_turn_error_message: ZodOptional<...>;
rate_limit: ZodOptional<...>;
rate_limit_enabled: ZodOptional<...>;
rate_limit_error_code: ZodOptional<...>;
rate_limit_error_json: ZodOptional<...>;
rate_limit_error_message: ZodOptional<...>;
content_filter_enabled: ZodOptional<...>;
content_filter_error_code: ZodOptional<...>;
content_filter_error_json: ZodOptional<...>;
content_filter_error_message: ZodOptional<...>;
probe_message: ZodOptional<...>;
request_timeout: ZodOptional<...>;
}, ZodTypeAny, "passthrough">, objectInputType<{
supports_multimodal_files: ZodOptional<...>;
supports_multimodal_files_error_message: ZodOptional<...>;
multi_turn: ZodOptional<...>;
multi_turn_error_message: ZodOptional<...>;
rate_limit: ZodOptional<...>;
rate_limit_enabled: ZodOptional<...>;
rate_limit_error_code: ZodOptional<...>;
rate_limit_error_json: ZodOptional<...>;
rate_limit_error_message: ZodOptional<...>;
content_filter_enabled: ZodOptional<...>;
content_filter_error_code: ZodOptional<...>;
content_filter_error_json: ZodOptional<...>;
content_filter_error_message: ZodOptional<...>;
probe_message: ZodOptional<...>;
request_timeout: ZodOptional<...>;
}, ZodTypeAny, "passthrough">>>;
target_background: ZodOptional<ZodNullable<ZodObject<{
agentic_profiling_enabled: ZodOptional<...>;
industry: ZodOptional<...>;
use_case: ZodOptional<...>;
competitors: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
agentic_profiling_enabled: ...;
industry: ...;
use_case: ...;
competitors: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
agentic_profiling_enabled: ...;
industry: ...;
use_case: ...;
competitors: ...;
}, ZodTypeAny, "passthrough">>>>;
profiling_status: ZodOptional<ZodNullable<ZodString>>;
additional_context: ZodOptional<ZodNullable<ZodObject<{
base_model: ZodOptional<...>;
core_architecture: ZodOptional<...>;
system_prompt: ZodOptional<...>;
languages_supported: ZodOptional<...>;
banned_keywords: ZodOptional<...>;
tools_accessible: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
base_model: ...;
core_architecture: ...;
system_prompt: ...;
languages_supported: ...;
banned_keywords: ...;
tools_accessible: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
base_model: ...;
core_architecture: ...;
system_prompt: ...;
languages_supported: ...;
banned_keywords: ...;
tools_accessible: ...;
}, ZodTypeAny, "passthrough">>>>;
auth_type: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
adapter_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
canonical_id: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
adapter_secret_version: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
profiling_progress: ZodOptional<ZodUnion<[ZodNumber, ZodNull]>>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<ZodNullable<ZodString>>;
target_type: ZodOptional<ZodNullable<ZodString>>;
connection_type: ZodOptional<ZodNullable<ZodString>>;
api_endpoint_type: ZodOptional<ZodNullable<ZodString>>;
response_mode: ZodOptional<ZodNullable<ZodString>>;
session_supported: ZodOptional<ZodBoolean>;
extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<ZodNullable<ZodNumber>>;
secret_version: ZodOptional<ZodNullable<ZodString>>;
created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
updated_by_user_id: ZodOptional<ZodNullable<ZodString>>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<ZodObject<{
supports_multimodal_files: ZodOptional<ZodBoolean>;
supports_multimodal_files_error_message: ZodOptional<ZodUnion<...>>;
multi_turn: ZodOptional<ZodBoolean>;
multi_turn_error_message: ZodOptional<ZodNullable<...>>;
rate_limit: ZodOptional<ZodNullable<...>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit_error_code: ZodOptional<ZodNullable<...>>;
rate_limit_error_json: ZodOptional<ZodNullable<...>>;
rate_limit_error_message: ZodOptional<ZodNullable<...>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<...>>;
content_filter_error_json: ZodOptional<ZodNullable<...>>;
content_filter_error_message: ZodOptional<ZodNullable<...>>;
probe_message: ZodOptional<ZodString>;
request_timeout: ZodOptional<ZodNumber>;
}, "passthrough", ZodTypeAny, objectOutputType<{
supports_multimodal_files: ZodOptional<...>;
supports_multimodal_files_error_message: ZodOptional<...>;
multi_turn: ZodOptional<...>;
multi_turn_error_message: ZodOptional<...>;
rate_limit: ZodOptional<...>;
rate_limit_enabled: ZodOptional<...>;
rate_limit_error_code: ZodOptional<...>;
rate_limit_error_json: ZodOptional<...>;
rate_limit_error_message: ZodOptional<...>;
content_filter_enabled: ZodOptional<...>;
content_filter_error_code: ZodOptional<...>;
content_filter_error_json: ZodOptional<...>;
content_filter_error_message: ZodOptional<...>;
probe_message: ZodOptional<...>;
request_timeout: ZodOptional<...>;
}, ZodTypeAny, "passthrough">, objectInputType<{
supports_multimodal_files: ZodOptional<...>;
supports_multimodal_files_error_message: ZodOptional<...>;
multi_turn: ZodOptional<...>;
multi_turn_error_message: ZodOptional<...>;
rate_limit: ZodOptional<...>;
rate_limit_enabled: ZodOptional<...>;
rate_limit_error_code: ZodOptional<...>;
rate_limit_error_json: ZodOptional<...>;
rate_limit_error_message: ZodOptional<...>;
content_filter_enabled: ZodOptional<...>;
content_filter_error_code: ZodOptional<...>;
content_filter_error_json: ZodOptional<...>;
content_filter_error_message: ZodOptional<...>;
probe_message: ZodOptional<...>;
request_timeout: ZodOptional<...>;
}, ZodTypeAny, "passthrough">>>;
target_background: ZodOptional<ZodNullable<ZodObject<{
agentic_profiling_enabled: ZodOptional<...>;
industry: ZodOptional<...>;
use_case: ZodOptional<...>;
competitors: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
agentic_profiling_enabled: ...;
industry: ...;
use_case: ...;
competitors: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
agentic_profiling_enabled: ...;
industry: ...;
use_case: ...;
competitors: ...;
}, ZodTypeAny, "passthrough">>>>;
profiling_status: ZodOptional<ZodNullable<ZodString>>;
additional_context: ZodOptional<ZodNullable<ZodObject<{
base_model: ZodOptional<...>;
core_architecture: ZodOptional<...>;
system_prompt: ZodOptional<...>;
languages_supported: ZodOptional<...>;
banned_keywords: ZodOptional<...>;
tools_accessible: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
base_model: ...;
core_architecture: ...;
system_prompt: ...;
languages_supported: ...;
banned_keywords: ...;
tools_accessible: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
base_model: ...;
core_architecture: ...;
system_prompt: ...;
languages_supported: ...;
banned_keywords: ...;
tools_accessible: ...;
}, ZodTypeAny, "passthrough">>>>;
auth_type: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>;
job_type: ZodString;
job_metadata: ZodUnion<[ZodObject<{
language: ZodOptional<ZodNullable<ZodLazy<ZodObject<..., ..., ..., ..., ...>>>>;
include_file_attacks: ZodOptional<ZodBoolean>;
categories: ZodRecord<ZodString, ZodUnknown>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
language: ZodOptional<ZodNullable<ZodLazy<...>>>;
include_file_attacks: ZodOptional<ZodBoolean>;
categories: ZodRecord<ZodString, ZodUnknown>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
language: ZodOptional<ZodNullable<ZodLazy<...>>>;
include_file_attacks: ZodOptional<ZodBoolean>;
categories: ZodRecord<ZodString, ZodUnknown>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
}, ZodTypeAny, "passthrough">>, ZodObject<{
language: ZodOptional<ZodNullable<ZodLazy<ZodObject<..., ..., ..., ..., ...>>>>;
goal_categories: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
stream_breadth: ZodOptional<ZodNumber>;
stream_depth: ZodOptional<ZodNumber>;
max_tokens: ZodOptional<ZodNumber>;
context_size: ZodOptional<ZodNumber>;
attack_goals: ZodOptional<ZodArray<ZodString, "many">>;
base_model: ZodOptional<ZodNullable<ZodString>>;
use_case: ZodOptional<ZodNullable<ZodString>>;
system_prompt: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
language: ZodOptional<ZodNullable<ZodLazy<...>>>;
goal_categories: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
stream_breadth: ZodOptional<ZodNumber>;
stream_depth: ZodOptional<ZodNumber>;
max_tokens: ZodOptional<ZodNumber>;
context_size: ZodOptional<ZodNumber>;
attack_goals: ZodOptional<ZodArray<ZodString, "many">>;
base_model: ZodOptional<ZodNullable<ZodString>>;
use_case: ZodOptional<ZodNullable<ZodString>>;
system_prompt: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
language: ZodOptional<ZodNullable<ZodLazy<...>>>;
goal_categories: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
stream_breadth: ZodOptional<ZodNumber>;
stream_depth: ZodOptional<ZodNumber>;
max_tokens: ZodOptional<ZodNumber>;
context_size: ZodOptional<ZodNumber>;
attack_goals: ZodOptional<ZodArray<ZodString, "many">>;
base_model: ZodOptional<ZodNullable<ZodString>>;
use_case: ZodOptional<ZodNullable<ZodString>>;
system_prompt: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>, ZodObject<{
language: ZodOptional<ZodNullable<ZodLazy<ZodObject<..., ..., ..., ..., ...>>>>;
custom_prompt_sets: ZodArray<ZodString, "many">;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
language: ZodOptional<ZodNullable<ZodLazy<...>>>;
custom_prompt_sets: ZodArray<ZodString, "many">;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
language: ZodOptional<ZodNullable<ZodLazy<...>>>;
custom_prompt_sets: ZodArray<ZodString, "many">;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
}, ZodTypeAny, "passthrough">>, ZodObject<{
scan_name: ZodString;
categories: ZodOptional<ZodRecord<ZodString, ZodArray<ZodString, "many">>>;
language: ZodOptional<ZodNull>;
}, "passthrough", ZodTypeAny, objectOutputType<{
scan_name: ZodString;
categories: ZodOptional<ZodRecord<ZodString, ZodArray<..., ...>>>;
language: ZodOptional<ZodNull>;
}, ZodTypeAny, "passthrough">, objectInputType<{
scan_name: ZodString;
categories: ZodOptional<ZodRecord<ZodString, ZodArray<..., ...>>>;
language: ZodOptional<ZodNull>;
}, ZodTypeAny, "passthrough">>]>;
version: ZodOptional<ZodNullable<ZodNumber>>;
extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
target_id: ZodString;
target_type: ZodString;
total: ZodOptional<ZodNullable<ZodNumber>>;
completed: ZodOptional<ZodNullable<ZodNumber>>;
status: ZodOptional<ZodString>;
score: ZodOptional<ZodNullable<ZodNumber>>;
asr: ZodOptional<ZodNullable<ZodNumber>>;
time_record: ZodOptional<ZodNullable<ZodObject<{
queued_at: ZodOptional<ZodNullable<ZodString>>;
started_at: ZodOptional<ZodNullable<ZodString>>;
completed_at: ZodOptional<ZodNullable<ZodString>>;
time_taken: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
queued_at: ZodOptional<ZodNullable<ZodString>>;
started_at: ZodOptional<ZodNullable<ZodString>>;
completed_at: ZodOptional<ZodNullable<ZodString>>;
time_taken: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
queued_at: ZodOptional<ZodNullable<ZodString>>;
started_at: ZodOptional<ZodNullable<ZodString>>;
completed_at: ZodOptional<ZodNullable<ZodString>>;
time_taken: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>>>;
created_at: ZodOptional<ZodNullable<ZodString>>;
updated_at: ZodOptional<ZodNullable<ZodString>>;
created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
report_stats: ZodOptional<ZodNullable<ZodUnion<[ZodObject<{
output_completion_percentage: ZodNumber;
partial_report_unlocked: ZodOptional<ZodBoolean>;
partial_report_unlocked_at: ZodOptional<ZodNullable<...>>;
report_summary: ZodOptional<ZodNullable<...>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
output_completion_percentage: ZodNumber;
partial_report_unlocked: ZodOptional<...>;
partial_report_unlocked_at: ZodOptional<...>;
report_summary: ZodOptional<...>;
}, ZodTypeAny, "passthrough">, objectInputType<{
output_completion_percentage: ZodNumber;
partial_report_unlocked: ZodOptional<...>;
partial_report_unlocked_at: ZodOptional<...>;
report_summary: ZodOptional<...>;
}, ZodTypeAny, "passthrough">>, ZodObject<{
total_goals: ZodOptional<ZodNumber>;
total_streams: ZodOptional<ZodNumber>;
total_threats: ZodOptional<ZodNumber>;
goals_achieved: ZodOptional<ZodNumber>;
report_summary: ZodOptional<ZodNullable<...>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
total_goals: ZodOptional<...>;
total_streams: ZodOptional<...>;
total_threats: ZodOptional<...>;
goals_achieved: ZodOptional<...>;
report_summary: ZodOptional<...>;
}, ZodTypeAny, "passthrough">, objectInputType<{
total_goals: ZodOptional<...>;
total_streams: ZodOptional<...>;
total_threats: ZodOptional<...>;
goals_achieved: ZodOptional<...>;
report_summary: ZodOptional<...>;
}, ZodTypeAny, "passthrough">>]>>>;
metering_quota_uuid: ZodOptional<ZodNullable<ZodString>>;
counted_towards_quota: ZodOptional<ZodString>;
invocation_id: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>;
Defined in: src/red-team/scans-client.ts:75
Create a new red team scan job.
Parameters
| Parameter | Type | Description |
|---|---|---|
body | JobCreateRequest | Job creation request body. |
Returns
Promise<objectOutputType<{
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
target: ZodObject<{
adapter_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
canonical_id: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
adapter_secret_version: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
profiling_progress: ZodOptional<ZodUnion<[ZodNumber, ZodNull]>>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<ZodNullable<ZodString>>;
target_type: ZodOptional<ZodNullable<ZodString>>;
connection_type: ZodOptional<ZodNullable<ZodString>>;
api_endpoint_type: ZodOptional<ZodNullable<ZodString>>;
response_mode: ZodOptional<ZodNullable<ZodString>>;
session_supported: ZodOptional<ZodBoolean>;
extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<ZodNullable<ZodNumber>>;
secret_version: ZodOptional<ZodNullable<ZodString>>;
created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
updated_by_user_id: ZodOptional<ZodNullable<ZodString>>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<ZodObject<{
supports_multimodal_files: ZodOptional<ZodBoolean>;
supports_multimodal_files_error_message: ZodOptional<ZodUnion<[..., ...]>>;
multi_turn: ZodOptional<ZodBoolean>;
multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
probe_message: ZodOptional<ZodString>;
request_timeout: ZodOptional<ZodNumber>;
}, "passthrough", ZodTypeAny, objectOutputType<{
supports_multimodal_files: ZodOptional<ZodBoolean>;
supports_multimodal_files_error_message: ZodOptional<ZodUnion<...>>;
multi_turn: ZodOptional<ZodBoolean>;
multi_turn_error_message: ZodOptional<ZodNullable<...>>;
rate_limit: ZodOptional<ZodNullable<...>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit_error_code: ZodOptional<ZodNullable<...>>;
rate_limit_error_json: ZodOptional<ZodNullable<...>>;
rate_limit_error_message: ZodOptional<ZodNullable<...>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<...>>;
content_filter_error_json: ZodOptional<ZodNullable<...>>;
content_filter_error_message: ZodOptional<ZodNullable<...>>;
probe_message: ZodOptional<ZodString>;
request_timeout: ZodOptional<ZodNumber>;
}, ZodTypeAny, "passthrough">, objectInputType<{
supports_multimodal_files: ZodOptional<ZodBoolean>;
supports_multimodal_files_error_message: ZodOptional<ZodUnion<...>>;
multi_turn: ZodOptional<ZodBoolean>;
multi_turn_error_message: ZodOptional<ZodNullable<...>>;
rate_limit: ZodOptional<ZodNullable<...>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit_error_code: ZodOptional<ZodNullable<...>>;
rate_limit_error_json: ZodOptional<ZodNullable<...>>;
rate_limit_error_message: ZodOptional<ZodNullable<...>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<...>>;
content_filter_error_json: ZodOptional<ZodNullable<...>>;
content_filter_error_message: ZodOptional<ZodNullable<...>>;
probe_message: ZodOptional<ZodString>;
request_timeout: ZodOptional<ZodNumber>;
}, ZodTypeAny, "passthrough">>>;
target_background: ZodOptional<ZodNullable<ZodObject<{
agentic_profiling_enabled: ZodOptional<ZodBoolean>;
industry: ZodOptional<ZodNullable<...>>;
use_case: ZodOptional<ZodNullable<...>>;
competitors: ZodOptional<ZodNullable<...>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
agentic_profiling_enabled: ZodOptional<...>;
industry: ZodOptional<...>;
use_case: ZodOptional<...>;
competitors: ZodOptional<...>;
}, ZodTypeAny, "passthrough">, objectInputType<{
agentic_profiling_enabled: ZodOptional<...>;
industry: ZodOptional<...>;
use_case: ZodOptional<...>;
competitors: ZodOptional<...>;
}, ZodTypeAny, "passthrough">>>>;
profiling_status: ZodOptional<ZodNullable<ZodString>>;
additional_context: ZodOptional<ZodNullable<ZodObject<{
base_model: ZodOptional<ZodNullable<...>>;
core_architecture: ZodOptional<ZodNullable<...>>;
system_prompt: ZodOptional<ZodNullable<...>>;
languages_supported: ZodOptional<ZodNullable<...>>;
banned_keywords: ZodOptional<ZodNullable<...>>;
tools_accessible: ZodOptional<ZodNullable<...>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
base_model: ZodOptional<...>;
core_architecture: ZodOptional<...>;
system_prompt: ZodOptional<...>;
languages_supported: ZodOptional<...>;
banned_keywords: ZodOptional<...>;
tools_accessible: ZodOptional<...>;
}, ZodTypeAny, "passthrough">, objectInputType<{
base_model: ZodOptional<...>;
core_architecture: ZodOptional<...>;
system_prompt: ZodOptional<...>;
languages_supported: ZodOptional<...>;
banned_keywords: ZodOptional<...>;
tools_accessible: ZodOptional<...>;
}, ZodTypeAny, "passthrough">>>>;
auth_type: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
adapter_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
canonical_id: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
adapter_secret_version: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
profiling_progress: ZodOptional<ZodUnion<[ZodNumber, ZodNull]>>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<ZodNullable<ZodString>>;
target_type: ZodOptional<ZodNullable<ZodString>>;
connection_type: ZodOptional<ZodNullable<ZodString>>;
api_endpoint_type: ZodOptional<ZodNullable<ZodString>>;
response_mode: ZodOptional<ZodNullable<ZodString>>;
session_supported: ZodOptional<ZodBoolean>;
extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<ZodNullable<ZodNumber>>;
secret_version: ZodOptional<ZodNullable<ZodString>>;
created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
updated_by_user_id: ZodOptional<ZodNullable<ZodString>>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<ZodObject<{
supports_multimodal_files: ZodOptional<ZodBoolean>;
supports_multimodal_files_error_message: ZodOptional<ZodUnion<...>>;
multi_turn: ZodOptional<ZodBoolean>;
multi_turn_error_message: ZodOptional<ZodNullable<...>>;
rate_limit: ZodOptional<ZodNullable<...>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit_error_code: ZodOptional<ZodNullable<...>>;
rate_limit_error_json: ZodOptional<ZodNullable<...>>;
rate_limit_error_message: ZodOptional<ZodNullable<...>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<...>>;
content_filter_error_json: ZodOptional<ZodNullable<...>>;
content_filter_error_message: ZodOptional<ZodNullable<...>>;
probe_message: ZodOptional<ZodString>;
request_timeout: ZodOptional<ZodNumber>;
}, "passthrough", ZodTypeAny, objectOutputType<{
supports_multimodal_files: ZodOptional<...>;
supports_multimodal_files_error_message: ZodOptional<...>;
multi_turn: ZodOptional<...>;
multi_turn_error_message: ZodOptional<...>;
rate_limit: ZodOptional<...>;
rate_limit_enabled: ZodOptional<...>;
rate_limit_error_code: ZodOptional<...>;
rate_limit_error_json: ZodOptional<...>;
rate_limit_error_message: ZodOptional<...>;
content_filter_enabled: ZodOptional<...>;
content_filter_error_code: ZodOptional<...>;
content_filter_error_json: ZodOptional<...>;
content_filter_error_message: ZodOptional<...>;
probe_message: ZodOptional<...>;
request_timeout: ZodOptional<...>;
}, ZodTypeAny, "passthrough">, objectInputType<{
supports_multimodal_files: ZodOptional<...>;
supports_multimodal_files_error_message: ZodOptional<...>;
multi_turn: ZodOptional<...>;
multi_turn_error_message: ZodOptional<...>;
rate_limit: ZodOptional<...>;
rate_limit_enabled: ZodOptional<...>;
rate_limit_error_code: ZodOptional<...>;
rate_limit_error_json: ZodOptional<...>;
rate_limit_error_message: ZodOptional<...>;
content_filter_enabled: ZodOptional<...>;
content_filter_error_code: ZodOptional<...>;
content_filter_error_json: ZodOptional<...>;
content_filter_error_message: ZodOptional<...>;
probe_message: ZodOptional<...>;
request_timeout: ZodOptional<...>;
}, ZodTypeAny, "passthrough">>>;
target_background: ZodOptional<ZodNullable<ZodObject<{
agentic_profiling_enabled: ZodOptional<...>;
industry: ZodOptional<...>;
use_case: ZodOptional<...>;
competitors: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
agentic_profiling_enabled: ...;
industry: ...;
use_case: ...;
competitors: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
agentic_profiling_enabled: ...;
industry: ...;
use_case: ...;
competitors: ...;
}, ZodTypeAny, "passthrough">>>>;
profiling_status: ZodOptional<ZodNullable<ZodString>>;
additional_context: ZodOptional<ZodNullable<ZodObject<{
base_model: ZodOptional<...>;
core_architecture: ZodOptional<...>;
system_prompt: ZodOptional<...>;
languages_supported: ZodOptional<...>;
banned_keywords: ZodOptional<...>;
tools_accessible: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
base_model: ...;
core_architecture: ...;
system_prompt: ...;
languages_supported: ...;
banned_keywords: ...;
tools_accessible: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
base_model: ...;
core_architecture: ...;
system_prompt: ...;
languages_supported: ...;
banned_keywords: ...;
tools_accessible: ...;
}, ZodTypeAny, "passthrough">>>>;
auth_type: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
adapter_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
canonical_id: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
adapter_secret_version: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
profiling_progress: ZodOptional<ZodUnion<[ZodNumber, ZodNull]>>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<ZodNullable<ZodString>>;
target_type: ZodOptional<ZodNullable<ZodString>>;
connection_type: ZodOptional<ZodNullable<ZodString>>;
api_endpoint_type: ZodOptional<ZodNullable<ZodString>>;
response_mode: ZodOptional<ZodNullable<ZodString>>;
session_supported: ZodOptional<ZodBoolean>;
extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<ZodNullable<ZodNumber>>;
secret_version: ZodOptional<ZodNullable<ZodString>>;
created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
updated_by_user_id: ZodOptional<ZodNullable<ZodString>>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<ZodObject<{
supports_multimodal_files: ZodOptional<ZodBoolean>;
supports_multimodal_files_error_message: ZodOptional<ZodUnion<...>>;
multi_turn: ZodOptional<ZodBoolean>;
multi_turn_error_message: ZodOptional<ZodNullable<...>>;
rate_limit: ZodOptional<ZodNullable<...>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit_error_code: ZodOptional<ZodNullable<...>>;
rate_limit_error_json: ZodOptional<ZodNullable<...>>;
rate_limit_error_message: ZodOptional<ZodNullable<...>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<...>>;
content_filter_error_json: ZodOptional<ZodNullable<...>>;
content_filter_error_message: ZodOptional<ZodNullable<...>>;
probe_message: ZodOptional<ZodString>;
request_timeout: ZodOptional<ZodNumber>;
}, "passthrough", ZodTypeAny, objectOutputType<{
supports_multimodal_files: ZodOptional<...>;
supports_multimodal_files_error_message: ZodOptional<...>;
multi_turn: ZodOptional<...>;
multi_turn_error_message: ZodOptional<...>;
rate_limit: ZodOptional<...>;
rate_limit_enabled: ZodOptional<...>;
rate_limit_error_code: ZodOptional<...>;
rate_limit_error_json: ZodOptional<...>;
rate_limit_error_message: ZodOptional<...>;
content_filter_enabled: ZodOptional<...>;
content_filter_error_code: ZodOptional<...>;
content_filter_error_json: ZodOptional<...>;
content_filter_error_message: ZodOptional<...>;
probe_message: ZodOptional<...>;
request_timeout: ZodOptional<...>;
}, ZodTypeAny, "passthrough">, objectInputType<{
supports_multimodal_files: ZodOptional<...>;
supports_multimodal_files_error_message: ZodOptional<...>;
multi_turn: ZodOptional<...>;
multi_turn_error_message: ZodOptional<...>;
rate_limit: ZodOptional<...>;
rate_limit_enabled: ZodOptional<...>;
rate_limit_error_code: ZodOptional<...>;
rate_limit_error_json: ZodOptional<...>;
rate_limit_error_message: ZodOptional<...>;
content_filter_enabled: ZodOptional<...>;
content_filter_error_code: ZodOptional<...>;
content_filter_error_json: ZodOptional<...>;
content_filter_error_message: ZodOptional<...>;
probe_message: ZodOptional<...>;
request_timeout: ZodOptional<...>;
}, ZodTypeAny, "passthrough">>>;
target_background: ZodOptional<ZodNullable<ZodObject<{
agentic_profiling_enabled: ZodOptional<...>;
industry: ZodOptional<...>;
use_case: ZodOptional<...>;
competitors: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
agentic_profiling_enabled: ...;
industry: ...;
use_case: ...;
competitors: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
agentic_profiling_enabled: ...;
industry: ...;
use_case: ...;
competitors: ...;
}, ZodTypeAny, "passthrough">>>>;
profiling_status: ZodOptional<ZodNullable<ZodString>>;
additional_context: ZodOptional<ZodNullable<ZodObject<{
base_model: ZodOptional<...>;
core_architecture: ZodOptional<...>;
system_prompt: ZodOptional<...>;
languages_supported: ZodOptional<...>;
banned_keywords: ZodOptional<...>;
tools_accessible: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
base_model: ...;
core_architecture: ...;
system_prompt: ...;
languages_supported: ...;
banned_keywords: ...;
tools_accessible: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
base_model: ...;
core_architecture: ...;
system_prompt: ...;
languages_supported: ...;
banned_keywords: ...;
tools_accessible: ...;
}, ZodTypeAny, "passthrough">>>>;
auth_type: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>;
job_type: ZodString;
job_metadata: ZodUnion<[ZodObject<{
language: ZodOptional<ZodNullable<ZodLazy<ZodObject<..., ..., ..., ..., ...>>>>;
include_file_attacks: ZodOptional<ZodBoolean>;
categories: ZodRecord<ZodString, ZodUnknown>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
language: ZodOptional<ZodNullable<ZodLazy<...>>>;
include_file_attacks: ZodOptional<ZodBoolean>;
categories: ZodRecord<ZodString, ZodUnknown>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
language: ZodOptional<ZodNullable<ZodLazy<...>>>;
include_file_attacks: ZodOptional<ZodBoolean>;
categories: ZodRecord<ZodString, ZodUnknown>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
}, ZodTypeAny, "passthrough">>, ZodObject<{
language: ZodOptional<ZodNullable<ZodLazy<ZodObject<..., ..., ..., ..., ...>>>>;
goal_categories: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
stream_breadth: ZodOptional<ZodNumber>;
stream_depth: ZodOptional<ZodNumber>;
max_tokens: ZodOptional<ZodNumber>;
context_size: ZodOptional<ZodNumber>;
attack_goals: ZodOptional<ZodArray<ZodString, "many">>;
base_model: ZodOptional<ZodNullable<ZodString>>;
use_case: ZodOptional<ZodNullable<ZodString>>;
system_prompt: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
language: ZodOptional<ZodNullable<ZodLazy<...>>>;
goal_categories: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
stream_breadth: ZodOptional<ZodNumber>;
stream_depth: ZodOptional<ZodNumber>;
max_tokens: ZodOptional<ZodNumber>;
context_size: ZodOptional<ZodNumber>;
attack_goals: ZodOptional<ZodArray<ZodString, "many">>;
base_model: ZodOptional<ZodNullable<ZodString>>;
use_case: ZodOptional<ZodNullable<ZodString>>;
system_prompt: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
language: ZodOptional<ZodNullable<ZodLazy<...>>>;
goal_categories: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
stream_breadth: ZodOptional<ZodNumber>;
stream_depth: ZodOptional<ZodNumber>;
max_tokens: ZodOptional<ZodNumber>;
context_size: ZodOptional<ZodNumber>;
attack_goals: ZodOptional<ZodArray<ZodString, "many">>;
base_model: ZodOptional<ZodNullable<ZodString>>;
use_case: ZodOptional<ZodNullable<ZodString>>;
system_prompt: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>, ZodObject<{
language: ZodOptional<ZodNullable<ZodLazy<ZodObject<..., ..., ..., ..., ...>>>>;
custom_prompt_sets: ZodArray<ZodString, "many">;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
language: ZodOptional<ZodNullable<ZodLazy<...>>>;
custom_prompt_sets: ZodArray<ZodString, "many">;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
language: ZodOptional<ZodNullable<ZodLazy<...>>>;
custom_prompt_sets: ZodArray<ZodString, "many">;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
}, ZodTypeAny, "passthrough">>, ZodObject<{
scan_name: ZodString;
categories: ZodOptional<ZodRecord<ZodString, ZodArray<ZodString, "many">>>;
language: ZodOptional<ZodNull>;
}, "passthrough", ZodTypeAny, objectOutputType<{
scan_name: ZodString;
categories: ZodOptional<ZodRecord<ZodString, ZodArray<..., ...>>>;
language: ZodOptional<ZodNull>;
}, ZodTypeAny, "passthrough">, objectInputType<{
scan_name: ZodString;
categories: ZodOptional<ZodRecord<ZodString, ZodArray<..., ...>>>;
language: ZodOptional<ZodNull>;
}, ZodTypeAny, "passthrough">>]>;
version: ZodOptional<ZodNullable<ZodNumber>>;
extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
target_id: ZodString;
target_type: ZodString;
total: ZodOptional<ZodNullable<ZodNumber>>;
completed: ZodOptional<ZodNullable<ZodNumber>>;
status: ZodOptional<ZodString>;
score: ZodOptional<ZodNullable<ZodNumber>>;
asr: ZodOptional<ZodNullable<ZodNumber>>;
time_record: ZodOptional<ZodNullable<ZodObject<{
queued_at: ZodOptional<ZodNullable<ZodString>>;
started_at: ZodOptional<ZodNullable<ZodString>>;
completed_at: ZodOptional<ZodNullable<ZodString>>;
time_taken: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
queued_at: ZodOptional<ZodNullable<ZodString>>;
started_at: ZodOptional<ZodNullable<ZodString>>;
completed_at: ZodOptional<ZodNullable<ZodString>>;
time_taken: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
queued_at: ZodOptional<ZodNullable<ZodString>>;
started_at: ZodOptional<ZodNullable<ZodString>>;
completed_at: ZodOptional<ZodNullable<ZodString>>;
time_taken: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>>>;
created_at: ZodOptional<ZodNullable<ZodString>>;
updated_at: ZodOptional<ZodNullable<ZodString>>;
created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
report_stats: ZodOptional<ZodNullable<ZodUnion<[ZodObject<{
output_completion_percentage: ZodNumber;
partial_report_unlocked: ZodOptional<ZodBoolean>;
partial_report_unlocked_at: ZodOptional<ZodNullable<...>>;
report_summary: ZodOptional<ZodNullable<...>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
output_completion_percentage: ZodNumber;
partial_report_unlocked: ZodOptional<...>;
partial_report_unlocked_at: ZodOptional<...>;
report_summary: ZodOptional<...>;
}, ZodTypeAny, "passthrough">, objectInputType<{
output_completion_percentage: ZodNumber;
partial_report_unlocked: ZodOptional<...>;
partial_report_unlocked_at: ZodOptional<...>;
report_summary: ZodOptional<...>;
}, ZodTypeAny, "passthrough">>, ZodObject<{
total_goals: ZodOptional<ZodNumber>;
total_streams: ZodOptional<ZodNumber>;
total_threats: ZodOptional<ZodNumber>;
goals_achieved: ZodOptional<ZodNumber>;
report_summary: ZodOptional<ZodNullable<...>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
total_goals: ZodOptional<...>;
total_streams: ZodOptional<...>;
total_threats: ZodOptional<...>;
goals_achieved: ZodOptional<...>;
report_summary: ZodOptional<...>;
}, ZodTypeAny, "passthrough">, objectInputType<{
total_goals: ZodOptional<...>;
total_streams: ZodOptional<...>;
total_threats: ZodOptional<...>;
goals_achieved: ZodOptional<...>;
report_summary: ZodOptional<...>;
}, ZodTypeAny, "passthrough">>]>>>;
metering_quota_uuid: ZodOptional<ZodNullable<ZodString>>;
counted_towards_quota: ZodOptional<ZodString>;
invocation_id: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>
The created job response.
Example
import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();
const job = await rt.scans.create({
name: 'nightly-static-scan',
target: { uuid: '550e8400-e29b-41d4-a716-446655440000' },
job_type: 'STATIC',
job_metadata: {},
});
// job =>
// { uuid: '550e8400-...', name: 'nightly-static-scan', status: 'QUEUED', job_type: 'STATIC' }
list()
list(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;
name: ZodString;
target: ZodObject<{
adapter_uuid: ZodOptional<ZodUnion<[..., ...]>>;
canonical_id: ZodOptional<ZodUnion<[..., ...]>>;
adapter_secret_version: ZodOptional<ZodUnion<[..., ...]>>;
profiling_progress: ZodOptional<ZodUnion<[..., ...]>>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<ZodNullable<ZodString>>;
target_type: ZodOptional<ZodNullable<ZodString>>;
connection_type: ZodOptional<ZodNullable<ZodString>>;
api_endpoint_type: ZodOptional<ZodNullable<ZodString>>;
response_mode: ZodOptional<ZodNullable<ZodString>>;
session_supported: ZodOptional<ZodBoolean>;
extra_info: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<ZodNullable<ZodNumber>>;
secret_version: ZodOptional<ZodNullable<ZodString>>;
created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
updated_by_user_id: ZodOptional<ZodNullable<ZodString>>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<ZodObject<{
supports_multimodal_files: ...;
supports_multimodal_files_error_message: ...;
multi_turn: ...;
multi_turn_error_message: ...;
rate_limit: ...;
rate_limit_enabled: ...;
rate_limit_error_code: ...;
rate_limit_error_json: ...;
rate_limit_error_message: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_json: ...;
content_filter_error_message: ...;
probe_message: ...;
request_timeout: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>;
target_background: ZodOptional<ZodNullable<ZodObject<..., ..., ..., ..., ...>>>;
profiling_status: ZodOptional<ZodNullable<ZodString>>;
additional_context: ZodOptional<ZodNullable<ZodObject<..., ..., ..., ..., ...>>>;
auth_type: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
adapter_uuid: ZodOptional<ZodUnion<...>>;
canonical_id: ZodOptional<ZodUnion<...>>;
adapter_secret_version: ZodOptional<ZodUnion<...>>;
profiling_progress: ZodOptional<ZodUnion<...>>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<ZodNullable<...>>;
target_type: ZodOptional<ZodNullable<...>>;
connection_type: ZodOptional<ZodNullable<...>>;
api_endpoint_type: ZodOptional<ZodNullable<...>>;
response_mode: ZodOptional<ZodNullable<...>>;
session_supported: ZodOptional<ZodBoolean>;
extra_info: ZodOptional<ZodNullable<...>>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<ZodNullable<...>>;
secret_version: ZodOptional<ZodNullable<...>>;
created_by_user_id: ZodOptional<ZodNullable<...>>;
updated_by_user_id: ZodOptional<ZodNullable<...>>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<ZodObject<..., ..., ..., ..., ...>>;
target_background: ZodOptional<ZodNullable<...>>;
profiling_status: ZodOptional<ZodNullable<...>>;
additional_context: ZodOptional<ZodNullable<...>>;
auth_type: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
adapter_uuid: ZodOptional<ZodUnion<...>>;
canonical_id: ZodOptional<ZodUnion<...>>;
adapter_secret_version: ZodOptional<ZodUnion<...>>;
profiling_progress: ZodOptional<ZodUnion<...>>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<ZodNullable<...>>;
target_type: ZodOptional<ZodNullable<...>>;
connection_type: ZodOptional<ZodNullable<...>>;
api_endpoint_type: ZodOptional<ZodNullable<...>>;
response_mode: ZodOptional<ZodNullable<...>>;
session_supported: ZodOptional<ZodBoolean>;
extra_info: ZodOptional<ZodNullable<...>>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<ZodNullable<...>>;
secret_version: ZodOptional<ZodNullable<...>>;
created_by_user_id: ZodOptional<ZodNullable<...>>;
updated_by_user_id: ZodOptional<ZodNullable<...>>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<ZodObject<..., ..., ..., ..., ...>>;
target_background: ZodOptional<ZodNullable<...>>;
profiling_status: ZodOptional<ZodNullable<...>>;
additional_context: ZodOptional<ZodNullable<...>>;
auth_type: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">>;
job_type: ZodString;
job_metadata: ZodUnion<[ZodObject<{
language: ZodOptional<...>;
include_file_attacks: ZodOptional<...>;
categories: ZodRecord<..., ...>;
rate_limit_enabled: ZodOptional<...>;
rate_limit: ZodOptional<...>;
rate_limit_error_code: ZodOptional<...>;
rate_limit_error_message: ZodOptional<...>;
rate_limit_error_json: ZodOptional<...>;
content_filter_enabled: ZodOptional<...>;
content_filter_error_code: ZodOptional<...>;
content_filter_error_message: ZodOptional<...>;
content_filter_error_json: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
language: ...;
include_file_attacks: ...;
categories: ...;
rate_limit_enabled: ...;
rate_limit: ...;
rate_limit_error_code: ...;
rate_limit_error_message: ...;
rate_limit_error_json: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_message: ...;
content_filter_error_json: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
language: ...;
include_file_attacks: ...;
categories: ...;
rate_limit_enabled: ...;
rate_limit: ...;
rate_limit_error_code: ...;
rate_limit_error_message: ...;
rate_limit_error_json: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_message: ...;
content_filter_error_json: ...;
}, ZodTypeAny, "passthrough">>, ZodObject<{
language: ZodOptional<...>;
goal_categories: ZodOptional<...>;
rate_limit_enabled: ZodOptional<...>;
rate_limit: ZodOptional<...>;
rate_limit_error_code: ZodOptional<...>;
rate_limit_error_message: ZodOptional<...>;
rate_limit_error_json: ZodOptional<...>;
content_filter_enabled: ZodOptional<...>;
content_filter_error_code: ZodOptional<...>;
content_filter_error_message: ZodOptional<...>;
content_filter_error_json: ZodOptional<...>;
stream_breadth: ZodOptional<...>;
stream_depth: ZodOptional<...>;
max_tokens: ZodOptional<...>;
context_size: ZodOptional<...>;
attack_goals: ZodOptional<...>;
base_model: ZodOptional<...>;
use_case: ZodOptional<...>;
system_prompt: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
language: ...;
goal_categories: ...;
rate_limit_enabled: ...;
rate_limit: ...;
rate_limit_error_code: ...;
rate_limit_error_message: ...;
rate_limit_error_json: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_message: ...;
content_filter_error_json: ...;
stream_breadth: ...;
stream_depth: ...;
max_tokens: ...;
context_size: ...;
attack_goals: ...;
base_model: ...;
use_case: ...;
system_prompt: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
language: ...;
goal_categories: ...;
rate_limit_enabled: ...;
rate_limit: ...;
rate_limit_error_code: ...;
rate_limit_error_message: ...;
rate_limit_error_json: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_message: ...;
content_filter_error_json: ...;
stream_breadth: ...;
stream_depth: ...;
max_tokens: ...;
context_size: ...;
attack_goals: ...;
base_model: ...;
use_case: ...;
system_prompt: ...;
}, ZodTypeAny, "passthrough">>, ZodObject<{
language: ZodOptional<...>;
custom_prompt_sets: ZodArray<..., ...>;
rate_limit_enabled: ZodOptional<...>;
rate_limit: ZodOptional<...>;
rate_limit_error_code: ZodOptional<...>;
rate_limit_error_message: ZodOptional<...>;
rate_limit_error_json: ZodOptional<...>;
content_filter_enabled: ZodOptional<...>;
content_filter_error_code: ZodOptional<...>;
content_filter_error_message: ZodOptional<...>;
content_filter_error_json: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
language: ...;
custom_prompt_sets: ...;
rate_limit_enabled: ...;
rate_limit: ...;
rate_limit_error_code: ...;
rate_limit_error_message: ...;
rate_limit_error_json: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_message: ...;
content_filter_error_json: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
language: ...;
custom_prompt_sets: ...;
rate_limit_enabled: ...;
rate_limit: ...;
rate_limit_error_code: ...;
rate_limit_error_message: ...;
rate_limit_error_json: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_message: ...;
content_filter_error_json: ...;
}, ZodTypeAny, "passthrough">>, ZodObject<{
scan_name: ZodString;
categories: ZodOptional<...>;
language: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
scan_name: ...;
categories: ...;
language: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
scan_name: ...;
categories: ...;
language: ...;
}, ZodTypeAny, "passthrough">>]>;
version: ZodOptional<ZodNullable<ZodNumber>>;
extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
target_id: ZodString;
target_type: ZodString;
total: ZodOptional<ZodNullable<ZodNumber>>;
completed: ZodOptional<ZodNullable<ZodNumber>>;
status: ZodOptional<ZodString>;
score: ZodOptional<ZodNullable<ZodNumber>>;
asr: ZodOptional<ZodNullable<ZodNumber>>;
time_record: ZodOptional<ZodNullable<ZodObject<{
queued_at: ZodOptional<...>;
started_at: ZodOptional<...>;
completed_at: ZodOptional<...>;
time_taken: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
queued_at: ...;
started_at: ...;
completed_at: ...;
time_taken: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
queued_at: ...;
started_at: ...;
completed_at: ...;
time_taken: ...;
}, ZodTypeAny, "passthrough">>>>;
created_at: ZodOptional<ZodNullable<ZodString>>;
updated_at: ZodOptional<ZodNullable<ZodString>>;
created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
report_stats: ZodOptional<ZodNullable<ZodUnion<[ZodObject<..., ..., ..., ..., ...>, ZodObject<..., ..., ..., ..., ...>]>>>;
metering_quota_uuid: ZodOptional<ZodNullable<ZodString>>;
counted_towards_quota: ZodOptional<ZodString>;
invocation_id: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
target: ZodObject<{
adapter_uuid: ZodOptional<ZodUnion<...>>;
canonical_id: ZodOptional<ZodUnion<...>>;
adapter_secret_version: ZodOptional<ZodUnion<...>>;
profiling_progress: ZodOptional<ZodUnion<...>>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<ZodNullable<...>>;
target_type: ZodOptional<ZodNullable<...>>;
connection_type: ZodOptional<ZodNullable<...>>;
api_endpoint_type: ZodOptional<ZodNullable<...>>;
response_mode: ZodOptional<ZodNullable<...>>;
session_supported: ZodOptional<ZodBoolean>;
extra_info: ZodOptional<ZodNullable<...>>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<ZodNullable<...>>;
secret_version: ZodOptional<ZodNullable<...>>;
created_by_user_id: ZodOptional<ZodNullable<...>>;
updated_by_user_id: ZodOptional<ZodNullable<...>>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<ZodObject<..., ..., ..., ..., ...>>;
target_background: ZodOptional<ZodNullable<...>>;
profiling_status: ZodOptional<ZodNullable<...>>;
additional_context: ZodOptional<ZodNullable<...>>;
auth_type: ZodOptional<ZodNullable<...>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
adapter_uuid: ZodOptional<...>;
canonical_id: ZodOptional<...>;
adapter_secret_version: ZodOptional<...>;
profiling_progress: ZodOptional<...>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<...>;
target_type: ZodOptional<...>;
connection_type: ZodOptional<...>;
api_endpoint_type: ZodOptional<...>;
response_mode: ZodOptional<...>;
session_supported: ZodOptional<...>;
extra_info: ZodOptional<...>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<...>;
secret_version: ZodOptional<...>;
created_by_user_id: ZodOptional<...>;
updated_by_user_id: ZodOptional<...>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<...>;
target_background: ZodOptional<...>;
profiling_status: ZodOptional<...>;
additional_context: ZodOptional<...>;
auth_type: ZodOptional<...>;
}, ZodTypeAny, "passthrough">, objectInputType<{
adapter_uuid: ZodOptional<...>;
canonical_id: ZodOptional<...>;
adapter_secret_version: ZodOptional<...>;
profiling_progress: ZodOptional<...>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<...>;
target_type: ZodOptional<...>;
connection_type: ZodOptional<...>;
api_endpoint_type: ZodOptional<...>;
response_mode: ZodOptional<...>;
session_supported: ZodOptional<...>;
extra_info: ZodOptional<...>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<...>;
secret_version: ZodOptional<...>;
created_by_user_id: ZodOptional<...>;
updated_by_user_id: ZodOptional<...>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<...>;
target_background: ZodOptional<...>;
profiling_status: ZodOptional<...>;
additional_context: ZodOptional<...>;
auth_type: ZodOptional<...>;
}, ZodTypeAny, "passthrough">>;
job_type: ZodString;
job_metadata: ZodUnion<[ZodObject<{
language: ...;
include_file_attacks: ...;
categories: ...;
rate_limit_enabled: ...;
rate_limit: ...;
rate_limit_error_code: ...;
rate_limit_error_message: ...;
rate_limit_error_json: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_message: ...;
content_filter_error_json: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, ZodObject<{
language: ...;
goal_categories: ...;
rate_limit_enabled: ...;
rate_limit: ...;
rate_limit_error_code: ...;
rate_limit_error_message: ...;
rate_limit_error_json: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_message: ...;
content_filter_error_json: ...;
stream_breadth: ...;
stream_depth: ...;
max_tokens: ...;
context_size: ...;
attack_goals: ...;
base_model: ...;
use_case: ...;
system_prompt: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, ZodObject<{
language: ...;
custom_prompt_sets: ...;
rate_limit_enabled: ...;
rate_limit: ...;
rate_limit_error_code: ...;
rate_limit_error_message: ...;
rate_limit_error_json: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_message: ...;
content_filter_error_json: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, ZodObject<{
scan_name: ...;
categories: ...;
language: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>]>;
version: ZodOptional<ZodNullable<ZodNumber>>;
extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
target_id: ZodString;
target_type: ZodString;
total: ZodOptional<ZodNullable<ZodNumber>>;
completed: ZodOptional<ZodNullable<ZodNumber>>;
status: ZodOptional<ZodString>;
score: ZodOptional<ZodNullable<ZodNumber>>;
asr: ZodOptional<ZodNullable<ZodNumber>>;
time_record: ZodOptional<ZodNullable<ZodObject<{
queued_at: ...;
started_at: ...;
completed_at: ...;
time_taken: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
created_at: ZodOptional<ZodNullable<ZodString>>;
updated_at: ZodOptional<ZodNullable<ZodString>>;
created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
report_stats: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>;
metering_quota_uuid: ZodOptional<ZodNullable<ZodString>>;
counted_towards_quota: ZodOptional<ZodString>;
invocation_id: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
target: ZodObject<{
adapter_uuid: ZodOptional<ZodUnion<...>>;
canonical_id: ZodOptional<ZodUnion<...>>;
adapter_secret_version: ZodOptional<ZodUnion<...>>;
profiling_progress: ZodOptional<ZodUnion<...>>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<ZodNullable<...>>;
target_type: ZodOptional<ZodNullable<...>>;
connection_type: ZodOptional<ZodNullable<...>>;
api_endpoint_type: ZodOptional<ZodNullable<...>>;
response_mode: ZodOptional<ZodNullable<...>>;
session_supported: ZodOptional<ZodBoolean>;
extra_info: ZodOptional<ZodNullable<...>>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<ZodNullable<...>>;
secret_version: ZodOptional<ZodNullable<...>>;
created_by_user_id: ZodOptional<ZodNullable<...>>;
updated_by_user_id: ZodOptional<ZodNullable<...>>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<ZodObject<..., ..., ..., ..., ...>>;
target_background: ZodOptional<ZodNullable<...>>;
profiling_status: ZodOptional<ZodNullable<...>>;
additional_context: ZodOptional<ZodNullable<...>>;
auth_type: ZodOptional<ZodNullable<...>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
adapter_uuid: ZodOptional<...>;
canonical_id: ZodOptional<...>;
adapter_secret_version: ZodOptional<...>;
profiling_progress: ZodOptional<...>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<...>;
target_type: ZodOptional<...>;
connection_type: ZodOptional<...>;
api_endpoint_type: ZodOptional<...>;
response_mode: ZodOptional<...>;
session_supported: ZodOptional<...>;
extra_info: ZodOptional<...>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<...>;
secret_version: ZodOptional<...>;
created_by_user_id: ZodOptional<...>;
updated_by_user_id: ZodOptional<...>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<...>;
target_background: ZodOptional<...>;
profiling_status: ZodOptional<...>;
additional_context: ZodOptional<...>;
auth_type: ZodOptional<...>;
}, ZodTypeAny, "passthrough">, objectInputType<{
adapter_uuid: ZodOptional<...>;
canonical_id: ZodOptional<...>;
adapter_secret_version: ZodOptional<...>;
profiling_progress: ZodOptional<...>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<...>;
target_type: ZodOptional<...>;
connection_type: ZodOptional<...>;
api_endpoint_type: ZodOptional<...>;
response_mode: ZodOptional<...>;
session_supported: ZodOptional<...>;
extra_info: ZodOptional<...>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<...>;
secret_version: ZodOptional<...>;
created_by_user_id: ZodOptional<...>;
updated_by_user_id: ZodOptional<...>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<...>;
target_background: ZodOptional<...>;
profiling_status: ZodOptional<...>;
additional_context: ZodOptional<...>;
auth_type: ZodOptional<...>;
}, ZodTypeAny, "passthrough">>;
job_type: ZodString;
job_metadata: ZodUnion<[ZodObject<{
language: ...;
include_file_attacks: ...;
categories: ...;
rate_limit_enabled: ...;
rate_limit: ...;
rate_limit_error_code: ...;
rate_limit_error_message: ...;
rate_limit_error_json: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_message: ...;
content_filter_error_json: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, ZodObject<{
language: ...;
goal_categories: ...;
rate_limit_enabled: ...;
rate_limit: ...;
rate_limit_error_code: ...;
rate_limit_error_message: ...;
rate_limit_error_json: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_message: ...;
content_filter_error_json: ...;
stream_breadth: ...;
stream_depth: ...;
max_tokens: ...;
context_size: ...;
attack_goals: ...;
base_model: ...;
use_case: ...;
system_prompt: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, ZodObject<{
language: ...;
custom_prompt_sets: ...;
rate_limit_enabled: ...;
rate_limit: ...;
rate_limit_error_code: ...;
rate_limit_error_message: ...;
rate_limit_error_json: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_message: ...;
content_filter_error_json: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, ZodObject<{
scan_name: ...;
categories: ...;
language: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>]>;
version: ZodOptional<ZodNullable<ZodNumber>>;
extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
target_id: ZodString;
target_type: ZodString;
total: ZodOptional<ZodNullable<ZodNumber>>;
completed: ZodOptional<ZodNullable<ZodNumber>>;
status: ZodOptional<ZodString>;
score: ZodOptional<ZodNullable<ZodNumber>>;
asr: ZodOptional<ZodNullable<ZodNumber>>;
time_record: ZodOptional<ZodNullable<ZodObject<{
queued_at: ...;
started_at: ...;
completed_at: ...;
time_taken: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
created_at: ZodOptional<ZodNullable<ZodString>>;
updated_at: ZodOptional<ZodNullable<ZodString>>;
created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
report_stats: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>;
metering_quota_uuid: ZodOptional<ZodNullable<ZodString>>;
counted_towards_quota: ZodOptional<ZodString>;
invocation_id: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>, "many">;
}, ZodTypeAny, "passthrough">>;
Defined in: src/red-team/scans-client.ts:102
List red team scan jobs with optional filters.
Parameters
| Parameter | Type | Description |
|---|---|---|
opts? | RedTeamScanListOptions | 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;
name: ZodString;
target: ZodObject<{
adapter_uuid: ZodOptional<ZodUnion<[..., ...]>>;
canonical_id: ZodOptional<ZodUnion<[..., ...]>>;
adapter_secret_version: ZodOptional<ZodUnion<[..., ...]>>;
profiling_progress: ZodOptional<ZodUnion<[..., ...]>>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<ZodNullable<ZodString>>;
target_type: ZodOptional<ZodNullable<ZodString>>;
connection_type: ZodOptional<ZodNullable<ZodString>>;
api_endpoint_type: ZodOptional<ZodNullable<ZodString>>;
response_mode: ZodOptional<ZodNullable<ZodString>>;
session_supported: ZodOptional<ZodBoolean>;
extra_info: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<ZodNullable<ZodNumber>>;
secret_version: ZodOptional<ZodNullable<ZodString>>;
created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
updated_by_user_id: ZodOptional<ZodNullable<ZodString>>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<ZodObject<{
supports_multimodal_files: ...;
supports_multimodal_files_error_message: ...;
multi_turn: ...;
multi_turn_error_message: ...;
rate_limit: ...;
rate_limit_enabled: ...;
rate_limit_error_code: ...;
rate_limit_error_json: ...;
rate_limit_error_message: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_json: ...;
content_filter_error_message: ...;
probe_message: ...;
request_timeout: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>;
target_background: ZodOptional<ZodNullable<ZodObject<..., ..., ..., ..., ...>>>;
profiling_status: ZodOptional<ZodNullable<ZodString>>;
additional_context: ZodOptional<ZodNullable<ZodObject<..., ..., ..., ..., ...>>>;
auth_type: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
adapter_uuid: ZodOptional<ZodUnion<...>>;
canonical_id: ZodOptional<ZodUnion<...>>;
adapter_secret_version: ZodOptional<ZodUnion<...>>;
profiling_progress: ZodOptional<ZodUnion<...>>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<ZodNullable<...>>;
target_type: ZodOptional<ZodNullable<...>>;
connection_type: ZodOptional<ZodNullable<...>>;
api_endpoint_type: ZodOptional<ZodNullable<...>>;
response_mode: ZodOptional<ZodNullable<...>>;
session_supported: ZodOptional<ZodBoolean>;
extra_info: ZodOptional<ZodNullable<...>>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<ZodNullable<...>>;
secret_version: ZodOptional<ZodNullable<...>>;
created_by_user_id: ZodOptional<ZodNullable<...>>;
updated_by_user_id: ZodOptional<ZodNullable<...>>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<ZodObject<..., ..., ..., ..., ...>>;
target_background: ZodOptional<ZodNullable<...>>;
profiling_status: ZodOptional<ZodNullable<...>>;
additional_context: ZodOptional<ZodNullable<...>>;
auth_type: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
adapter_uuid: ZodOptional<ZodUnion<...>>;
canonical_id: ZodOptional<ZodUnion<...>>;
adapter_secret_version: ZodOptional<ZodUnion<...>>;
profiling_progress: ZodOptional<ZodUnion<...>>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<ZodNullable<...>>;
target_type: ZodOptional<ZodNullable<...>>;
connection_type: ZodOptional<ZodNullable<...>>;
api_endpoint_type: ZodOptional<ZodNullable<...>>;
response_mode: ZodOptional<ZodNullable<...>>;
session_supported: ZodOptional<ZodBoolean>;
extra_info: ZodOptional<ZodNullable<...>>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<ZodNullable<...>>;
secret_version: ZodOptional<ZodNullable<...>>;
created_by_user_id: ZodOptional<ZodNullable<...>>;
updated_by_user_id: ZodOptional<ZodNullable<...>>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<ZodObject<..., ..., ..., ..., ...>>;
target_background: ZodOptional<ZodNullable<...>>;
profiling_status: ZodOptional<ZodNullable<...>>;
additional_context: ZodOptional<ZodNullable<...>>;
auth_type: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">>;
job_type: ZodString;
job_metadata: ZodUnion<[ZodObject<{
language: ZodOptional<...>;
include_file_attacks: ZodOptional<...>;
categories: ZodRecord<..., ...>;
rate_limit_enabled: ZodOptional<...>;
rate_limit: ZodOptional<...>;
rate_limit_error_code: ZodOptional<...>;
rate_limit_error_message: ZodOptional<...>;
rate_limit_error_json: ZodOptional<...>;
content_filter_enabled: ZodOptional<...>;
content_filter_error_code: ZodOptional<...>;
content_filter_error_message: ZodOptional<...>;
content_filter_error_json: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
language: ...;
include_file_attacks: ...;
categories: ...;
rate_limit_enabled: ...;
rate_limit: ...;
rate_limit_error_code: ...;
rate_limit_error_message: ...;
rate_limit_error_json: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_message: ...;
content_filter_error_json: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
language: ...;
include_file_attacks: ...;
categories: ...;
rate_limit_enabled: ...;
rate_limit: ...;
rate_limit_error_code: ...;
rate_limit_error_message: ...;
rate_limit_error_json: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_message: ...;
content_filter_error_json: ...;
}, ZodTypeAny, "passthrough">>, ZodObject<{
language: ZodOptional<...>;
goal_categories: ZodOptional<...>;
rate_limit_enabled: ZodOptional<...>;
rate_limit: ZodOptional<...>;
rate_limit_error_code: ZodOptional<...>;
rate_limit_error_message: ZodOptional<...>;
rate_limit_error_json: ZodOptional<...>;
content_filter_enabled: ZodOptional<...>;
content_filter_error_code: ZodOptional<...>;
content_filter_error_message: ZodOptional<...>;
content_filter_error_json: ZodOptional<...>;
stream_breadth: ZodOptional<...>;
stream_depth: ZodOptional<...>;
max_tokens: ZodOptional<...>;
context_size: ZodOptional<...>;
attack_goals: ZodOptional<...>;
base_model: ZodOptional<...>;
use_case: ZodOptional<...>;
system_prompt: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
language: ...;
goal_categories: ...;
rate_limit_enabled: ...;
rate_limit: ...;
rate_limit_error_code: ...;
rate_limit_error_message: ...;
rate_limit_error_json: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_message: ...;
content_filter_error_json: ...;
stream_breadth: ...;
stream_depth: ...;
max_tokens: ...;
context_size: ...;
attack_goals: ...;
base_model: ...;
use_case: ...;
system_prompt: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
language: ...;
goal_categories: ...;
rate_limit_enabled: ...;
rate_limit: ...;
rate_limit_error_code: ...;
rate_limit_error_message: ...;
rate_limit_error_json: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_message: ...;
content_filter_error_json: ...;
stream_breadth: ...;
stream_depth: ...;
max_tokens: ...;
context_size: ...;
attack_goals: ...;
base_model: ...;
use_case: ...;
system_prompt: ...;
}, ZodTypeAny, "passthrough">>, ZodObject<{
language: ZodOptional<...>;
custom_prompt_sets: ZodArray<..., ...>;
rate_limit_enabled: ZodOptional<...>;
rate_limit: ZodOptional<...>;
rate_limit_error_code: ZodOptional<...>;
rate_limit_error_message: ZodOptional<...>;
rate_limit_error_json: ZodOptional<...>;
content_filter_enabled: ZodOptional<...>;
content_filter_error_code: ZodOptional<...>;
content_filter_error_message: ZodOptional<...>;
content_filter_error_json: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
language: ...;
custom_prompt_sets: ...;
rate_limit_enabled: ...;
rate_limit: ...;
rate_limit_error_code: ...;
rate_limit_error_message: ...;
rate_limit_error_json: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_message: ...;
content_filter_error_json: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
language: ...;
custom_prompt_sets: ...;
rate_limit_enabled: ...;
rate_limit: ...;
rate_limit_error_code: ...;
rate_limit_error_message: ...;
rate_limit_error_json: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_message: ...;
content_filter_error_json: ...;
}, ZodTypeAny, "passthrough">>, ZodObject<{
scan_name: ZodString;
categories: ZodOptional<...>;
language: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
scan_name: ...;
categories: ...;
language: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
scan_name: ...;
categories: ...;
language: ...;
}, ZodTypeAny, "passthrough">>]>;
version: ZodOptional<ZodNullable<ZodNumber>>;
extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
target_id: ZodString;
target_type: ZodString;
total: ZodOptional<ZodNullable<ZodNumber>>;
completed: ZodOptional<ZodNullable<ZodNumber>>;
status: ZodOptional<ZodString>;
score: ZodOptional<ZodNullable<ZodNumber>>;
asr: ZodOptional<ZodNullable<ZodNumber>>;
time_record: ZodOptional<ZodNullable<ZodObject<{
queued_at: ZodOptional<...>;
started_at: ZodOptional<...>;
completed_at: ZodOptional<...>;
time_taken: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
queued_at: ...;
started_at: ...;
completed_at: ...;
time_taken: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
queued_at: ...;
started_at: ...;
completed_at: ...;
time_taken: ...;
}, ZodTypeAny, "passthrough">>>>;
created_at: ZodOptional<ZodNullable<ZodString>>;
updated_at: ZodOptional<ZodNullable<ZodString>>;
created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
report_stats: ZodOptional<ZodNullable<ZodUnion<[ZodObject<..., ..., ..., ..., ...>, ZodObject<..., ..., ..., ..., ...>]>>>;
metering_quota_uuid: ZodOptional<ZodNullable<ZodString>>;
counted_towards_quota: ZodOptional<ZodString>;
invocation_id: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
target: ZodObject<{
adapter_uuid: ZodOptional<ZodUnion<...>>;
canonical_id: ZodOptional<ZodUnion<...>>;
adapter_secret_version: ZodOptional<ZodUnion<...>>;
profiling_progress: ZodOptional<ZodUnion<...>>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<ZodNullable<...>>;
target_type: ZodOptional<ZodNullable<...>>;
connection_type: ZodOptional<ZodNullable<...>>;
api_endpoint_type: ZodOptional<ZodNullable<...>>;
response_mode: ZodOptional<ZodNullable<...>>;
session_supported: ZodOptional<ZodBoolean>;
extra_info: ZodOptional<ZodNullable<...>>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<ZodNullable<...>>;
secret_version: ZodOptional<ZodNullable<...>>;
created_by_user_id: ZodOptional<ZodNullable<...>>;
updated_by_user_id: ZodOptional<ZodNullable<...>>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<ZodObject<..., ..., ..., ..., ...>>;
target_background: ZodOptional<ZodNullable<...>>;
profiling_status: ZodOptional<ZodNullable<...>>;
additional_context: ZodOptional<ZodNullable<...>>;
auth_type: ZodOptional<ZodNullable<...>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
adapter_uuid: ZodOptional<...>;
canonical_id: ZodOptional<...>;
adapter_secret_version: ZodOptional<...>;
profiling_progress: ZodOptional<...>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<...>;
target_type: ZodOptional<...>;
connection_type: ZodOptional<...>;
api_endpoint_type: ZodOptional<...>;
response_mode: ZodOptional<...>;
session_supported: ZodOptional<...>;
extra_info: ZodOptional<...>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<...>;
secret_version: ZodOptional<...>;
created_by_user_id: ZodOptional<...>;
updated_by_user_id: ZodOptional<...>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<...>;
target_background: ZodOptional<...>;
profiling_status: ZodOptional<...>;
additional_context: ZodOptional<...>;
auth_type: ZodOptional<...>;
}, ZodTypeAny, "passthrough">, objectInputType<{
adapter_uuid: ZodOptional<...>;
canonical_id: ZodOptional<...>;
adapter_secret_version: ZodOptional<...>;
profiling_progress: ZodOptional<...>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<...>;
target_type: ZodOptional<...>;
connection_type: ZodOptional<...>;
api_endpoint_type: ZodOptional<...>;
response_mode: ZodOptional<...>;
session_supported: ZodOptional<...>;
extra_info: ZodOptional<...>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<...>;
secret_version: ZodOptional<...>;
created_by_user_id: ZodOptional<...>;
updated_by_user_id: ZodOptional<...>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<...>;
target_background: ZodOptional<...>;
profiling_status: ZodOptional<...>;
additional_context: ZodOptional<...>;
auth_type: ZodOptional<...>;
}, ZodTypeAny, "passthrough">>;
job_type: ZodString;
job_metadata: ZodUnion<[ZodObject<{
language: ...;
include_file_attacks: ...;
categories: ...;
rate_limit_enabled: ...;
rate_limit: ...;
rate_limit_error_code: ...;
rate_limit_error_message: ...;
rate_limit_error_json: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_message: ...;
content_filter_error_json: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, ZodObject<{
language: ...;
goal_categories: ...;
rate_limit_enabled: ...;
rate_limit: ...;
rate_limit_error_code: ...;
rate_limit_error_message: ...;
rate_limit_error_json: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_message: ...;
content_filter_error_json: ...;
stream_breadth: ...;
stream_depth: ...;
max_tokens: ...;
context_size: ...;
attack_goals: ...;
base_model: ...;
use_case: ...;
system_prompt: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, ZodObject<{
language: ...;
custom_prompt_sets: ...;
rate_limit_enabled: ...;
rate_limit: ...;
rate_limit_error_code: ...;
rate_limit_error_message: ...;
rate_limit_error_json: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_message: ...;
content_filter_error_json: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, ZodObject<{
scan_name: ...;
categories: ...;
language: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>]>;
version: ZodOptional<ZodNullable<ZodNumber>>;
extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
target_id: ZodString;
target_type: ZodString;
total: ZodOptional<ZodNullable<ZodNumber>>;
completed: ZodOptional<ZodNullable<ZodNumber>>;
status: ZodOptional<ZodString>;
score: ZodOptional<ZodNullable<ZodNumber>>;
asr: ZodOptional<ZodNullable<ZodNumber>>;
time_record: ZodOptional<ZodNullable<ZodObject<{
queued_at: ...;
started_at: ...;
completed_at: ...;
time_taken: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
created_at: ZodOptional<ZodNullable<ZodString>>;
updated_at: ZodOptional<ZodNullable<ZodString>>;
created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
report_stats: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>;
metering_quota_uuid: ZodOptional<ZodNullable<ZodString>>;
counted_towards_quota: ZodOptional<ZodString>;
invocation_id: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
target: ZodObject<{
adapter_uuid: ZodOptional<ZodUnion<...>>;
canonical_id: ZodOptional<ZodUnion<...>>;
adapter_secret_version: ZodOptional<ZodUnion<...>>;
profiling_progress: ZodOptional<ZodUnion<...>>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<ZodNullable<...>>;
target_type: ZodOptional<ZodNullable<...>>;
connection_type: ZodOptional<ZodNullable<...>>;
api_endpoint_type: ZodOptional<ZodNullable<...>>;
response_mode: ZodOptional<ZodNullable<...>>;
session_supported: ZodOptional<ZodBoolean>;
extra_info: ZodOptional<ZodNullable<...>>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<ZodNullable<...>>;
secret_version: ZodOptional<ZodNullable<...>>;
created_by_user_id: ZodOptional<ZodNullable<...>>;
updated_by_user_id: ZodOptional<ZodNullable<...>>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<ZodObject<..., ..., ..., ..., ...>>;
target_background: ZodOptional<ZodNullable<...>>;
profiling_status: ZodOptional<ZodNullable<...>>;
additional_context: ZodOptional<ZodNullable<...>>;
auth_type: ZodOptional<ZodNullable<...>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
adapter_uuid: ZodOptional<...>;
canonical_id: ZodOptional<...>;
adapter_secret_version: ZodOptional<...>;
profiling_progress: ZodOptional<...>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<...>;
target_type: ZodOptional<...>;
connection_type: ZodOptional<...>;
api_endpoint_type: ZodOptional<...>;
response_mode: ZodOptional<...>;
session_supported: ZodOptional<...>;
extra_info: ZodOptional<...>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<...>;
secret_version: ZodOptional<...>;
created_by_user_id: ZodOptional<...>;
updated_by_user_id: ZodOptional<...>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<...>;
target_background: ZodOptional<...>;
profiling_status: ZodOptional<...>;
additional_context: ZodOptional<...>;
auth_type: ZodOptional<...>;
}, ZodTypeAny, "passthrough">, objectInputType<{
adapter_uuid: ZodOptional<...>;
canonical_id: ZodOptional<...>;
adapter_secret_version: ZodOptional<...>;
profiling_progress: ZodOptional<...>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<...>;
target_type: ZodOptional<...>;
connection_type: ZodOptional<...>;
api_endpoint_type: ZodOptional<...>;
response_mode: ZodOptional<...>;
session_supported: ZodOptional<...>;
extra_info: ZodOptional<...>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<...>;
secret_version: ZodOptional<...>;
created_by_user_id: ZodOptional<...>;
updated_by_user_id: ZodOptional<...>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<...>;
target_background: ZodOptional<...>;
profiling_status: ZodOptional<...>;
additional_context: ZodOptional<...>;
auth_type: ZodOptional<...>;
}, ZodTypeAny, "passthrough">>;
job_type: ZodString;
job_metadata: ZodUnion<[ZodObject<{
language: ...;
include_file_attacks: ...;
categories: ...;
rate_limit_enabled: ...;
rate_limit: ...;
rate_limit_error_code: ...;
rate_limit_error_message: ...;
rate_limit_error_json: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_message: ...;
content_filter_error_json: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, ZodObject<{
language: ...;
goal_categories: ...;
rate_limit_enabled: ...;
rate_limit: ...;
rate_limit_error_code: ...;
rate_limit_error_message: ...;
rate_limit_error_json: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_message: ...;
content_filter_error_json: ...;
stream_breadth: ...;
stream_depth: ...;
max_tokens: ...;
context_size: ...;
attack_goals: ...;
base_model: ...;
use_case: ...;
system_prompt: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, ZodObject<{
language: ...;
custom_prompt_sets: ...;
rate_limit_enabled: ...;
rate_limit: ...;
rate_limit_error_code: ...;
rate_limit_error_message: ...;
rate_limit_error_json: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_message: ...;
content_filter_error_json: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, ZodObject<{
scan_name: ...;
categories: ...;
language: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>]>;
version: ZodOptional<ZodNullable<ZodNumber>>;
extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
target_id: ZodString;
target_type: ZodString;
total: ZodOptional<ZodNullable<ZodNumber>>;
completed: ZodOptional<ZodNullable<ZodNumber>>;
status: ZodOptional<ZodString>;
score: ZodOptional<ZodNullable<ZodNumber>>;
asr: ZodOptional<ZodNullable<ZodNumber>>;
time_record: ZodOptional<ZodNullable<ZodObject<{
queued_at: ...;
started_at: ...;
completed_at: ...;
time_taken: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
created_at: ZodOptional<ZodNullable<ZodString>>;
updated_at: ZodOptional<ZodNullable<ZodString>>;
created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
report_stats: ZodOptional<ZodNullable<ZodUnion<[..., ...]>>>;
metering_quota_uuid: ZodOptional<ZodNullable<ZodString>>;
counted_towards_quota: ZodOptional<ZodString>;
invocation_id: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>, "many">;
}, ZodTypeAny, "passthrough">>
The paginated list of scan jobs.
Example
import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();
const scans = await rt.scans.list({ limit: 5, status: 'COMPLETED' });
// scans =>
// { pagination: { total_items: 12 }, data: [{ uuid: '550e8400-...', name: 'job', status: 'COMPLETED', job_type: 'STATIC' }] }
listAll()
listAll(opts?): Promise<objectOutputType<{
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
target: ZodObject<{
adapter_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
canonical_id: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
adapter_secret_version: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
profiling_progress: ZodOptional<ZodUnion<[ZodNumber, ZodNull]>>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<ZodNullable<ZodString>>;
target_type: ZodOptional<ZodNullable<ZodString>>;
connection_type: ZodOptional<ZodNullable<ZodString>>;
api_endpoint_type: ZodOptional<ZodNullable<ZodString>>;
response_mode: ZodOptional<ZodNullable<ZodString>>;
session_supported: ZodOptional<ZodBoolean>;
extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<ZodNullable<ZodNumber>>;
secret_version: ZodOptional<ZodNullable<ZodString>>;
created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
updated_by_user_id: ZodOptional<ZodNullable<ZodString>>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<ZodObject<{
supports_multimodal_files: ZodOptional<ZodBoolean>;
supports_multimodal_files_error_message: ZodOptional<ZodUnion<...>>;
multi_turn: ZodOptional<ZodBoolean>;
multi_turn_error_message: ZodOptional<ZodNullable<...>>;
rate_limit: ZodOptional<ZodNullable<...>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit_error_code: ZodOptional<ZodNullable<...>>;
rate_limit_error_json: ZodOptional<ZodNullable<...>>;
rate_limit_error_message: ZodOptional<ZodNullable<...>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<...>>;
content_filter_error_json: ZodOptional<ZodNullable<...>>;
content_filter_error_message: ZodOptional<ZodNullable<...>>;
probe_message: ZodOptional<ZodString>;
request_timeout: ZodOptional<ZodNumber>;
}, "passthrough", ZodTypeAny, objectOutputType<{
supports_multimodal_files: ZodOptional<...>;
supports_multimodal_files_error_message: ZodOptional<...>;
multi_turn: ZodOptional<...>;
multi_turn_error_message: ZodOptional<...>;
rate_limit: ZodOptional<...>;
rate_limit_enabled: ZodOptional<...>;
rate_limit_error_code: ZodOptional<...>;
rate_limit_error_json: ZodOptional<...>;
rate_limit_error_message: ZodOptional<...>;
content_filter_enabled: ZodOptional<...>;
content_filter_error_code: ZodOptional<...>;
content_filter_error_json: ZodOptional<...>;
content_filter_error_message: ZodOptional<...>;
probe_message: ZodOptional<...>;
request_timeout: ZodOptional<...>;
}, ZodTypeAny, "passthrough">, objectInputType<{
supports_multimodal_files: ZodOptional<...>;
supports_multimodal_files_error_message: ZodOptional<...>;
multi_turn: ZodOptional<...>;
multi_turn_error_message: ZodOptional<...>;
rate_limit: ZodOptional<...>;
rate_limit_enabled: ZodOptional<...>;
rate_limit_error_code: ZodOptional<...>;
rate_limit_error_json: ZodOptional<...>;
rate_limit_error_message: ZodOptional<...>;
content_filter_enabled: ZodOptional<...>;
content_filter_error_code: ZodOptional<...>;
content_filter_error_json: ZodOptional<...>;
content_filter_error_message: ZodOptional<...>;
probe_message: ZodOptional<...>;
request_timeout: ZodOptional<...>;
}, ZodTypeAny, "passthrough">>>;
target_background: ZodOptional<ZodNullable<ZodObject<{
agentic_profiling_enabled: ZodOptional<...>;
industry: ZodOptional<...>;
use_case: ZodOptional<...>;
competitors: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
agentic_profiling_enabled: ...;
industry: ...;
use_case: ...;
competitors: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
agentic_profiling_enabled: ...;
industry: ...;
use_case: ...;
competitors: ...;
}, ZodTypeAny, "passthrough">>>>;
profiling_status: ZodOptional<ZodNullable<ZodString>>;
additional_context: ZodOptional<ZodNullable<ZodObject<{
base_model: ZodOptional<...>;
core_architecture: ZodOptional<...>;
system_prompt: ZodOptional<...>;
languages_supported: ZodOptional<...>;
banned_keywords: ZodOptional<...>;
tools_accessible: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
base_model: ...;
core_architecture: ...;
system_prompt: ...;
languages_supported: ...;
banned_keywords: ...;
tools_accessible: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
base_model: ...;
core_architecture: ...;
system_prompt: ...;
languages_supported: ...;
banned_keywords: ...;
tools_accessible: ...;
}, ZodTypeAny, "passthrough">>>>;
auth_type: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
adapter_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
canonical_id: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
adapter_secret_version: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
profiling_progress: ZodOptional<ZodUnion<[ZodNumber, ZodNull]>>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<ZodNullable<ZodString>>;
target_type: ZodOptional<ZodNullable<ZodString>>;
connection_type: ZodOptional<ZodNullable<ZodString>>;
api_endpoint_type: ZodOptional<ZodNullable<ZodString>>;
response_mode: ZodOptional<ZodNullable<ZodString>>;
session_supported: ZodOptional<ZodBoolean>;
extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<ZodNullable<ZodNumber>>;
secret_version: ZodOptional<ZodNullable<ZodString>>;
created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
updated_by_user_id: ZodOptional<ZodNullable<ZodString>>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<ZodObject<{
supports_multimodal_files: ZodOptional<...>;
supports_multimodal_files_error_message: ZodOptional<...>;
multi_turn: ZodOptional<...>;
multi_turn_error_message: ZodOptional<...>;
rate_limit: ZodOptional<...>;
rate_limit_enabled: ZodOptional<...>;
rate_limit_error_code: ZodOptional<...>;
rate_limit_error_json: ZodOptional<...>;
rate_limit_error_message: ZodOptional<...>;
content_filter_enabled: ZodOptional<...>;
content_filter_error_code: ZodOptional<...>;
content_filter_error_json: ZodOptional<...>;
content_filter_error_message: ZodOptional<...>;
probe_message: ZodOptional<...>;
request_timeout: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
supports_multimodal_files: ...;
supports_multimodal_files_error_message: ...;
multi_turn: ...;
multi_turn_error_message: ...;
rate_limit: ...;
rate_limit_enabled: ...;
rate_limit_error_code: ...;
rate_limit_error_json: ...;
rate_limit_error_message: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_json: ...;
content_filter_error_message: ...;
probe_message: ...;
request_timeout: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
supports_multimodal_files: ...;
supports_multimodal_files_error_message: ...;
multi_turn: ...;
multi_turn_error_message: ...;
rate_limit: ...;
rate_limit_enabled: ...;
rate_limit_error_code: ...;
rate_limit_error_json: ...;
rate_limit_error_message: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_json: ...;
content_filter_error_message: ...;
probe_message: ...;
request_timeout: ...;
}, ZodTypeAny, "passthrough">>>;
target_background: ZodOptional<ZodNullable<ZodObject<{
agentic_profiling_enabled: ...;
industry: ...;
use_case: ...;
competitors: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
profiling_status: ZodOptional<ZodNullable<ZodString>>;
additional_context: ZodOptional<ZodNullable<ZodObject<{
base_model: ...;
core_architecture: ...;
system_prompt: ...;
languages_supported: ...;
banned_keywords: ...;
tools_accessible: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
auth_type: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
adapter_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
canonical_id: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
adapter_secret_version: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
profiling_progress: ZodOptional<ZodUnion<[ZodNumber, ZodNull]>>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<ZodNullable<ZodString>>;
target_type: ZodOptional<ZodNullable<ZodString>>;
connection_type: ZodOptional<ZodNullable<ZodString>>;
api_endpoint_type: ZodOptional<ZodNullable<ZodString>>;
response_mode: ZodOptional<ZodNullable<ZodString>>;
session_supported: ZodOptional<ZodBoolean>;
extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<ZodNullable<ZodNumber>>;
secret_version: ZodOptional<ZodNullable<ZodString>>;
created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
updated_by_user_id: ZodOptional<ZodNullable<ZodString>>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<ZodObject<{
supports_multimodal_files: ZodOptional<...>;
supports_multimodal_files_error_message: ZodOptional<...>;
multi_turn: ZodOptional<...>;
multi_turn_error_message: ZodOptional<...>;
rate_limit: ZodOptional<...>;
rate_limit_enabled: ZodOptional<...>;
rate_limit_error_code: ZodOptional<...>;
rate_limit_error_json: ZodOptional<...>;
rate_limit_error_message: ZodOptional<...>;
content_filter_enabled: ZodOptional<...>;
content_filter_error_code: ZodOptional<...>;
content_filter_error_json: ZodOptional<...>;
content_filter_error_message: ZodOptional<...>;
probe_message: ZodOptional<...>;
request_timeout: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
supports_multimodal_files: ...;
supports_multimodal_files_error_message: ...;
multi_turn: ...;
multi_turn_error_message: ...;
rate_limit: ...;
rate_limit_enabled: ...;
rate_limit_error_code: ...;
rate_limit_error_json: ...;
rate_limit_error_message: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_json: ...;
content_filter_error_message: ...;
probe_message: ...;
request_timeout: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
supports_multimodal_files: ...;
supports_multimodal_files_error_message: ...;
multi_turn: ...;
multi_turn_error_message: ...;
rate_limit: ...;
rate_limit_enabled: ...;
rate_limit_error_code: ...;
rate_limit_error_json: ...;
rate_limit_error_message: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_json: ...;
content_filter_error_message: ...;
probe_message: ...;
request_timeout: ...;
}, ZodTypeAny, "passthrough">>>;
target_background: ZodOptional<ZodNullable<ZodObject<{
agentic_profiling_enabled: ...;
industry: ...;
use_case: ...;
competitors: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
profiling_status: ZodOptional<ZodNullable<ZodString>>;
additional_context: ZodOptional<ZodNullable<ZodObject<{
base_model: ...;
core_architecture: ...;
system_prompt: ...;
languages_supported: ...;
banned_keywords: ...;
tools_accessible: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
auth_type: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>;
job_type: ZodString;
job_metadata: ZodUnion<[ZodObject<{
language: ZodOptional<ZodNullable<ZodLazy<...>>>;
include_file_attacks: ZodOptional<ZodBoolean>;
categories: ZodRecord<ZodString, ZodUnknown>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
language: ZodOptional<ZodNullable<...>>;
include_file_attacks: ZodOptional<ZodBoolean>;
categories: ZodRecord<ZodString, ZodUnknown>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<...>>;
rate_limit_error_code: ZodOptional<ZodNullable<...>>;
rate_limit_error_message: ZodOptional<ZodNullable<...>>;
rate_limit_error_json: ZodOptional<ZodNullable<...>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<...>>;
content_filter_error_message: ZodOptional<ZodNullable<...>>;
content_filter_error_json: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
language: ZodOptional<ZodNullable<...>>;
include_file_attacks: ZodOptional<ZodBoolean>;
categories: ZodRecord<ZodString, ZodUnknown>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<...>>;
rate_limit_error_code: ZodOptional<ZodNullable<...>>;
rate_limit_error_message: ZodOptional<ZodNullable<...>>;
rate_limit_error_json: ZodOptional<ZodNullable<...>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<...>>;
content_filter_error_message: ZodOptional<ZodNullable<...>>;
content_filter_error_json: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">>, ZodObject<{
language: ZodOptional<ZodNullable<ZodLazy<...>>>;
goal_categories: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
stream_breadth: ZodOptional<ZodNumber>;
stream_depth: ZodOptional<ZodNumber>;
max_tokens: ZodOptional<ZodNumber>;
context_size: ZodOptional<ZodNumber>;
attack_goals: ZodOptional<ZodArray<ZodString, "many">>;
base_model: ZodOptional<ZodNullable<ZodString>>;
use_case: ZodOptional<ZodNullable<ZodString>>;
system_prompt: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
language: ZodOptional<ZodNullable<...>>;
goal_categories: ZodOptional<ZodNullable<...>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<...>>;
rate_limit_error_code: ZodOptional<ZodNullable<...>>;
rate_limit_error_message: ZodOptional<ZodNullable<...>>;
rate_limit_error_json: ZodOptional<ZodNullable<...>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<...>>;
content_filter_error_message: ZodOptional<ZodNullable<...>>;
content_filter_error_json: ZodOptional<ZodNullable<...>>;
stream_breadth: ZodOptional<ZodNumber>;
stream_depth: ZodOptional<ZodNumber>;
max_tokens: ZodOptional<ZodNumber>;
context_size: ZodOptional<ZodNumber>;
attack_goals: ZodOptional<ZodArray<..., ...>>;
base_model: ZodOptional<ZodNullable<...>>;
use_case: ZodOptional<ZodNullable<...>>;
system_prompt: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
language: ZodOptional<ZodNullable<...>>;
goal_categories: ZodOptional<ZodNullable<...>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<...>>;
rate_limit_error_code: ZodOptional<ZodNullable<...>>;
rate_limit_error_message: ZodOptional<ZodNullable<...>>;
rate_limit_error_json: ZodOptional<ZodNullable<...>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<...>>;
content_filter_error_message: ZodOptional<ZodNullable<...>>;
content_filter_error_json: ZodOptional<ZodNullable<...>>;
stream_breadth: ZodOptional<ZodNumber>;
stream_depth: ZodOptional<ZodNumber>;
max_tokens: ZodOptional<ZodNumber>;
context_size: ZodOptional<ZodNumber>;
attack_goals: ZodOptional<ZodArray<..., ...>>;
base_model: ZodOptional<ZodNullable<...>>;
use_case: ZodOptional<ZodNullable<...>>;
system_prompt: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">>, ZodObject<{
language: ZodOptional<ZodNullable<ZodLazy<...>>>;
custom_prompt_sets: ZodArray<ZodString, "many">;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
language: ZodOptional<ZodNullable<...>>;
custom_prompt_sets: ZodArray<ZodString, "many">;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<...>>;
rate_limit_error_code: ZodOptional<ZodNullable<...>>;
rate_limit_error_message: ZodOptional<ZodNullable<...>>;
rate_limit_error_json: ZodOptional<ZodNullable<...>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<...>>;
content_filter_error_message: ZodOptional<ZodNullable<...>>;
content_filter_error_json: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
language: ZodOptional<ZodNullable<...>>;
custom_prompt_sets: ZodArray<ZodString, "many">;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<...>>;
rate_limit_error_code: ZodOptional<ZodNullable<...>>;
rate_limit_error_message: ZodOptional<ZodNullable<...>>;
rate_limit_error_json: ZodOptional<ZodNullable<...>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<...>>;
content_filter_error_message: ZodOptional<ZodNullable<...>>;
content_filter_error_json: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">>, ZodObject<{
scan_name: ZodString;
categories: ZodOptional<ZodRecord<ZodString, ZodArray<..., ...>>>;
language: ZodOptional<ZodNull>;
}, "passthrough", ZodTypeAny, objectOutputType<{
scan_name: ZodString;
categories: ZodOptional<ZodRecord<..., ...>>;
language: ZodOptional<ZodNull>;
}, ZodTypeAny, "passthrough">, objectInputType<{
scan_name: ZodString;
categories: ZodOptional<ZodRecord<..., ...>>;
language: ZodOptional<ZodNull>;
}, ZodTypeAny, "passthrough">>]>;
version: ZodOptional<ZodNullable<ZodNumber>>;
extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
target_id: ZodString;
target_type: ZodString;
total: ZodOptional<ZodNullable<ZodNumber>>;
completed: ZodOptional<ZodNullable<ZodNumber>>;
status: ZodOptional<ZodString>;
score: ZodOptional<ZodNullable<ZodNumber>>;
asr: ZodOptional<ZodNullable<ZodNumber>>;
time_record: ZodOptional<ZodNullable<ZodObject<{
queued_at: ZodOptional<ZodNullable<ZodString>>;
started_at: ZodOptional<ZodNullable<ZodString>>;
completed_at: ZodOptional<ZodNullable<ZodString>>;
time_taken: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
queued_at: ZodOptional<ZodNullable<...>>;
started_at: ZodOptional<ZodNullable<...>>;
completed_at: ZodOptional<ZodNullable<...>>;
time_taken: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
queued_at: ZodOptional<ZodNullable<...>>;
started_at: ZodOptional<ZodNullable<...>>;
completed_at: ZodOptional<ZodNullable<...>>;
time_taken: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">>>>;
created_at: ZodOptional<ZodNullable<ZodString>>;
updated_at: ZodOptional<ZodNullable<ZodString>>;
created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
report_stats: ZodOptional<ZodNullable<ZodUnion<[ZodObject<{
output_completion_percentage: ZodNumber;
partial_report_unlocked: ZodOptional<...>;
partial_report_unlocked_at: ZodOptional<...>;
report_summary: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
output_completion_percentage: ...;
partial_report_unlocked: ...;
partial_report_unlocked_at: ...;
report_summary: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
output_completion_percentage: ...;
partial_report_unlocked: ...;
partial_report_unlocked_at: ...;
report_summary: ...;
}, ZodTypeAny, "passthrough">>, ZodObject<{
total_goals: ZodOptional<...>;
total_streams: ZodOptional<...>;
total_threats: ZodOptional<...>;
goals_achieved: ZodOptional<...>;
report_summary: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
total_goals: ...;
total_streams: ...;
total_threats: ...;
goals_achieved: ...;
report_summary: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
total_goals: ...;
total_streams: ...;
total_threats: ...;
goals_achieved: ...;
report_summary: ...;
}, ZodTypeAny, "passthrough">>]>>>;
metering_quota_uuid: ZodOptional<ZodNullable<ZodString>>;
counted_towards_quota: ZodOptional<ZodString>;
invocation_id: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">[]>;
Defined in: src/red-team/scans-client.ts:120
List every scan page.
Parameters
| Parameter | Type |
|---|---|
opts | RedTeamScanListAllOptions |
Returns
Promise<objectOutputType<{
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
target: ZodObject<{
adapter_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
canonical_id: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
adapter_secret_version: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
profiling_progress: ZodOptional<ZodUnion<[ZodNumber, ZodNull]>>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<ZodNullable<ZodString>>;
target_type: ZodOptional<ZodNullable<ZodString>>;
connection_type: ZodOptional<ZodNullable<ZodString>>;
api_endpoint_type: ZodOptional<ZodNullable<ZodString>>;
response_mode: ZodOptional<ZodNullable<ZodString>>;
session_supported: ZodOptional<ZodBoolean>;
extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<ZodNullable<ZodNumber>>;
secret_version: ZodOptional<ZodNullable<ZodString>>;
created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
updated_by_user_id: ZodOptional<ZodNullable<ZodString>>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<ZodObject<{
supports_multimodal_files: ZodOptional<ZodBoolean>;
supports_multimodal_files_error_message: ZodOptional<ZodUnion<...>>;
multi_turn: ZodOptional<ZodBoolean>;
multi_turn_error_message: ZodOptional<ZodNullable<...>>;
rate_limit: ZodOptional<ZodNullable<...>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit_error_code: ZodOptional<ZodNullable<...>>;
rate_limit_error_json: ZodOptional<ZodNullable<...>>;
rate_limit_error_message: ZodOptional<ZodNullable<...>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<...>>;
content_filter_error_json: ZodOptional<ZodNullable<...>>;
content_filter_error_message: ZodOptional<ZodNullable<...>>;
probe_message: ZodOptional<ZodString>;
request_timeout: ZodOptional<ZodNumber>;
}, "passthrough", ZodTypeAny, objectOutputType<{
supports_multimodal_files: ZodOptional<...>;
supports_multimodal_files_error_message: ZodOptional<...>;
multi_turn: ZodOptional<...>;
multi_turn_error_message: ZodOptional<...>;
rate_limit: ZodOptional<...>;
rate_limit_enabled: ZodOptional<...>;
rate_limit_error_code: ZodOptional<...>;
rate_limit_error_json: ZodOptional<...>;
rate_limit_error_message: ZodOptional<...>;
content_filter_enabled: ZodOptional<...>;
content_filter_error_code: ZodOptional<...>;
content_filter_error_json: ZodOptional<...>;
content_filter_error_message: ZodOptional<...>;
probe_message: ZodOptional<...>;
request_timeout: ZodOptional<...>;
}, ZodTypeAny, "passthrough">, objectInputType<{
supports_multimodal_files: ZodOptional<...>;
supports_multimodal_files_error_message: ZodOptional<...>;
multi_turn: ZodOptional<...>;
multi_turn_error_message: ZodOptional<...>;
rate_limit: ZodOptional<...>;
rate_limit_enabled: ZodOptional<...>;
rate_limit_error_code: ZodOptional<...>;
rate_limit_error_json: ZodOptional<...>;
rate_limit_error_message: ZodOptional<...>;
content_filter_enabled: ZodOptional<...>;
content_filter_error_code: ZodOptional<...>;
content_filter_error_json: ZodOptional<...>;
content_filter_error_message: ZodOptional<...>;
probe_message: ZodOptional<...>;
request_timeout: ZodOptional<...>;
}, ZodTypeAny, "passthrough">>>;
target_background: ZodOptional<ZodNullable<ZodObject<{
agentic_profiling_enabled: ZodOptional<...>;
industry: ZodOptional<...>;
use_case: ZodOptional<...>;
competitors: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
agentic_profiling_enabled: ...;
industry: ...;
use_case: ...;
competitors: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
agentic_profiling_enabled: ...;
industry: ...;
use_case: ...;
competitors: ...;
}, ZodTypeAny, "passthrough">>>>;
profiling_status: ZodOptional<ZodNullable<ZodString>>;
additional_context: ZodOptional<ZodNullable<ZodObject<{
base_model: ZodOptional<...>;
core_architecture: ZodOptional<...>;
system_prompt: ZodOptional<...>;
languages_supported: ZodOptional<...>;
banned_keywords: ZodOptional<...>;
tools_accessible: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
base_model: ...;
core_architecture: ...;
system_prompt: ...;
languages_supported: ...;
banned_keywords: ...;
tools_accessible: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
base_model: ...;
core_architecture: ...;
system_prompt: ...;
languages_supported: ...;
banned_keywords: ...;
tools_accessible: ...;
}, ZodTypeAny, "passthrough">>>>;
auth_type: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
adapter_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
canonical_id: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
adapter_secret_version: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
profiling_progress: ZodOptional<ZodUnion<[ZodNumber, ZodNull]>>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<ZodNullable<ZodString>>;
target_type: ZodOptional<ZodNullable<ZodString>>;
connection_type: ZodOptional<ZodNullable<ZodString>>;
api_endpoint_type: ZodOptional<ZodNullable<ZodString>>;
response_mode: ZodOptional<ZodNullable<ZodString>>;
session_supported: ZodOptional<ZodBoolean>;
extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<ZodNullable<ZodNumber>>;
secret_version: ZodOptional<ZodNullable<ZodString>>;
created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
updated_by_user_id: ZodOptional<ZodNullable<ZodString>>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<ZodObject<{
supports_multimodal_files: ZodOptional<...>;
supports_multimodal_files_error_message: ZodOptional<...>;
multi_turn: ZodOptional<...>;
multi_turn_error_message: ZodOptional<...>;
rate_limit: ZodOptional<...>;
rate_limit_enabled: ZodOptional<...>;
rate_limit_error_code: ZodOptional<...>;
rate_limit_error_json: ZodOptional<...>;
rate_limit_error_message: ZodOptional<...>;
content_filter_enabled: ZodOptional<...>;
content_filter_error_code: ZodOptional<...>;
content_filter_error_json: ZodOptional<...>;
content_filter_error_message: ZodOptional<...>;
probe_message: ZodOptional<...>;
request_timeout: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
supports_multimodal_files: ...;
supports_multimodal_files_error_message: ...;
multi_turn: ...;
multi_turn_error_message: ...;
rate_limit: ...;
rate_limit_enabled: ...;
rate_limit_error_code: ...;
rate_limit_error_json: ...;
rate_limit_error_message: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_json: ...;
content_filter_error_message: ...;
probe_message: ...;
request_timeout: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
supports_multimodal_files: ...;
supports_multimodal_files_error_message: ...;
multi_turn: ...;
multi_turn_error_message: ...;
rate_limit: ...;
rate_limit_enabled: ...;
rate_limit_error_code: ...;
rate_limit_error_json: ...;
rate_limit_error_message: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_json: ...;
content_filter_error_message: ...;
probe_message: ...;
request_timeout: ...;
}, ZodTypeAny, "passthrough">>>;
target_background: ZodOptional<ZodNullable<ZodObject<{
agentic_profiling_enabled: ...;
industry: ...;
use_case: ...;
competitors: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
profiling_status: ZodOptional<ZodNullable<ZodString>>;
additional_context: ZodOptional<ZodNullable<ZodObject<{
base_model: ...;
core_architecture: ...;
system_prompt: ...;
languages_supported: ...;
banned_keywords: ...;
tools_accessible: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
auth_type: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
adapter_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
canonical_id: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
adapter_secret_version: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
profiling_progress: ZodOptional<ZodUnion<[ZodNumber, ZodNull]>>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<ZodNullable<ZodString>>;
target_type: ZodOptional<ZodNullable<ZodString>>;
connection_type: ZodOptional<ZodNullable<ZodString>>;
api_endpoint_type: ZodOptional<ZodNullable<ZodString>>;
response_mode: ZodOptional<ZodNullable<ZodString>>;
session_supported: ZodOptional<ZodBoolean>;
extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<ZodNullable<ZodNumber>>;
secret_version: ZodOptional<ZodNullable<ZodString>>;
created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
updated_by_user_id: ZodOptional<ZodNullable<ZodString>>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<ZodObject<{
supports_multimodal_files: ZodOptional<...>;
supports_multimodal_files_error_message: ZodOptional<...>;
multi_turn: ZodOptional<...>;
multi_turn_error_message: ZodOptional<...>;
rate_limit: ZodOptional<...>;
rate_limit_enabled: ZodOptional<...>;
rate_limit_error_code: ZodOptional<...>;
rate_limit_error_json: ZodOptional<...>;
rate_limit_error_message: ZodOptional<...>;
content_filter_enabled: ZodOptional<...>;
content_filter_error_code: ZodOptional<...>;
content_filter_error_json: ZodOptional<...>;
content_filter_error_message: ZodOptional<...>;
probe_message: ZodOptional<...>;
request_timeout: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
supports_multimodal_files: ...;
supports_multimodal_files_error_message: ...;
multi_turn: ...;
multi_turn_error_message: ...;
rate_limit: ...;
rate_limit_enabled: ...;
rate_limit_error_code: ...;
rate_limit_error_json: ...;
rate_limit_error_message: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_json: ...;
content_filter_error_message: ...;
probe_message: ...;
request_timeout: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
supports_multimodal_files: ...;
supports_multimodal_files_error_message: ...;
multi_turn: ...;
multi_turn_error_message: ...;
rate_limit: ...;
rate_limit_enabled: ...;
rate_limit_error_code: ...;
rate_limit_error_json: ...;
rate_limit_error_message: ...;
content_filter_enabled: ...;
content_filter_error_code: ...;
content_filter_error_json: ...;
content_filter_error_message: ...;
probe_message: ...;
request_timeout: ...;
}, ZodTypeAny, "passthrough">>>;
target_background: ZodOptional<ZodNullable<ZodObject<{
agentic_profiling_enabled: ...;
industry: ...;
use_case: ...;
competitors: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
profiling_status: ZodOptional<ZodNullable<ZodString>>;
additional_context: ZodOptional<ZodNullable<ZodObject<{
base_model: ...;
core_architecture: ...;
system_prompt: ...;
languages_supported: ...;
banned_keywords: ...;
tools_accessible: ...;
}, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
auth_type: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>;
job_type: ZodString;
job_metadata: ZodUnion<[ZodObject<{
language: ZodOptional<ZodNullable<ZodLazy<...>>>;
include_file_attacks: ZodOptional<ZodBoolean>;
categories: ZodRecord<ZodString, ZodUnknown>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
language: ZodOptional<ZodNullable<...>>;
include_file_attacks: ZodOptional<ZodBoolean>;
categories: ZodRecord<ZodString, ZodUnknown>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<...>>;
rate_limit_error_code: ZodOptional<ZodNullable<...>>;
rate_limit_error_message: ZodOptional<ZodNullable<...>>;
rate_limit_error_json: ZodOptional<ZodNullable<...>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<...>>;
content_filter_error_message: ZodOptional<ZodNullable<...>>;
content_filter_error_json: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
language: ZodOptional<ZodNullable<...>>;
include_file_attacks: ZodOptional<ZodBoolean>;
categories: ZodRecord<ZodString, ZodUnknown>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<...>>;
rate_limit_error_code: ZodOptional<ZodNullable<...>>;
rate_limit_error_message: ZodOptional<ZodNullable<...>>;
rate_limit_error_json: ZodOptional<ZodNullable<...>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<...>>;
content_filter_error_message: ZodOptional<ZodNullable<...>>;
content_filter_error_json: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">>, ZodObject<{
language: ZodOptional<ZodNullable<ZodLazy<...>>>;
goal_categories: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
stream_breadth: ZodOptional<ZodNumber>;
stream_depth: ZodOptional<ZodNumber>;
max_tokens: ZodOptional<ZodNumber>;
context_size: ZodOptional<ZodNumber>;
attack_goals: ZodOptional<ZodArray<ZodString, "many">>;
base_model: ZodOptional<ZodNullable<ZodString>>;
use_case: ZodOptional<ZodNullable<ZodString>>;
system_prompt: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
language: ZodOptional<ZodNullable<...>>;
goal_categories: ZodOptional<ZodNullable<...>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<...>>;
rate_limit_error_code: ZodOptional<ZodNullable<...>>;
rate_limit_error_message: ZodOptional<ZodNullable<...>>;
rate_limit_error_json: ZodOptional<ZodNullable<...>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<...>>;
content_filter_error_message: ZodOptional<ZodNullable<...>>;
content_filter_error_json: ZodOptional<ZodNullable<...>>;
stream_breadth: ZodOptional<ZodNumber>;
stream_depth: ZodOptional<ZodNumber>;
max_tokens: ZodOptional<ZodNumber>;
context_size: ZodOptional<ZodNumber>;
attack_goals: ZodOptional<ZodArray<..., ...>>;
base_model: ZodOptional<ZodNullable<...>>;
use_case: ZodOptional<ZodNullable<...>>;
system_prompt: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
language: ZodOptional<ZodNullable<...>>;
goal_categories: ZodOptional<ZodNullable<...>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<...>>;
rate_limit_error_code: ZodOptional<ZodNullable<...>>;
rate_limit_error_message: ZodOptional<ZodNullable<...>>;
rate_limit_error_json: ZodOptional<ZodNullable<...>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<...>>;
content_filter_error_message: ZodOptional<ZodNullable<...>>;
content_filter_error_json: ZodOptional<ZodNullable<...>>;
stream_breadth: ZodOptional<ZodNumber>;
stream_depth: ZodOptional<ZodNumber>;
max_tokens: ZodOptional<ZodNumber>;
context_size: ZodOptional<ZodNumber>;
attack_goals: ZodOptional<ZodArray<..., ...>>;
base_model: ZodOptional<ZodNullable<...>>;
use_case: ZodOptional<ZodNullable<...>>;
system_prompt: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">>, ZodObject<{
language: ZodOptional<ZodNullable<ZodLazy<...>>>;
custom_prompt_sets: ZodArray<ZodString, "many">;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
language: ZodOptional<ZodNullable<...>>;
custom_prompt_sets: ZodArray<ZodString, "many">;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<...>>;
rate_limit_error_code: ZodOptional<ZodNullable<...>>;
rate_limit_error_message: ZodOptional<ZodNullable<...>>;
rate_limit_error_json: ZodOptional<ZodNullable<...>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<...>>;
content_filter_error_message: ZodOptional<ZodNullable<...>>;
content_filter_error_json: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
language: ZodOptional<ZodNullable<...>>;
custom_prompt_sets: ZodArray<ZodString, "many">;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<...>>;
rate_limit_error_code: ZodOptional<ZodNullable<...>>;
rate_limit_error_message: ZodOptional<ZodNullable<...>>;
rate_limit_error_json: ZodOptional<ZodNullable<...>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<...>>;
content_filter_error_message: ZodOptional<ZodNullable<...>>;
content_filter_error_json: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">>, ZodObject<{
scan_name: ZodString;
categories: ZodOptional<ZodRecord<ZodString, ZodArray<..., ...>>>;
language: ZodOptional<ZodNull>;
}, "passthrough", ZodTypeAny, objectOutputType<{
scan_name: ZodString;
categories: ZodOptional<ZodRecord<..., ...>>;
language: ZodOptional<ZodNull>;
}, ZodTypeAny, "passthrough">, objectInputType<{
scan_name: ZodString;
categories: ZodOptional<ZodRecord<..., ...>>;
language: ZodOptional<ZodNull>;
}, ZodTypeAny, "passthrough">>]>;
version: ZodOptional<ZodNullable<ZodNumber>>;
extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
target_id: ZodString;
target_type: ZodString;
total: ZodOptional<ZodNullable<ZodNumber>>;
completed: ZodOptional<ZodNullable<ZodNumber>>;
status: ZodOptional<ZodString>;
score: ZodOptional<ZodNullable<ZodNumber>>;
asr: ZodOptional<ZodNullable<ZodNumber>>;
time_record: ZodOptional<ZodNullable<ZodObject<{
queued_at: ZodOptional<ZodNullable<ZodString>>;
started_at: ZodOptional<ZodNullable<ZodString>>;
completed_at: ZodOptional<ZodNullable<ZodString>>;
time_taken: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
queued_at: ZodOptional<ZodNullable<...>>;
started_at: ZodOptional<ZodNullable<...>>;
completed_at: ZodOptional<ZodNullable<...>>;
time_taken: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
queued_at: ZodOptional<ZodNullable<...>>;
started_at: ZodOptional<ZodNullable<...>>;
completed_at: ZodOptional<ZodNullable<...>>;
time_taken: ZodOptional<ZodNullable<...>>;
}, ZodTypeAny, "passthrough">>>>;
created_at: ZodOptional<ZodNullable<ZodString>>;
updated_at: ZodOptional<ZodNullable<ZodString>>;
created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
report_stats: ZodOptional<ZodNullable<ZodUnion<[ZodObject<{
output_completion_percentage: ZodNumber;
partial_report_unlocked: ZodOptional<...>;
partial_report_unlocked_at: ZodOptional<...>;
report_summary: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
output_completion_percentage: ...;
partial_report_unlocked: ...;
partial_report_unlocked_at: ...;
report_summary: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
output_completion_percentage: ...;
partial_report_unlocked: ...;
partial_report_unlocked_at: ...;
report_summary: ...;
}, ZodTypeAny, "passthrough">>, ZodObject<{
total_goals: ZodOptional<...>;
total_streams: ZodOptional<...>;
total_threats: ZodOptional<...>;
goals_achieved: ZodOptional<...>;
report_summary: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
total_goals: ...;
total_streams: ...;
total_threats: ...;
goals_achieved: ...;
report_summary: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
total_goals: ...;
total_streams: ...;
total_threats: ...;
goals_achieved: ...;
report_summary: ...;
}, ZodTypeAny, "passthrough">>]>>>;
metering_quota_uuid: ZodOptional<ZodNullable<ZodString>>;
counted_towards_quota: ZodOptional<ZodString>;
invocation_id: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">[]>
Example
`const scans = await rt.scans.listAll({ status: 'COMPLETED' });`
get()
get(jobId): Promise<objectOutputType<{
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
target: ZodObject<{
adapter_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
canonical_id: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
adapter_secret_version: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
profiling_progress: ZodOptional<ZodUnion<[ZodNumber, ZodNull]>>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<ZodNullable<ZodString>>;
target_type: ZodOptional<ZodNullable<ZodString>>;
connection_type: ZodOptional<ZodNullable<ZodString>>;
api_endpoint_type: ZodOptional<ZodNullable<ZodString>>;
response_mode: ZodOptional<ZodNullable<ZodString>>;
session_supported: ZodOptional<ZodBoolean>;
extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<ZodNullable<ZodNumber>>;
secret_version: ZodOptional<ZodNullable<ZodString>>;
created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
updated_by_user_id: ZodOptional<ZodNullable<ZodString>>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<ZodObject<{
supports_multimodal_files: ZodOptional<ZodBoolean>;
supports_multimodal_files_error_message: ZodOptional<ZodUnion<[..., ...]>>;
multi_turn: ZodOptional<ZodBoolean>;
multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
probe_message: ZodOptional<ZodString>;
request_timeout: ZodOptional<ZodNumber>;
}, "passthrough", ZodTypeAny, objectOutputType<{
supports_multimodal_files: ZodOptional<ZodBoolean>;
supports_multimodal_files_error_message: ZodOptional<ZodUnion<...>>;
multi_turn: ZodOptional<ZodBoolean>;
multi_turn_error_message: ZodOptional<ZodNullable<...>>;
rate_limit: ZodOptional<ZodNullable<...>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit_error_code: ZodOptional<ZodNullable<...>>;
rate_limit_error_json: ZodOptional<ZodNullable<...>>;
rate_limit_error_message: ZodOptional<ZodNullable<...>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<...>>;
content_filter_error_json: ZodOptional<ZodNullable<...>>;
content_filter_error_message: ZodOptional<ZodNullable<...>>;
probe_message: ZodOptional<ZodString>;
request_timeout: ZodOptional<ZodNumber>;
}, ZodTypeAny, "passthrough">, objectInputType<{
supports_multimodal_files: ZodOptional<ZodBoolean>;
supports_multimodal_files_error_message: ZodOptional<ZodUnion<...>>;
multi_turn: ZodOptional<ZodBoolean>;
multi_turn_error_message: ZodOptional<ZodNullable<...>>;
rate_limit: ZodOptional<ZodNullable<...>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit_error_code: ZodOptional<ZodNullable<...>>;
rate_limit_error_json: ZodOptional<ZodNullable<...>>;
rate_limit_error_message: ZodOptional<ZodNullable<...>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<...>>;
content_filter_error_json: ZodOptional<ZodNullable<...>>;
content_filter_error_message: ZodOptional<ZodNullable<...>>;
probe_message: ZodOptional<ZodString>;
request_timeout: ZodOptional<ZodNumber>;
}, ZodTypeAny, "passthrough">>>;
target_background: ZodOptional<ZodNullable<ZodObject<{
agentic_profiling_enabled: ZodOptional<ZodBoolean>;
industry: ZodOptional<ZodNullable<...>>;
use_case: ZodOptional<ZodNullable<...>>;
competitors: ZodOptional<ZodNullable<...>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
agentic_profiling_enabled: ZodOptional<...>;
industry: ZodOptional<...>;
use_case: ZodOptional<...>;
competitors: ZodOptional<...>;
}, ZodTypeAny, "passthrough">, objectInputType<{
agentic_profiling_enabled: ZodOptional<...>;
industry: ZodOptional<...>;
use_case: ZodOptional<...>;
competitors: ZodOptional<...>;
}, ZodTypeAny, "passthrough">>>>;
profiling_status: ZodOptional<ZodNullable<ZodString>>;
additional_context: ZodOptional<ZodNullable<ZodObject<{
base_model: ZodOptional<ZodNullable<...>>;
core_architecture: ZodOptional<ZodNullable<...>>;
system_prompt: ZodOptional<ZodNullable<...>>;
languages_supported: ZodOptional<ZodNullable<...>>;
banned_keywords: ZodOptional<ZodNullable<...>>;
tools_accessible: ZodOptional<ZodNullable<...>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
base_model: ZodOptional<...>;
core_architecture: ZodOptional<...>;
system_prompt: ZodOptional<...>;
languages_supported: ZodOptional<...>;
banned_keywords: ZodOptional<...>;
tools_accessible: ZodOptional<...>;
}, ZodTypeAny, "passthrough">, objectInputType<{
base_model: ZodOptional<...>;
core_architecture: ZodOptional<...>;
system_prompt: ZodOptional<...>;
languages_supported: ZodOptional<...>;
banned_keywords: ZodOptional<...>;
tools_accessible: ZodOptional<...>;
}, ZodTypeAny, "passthrough">>>>;
auth_type: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
adapter_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
canonical_id: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
adapter_secret_version: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
profiling_progress: ZodOptional<ZodUnion<[ZodNumber, ZodNull]>>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<ZodNullable<ZodString>>;
target_type: ZodOptional<ZodNullable<ZodString>>;
connection_type: ZodOptional<ZodNullable<ZodString>>;
api_endpoint_type: ZodOptional<ZodNullable<ZodString>>;
response_mode: ZodOptional<ZodNullable<ZodString>>;
session_supported: ZodOptional<ZodBoolean>;
extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<ZodNullable<ZodNumber>>;
secret_version: ZodOptional<ZodNullable<ZodString>>;
created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
updated_by_user_id: ZodOptional<ZodNullable<ZodString>>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<ZodObject<{
supports_multimodal_files: ZodOptional<ZodBoolean>;
supports_multimodal_files_error_message: ZodOptional<ZodUnion<...>>;
multi_turn: ZodOptional<ZodBoolean>;
multi_turn_error_message: ZodOptional<ZodNullable<...>>;
rate_limit: ZodOptional<ZodNullable<...>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit_error_code: ZodOptional<ZodNullable<...>>;
rate_limit_error_json: ZodOptional<ZodNullable<...>>;
rate_limit_error_message: ZodOptional<ZodNullable<...>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<...>>;
content_filter_error_json: ZodOptional<ZodNullable<...>>;
content_filter_error_message: ZodOptional<ZodNullable<...>>;
probe_message: ZodOptional<ZodString>;
request_timeout: ZodOptional<ZodNumber>;
}, "passthrough", ZodTypeAny, objectOutputType<{
supports_multimodal_files: ZodOptional<...>;
supports_multimodal_files_error_message: ZodOptional<...>;
multi_turn: ZodOptional<...>;
multi_turn_error_message: ZodOptional<...>;
rate_limit: ZodOptional<...>;
rate_limit_enabled: ZodOptional<...>;
rate_limit_error_code: ZodOptional<...>;
rate_limit_error_json: ZodOptional<...>;
rate_limit_error_message: ZodOptional<...>;
content_filter_enabled: ZodOptional<...>;
content_filter_error_code: ZodOptional<...>;
content_filter_error_json: ZodOptional<...>;
content_filter_error_message: ZodOptional<...>;
probe_message: ZodOptional<...>;
request_timeout: ZodOptional<...>;
}, ZodTypeAny, "passthrough">, objectInputType<{
supports_multimodal_files: ZodOptional<...>;
supports_multimodal_files_error_message: ZodOptional<...>;
multi_turn: ZodOptional<...>;
multi_turn_error_message: ZodOptional<...>;
rate_limit: ZodOptional<...>;
rate_limit_enabled: ZodOptional<...>;
rate_limit_error_code: ZodOptional<...>;
rate_limit_error_json: ZodOptional<...>;
rate_limit_error_message: ZodOptional<...>;
content_filter_enabled: ZodOptional<...>;
content_filter_error_code: ZodOptional<...>;
content_filter_error_json: ZodOptional<...>;
content_filter_error_message: ZodOptional<...>;
probe_message: ZodOptional<...>;
request_timeout: ZodOptional<...>;
}, ZodTypeAny, "passthrough">>>;
target_background: ZodOptional<ZodNullable<ZodObject<{
agentic_profiling_enabled: ZodOptional<...>;
industry: ZodOptional<...>;
use_case: ZodOptional<...>;
competitors: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
agentic_profiling_enabled: ...;
industry: ...;
use_case: ...;
competitors: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
agentic_profiling_enabled: ...;
industry: ...;
use_case: ...;
competitors: ...;
}, ZodTypeAny, "passthrough">>>>;
profiling_status: ZodOptional<ZodNullable<ZodString>>;
additional_context: ZodOptional<ZodNullable<ZodObject<{
base_model: ZodOptional<...>;
core_architecture: ZodOptional<...>;
system_prompt: ZodOptional<...>;
languages_supported: ZodOptional<...>;
banned_keywords: ZodOptional<...>;
tools_accessible: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
base_model: ...;
core_architecture: ...;
system_prompt: ...;
languages_supported: ...;
banned_keywords: ...;
tools_accessible: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
base_model: ...;
core_architecture: ...;
system_prompt: ...;
languages_supported: ...;
banned_keywords: ...;
tools_accessible: ...;
}, ZodTypeAny, "passthrough">>>>;
auth_type: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
adapter_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
canonical_id: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
adapter_secret_version: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
profiling_progress: ZodOptional<ZodUnion<[ZodNumber, ZodNull]>>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<ZodNullable<ZodString>>;
target_type: ZodOptional<ZodNullable<ZodString>>;
connection_type: ZodOptional<ZodNullable<ZodString>>;
api_endpoint_type: ZodOptional<ZodNullable<ZodString>>;
response_mode: ZodOptional<ZodNullable<ZodString>>;
session_supported: ZodOptional<ZodBoolean>;
extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<ZodNullable<ZodNumber>>;
secret_version: ZodOptional<ZodNullable<ZodString>>;
created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
updated_by_user_id: ZodOptional<ZodNullable<ZodString>>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<ZodObject<{
supports_multimodal_files: ZodOptional<ZodBoolean>;
supports_multimodal_files_error_message: ZodOptional<ZodUnion<...>>;
multi_turn: ZodOptional<ZodBoolean>;
multi_turn_error_message: ZodOptional<ZodNullable<...>>;
rate_limit: ZodOptional<ZodNullable<...>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit_error_code: ZodOptional<ZodNullable<...>>;
rate_limit_error_json: ZodOptional<ZodNullable<...>>;
rate_limit_error_message: ZodOptional<ZodNullable<...>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<...>>;
content_filter_error_json: ZodOptional<ZodNullable<...>>;
content_filter_error_message: ZodOptional<ZodNullable<...>>;
probe_message: ZodOptional<ZodString>;
request_timeout: ZodOptional<ZodNumber>;
}, "passthrough", ZodTypeAny, objectOutputType<{
supports_multimodal_files: ZodOptional<...>;
supports_multimodal_files_error_message: ZodOptional<...>;
multi_turn: ZodOptional<...>;
multi_turn_error_message: ZodOptional<...>;
rate_limit: ZodOptional<...>;
rate_limit_enabled: ZodOptional<...>;
rate_limit_error_code: ZodOptional<...>;
rate_limit_error_json: ZodOptional<...>;
rate_limit_error_message: ZodOptional<...>;
content_filter_enabled: ZodOptional<...>;
content_filter_error_code: ZodOptional<...>;
content_filter_error_json: ZodOptional<...>;
content_filter_error_message: ZodOptional<...>;
probe_message: ZodOptional<...>;
request_timeout: ZodOptional<...>;
}, ZodTypeAny, "passthrough">, objectInputType<{
supports_multimodal_files: ZodOptional<...>;
supports_multimodal_files_error_message: ZodOptional<...>;
multi_turn: ZodOptional<...>;
multi_turn_error_message: ZodOptional<...>;
rate_limit: ZodOptional<...>;
rate_limit_enabled: ZodOptional<...>;
rate_limit_error_code: ZodOptional<...>;
rate_limit_error_json: ZodOptional<...>;
rate_limit_error_message: ZodOptional<...>;
content_filter_enabled: ZodOptional<...>;
content_filter_error_code: ZodOptional<...>;
content_filter_error_json: ZodOptional<...>;
content_filter_error_message: ZodOptional<...>;
probe_message: ZodOptional<...>;
request_timeout: ZodOptional<...>;
}, ZodTypeAny, "passthrough">>>;
target_background: ZodOptional<ZodNullable<ZodObject<{
agentic_profiling_enabled: ZodOptional<...>;
industry: ZodOptional<...>;
use_case: ZodOptional<...>;
competitors: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
agentic_profiling_enabled: ...;
industry: ...;
use_case: ...;
competitors: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
agentic_profiling_enabled: ...;
industry: ...;
use_case: ...;
competitors: ...;
}, ZodTypeAny, "passthrough">>>>;
profiling_status: ZodOptional<ZodNullable<ZodString>>;
additional_context: ZodOptional<ZodNullable<ZodObject<{
base_model: ZodOptional<...>;
core_architecture: ZodOptional<...>;
system_prompt: ZodOptional<...>;
languages_supported: ZodOptional<...>;
banned_keywords: ZodOptional<...>;
tools_accessible: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
base_model: ...;
core_architecture: ...;
system_prompt: ...;
languages_supported: ...;
banned_keywords: ...;
tools_accessible: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
base_model: ...;
core_architecture: ...;
system_prompt: ...;
languages_supported: ...;
banned_keywords: ...;
tools_accessible: ...;
}, ZodTypeAny, "passthrough">>>>;
auth_type: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>;
job_type: ZodString;
job_metadata: ZodUnion<[ZodObject<{
language: ZodOptional<ZodNullable<ZodLazy<ZodObject<..., ..., ..., ..., ...>>>>;
include_file_attacks: ZodOptional<ZodBoolean>;
categories: ZodRecord<ZodString, ZodUnknown>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
language: ZodOptional<ZodNullable<ZodLazy<...>>>;
include_file_attacks: ZodOptional<ZodBoolean>;
categories: ZodRecord<ZodString, ZodUnknown>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
language: ZodOptional<ZodNullable<ZodLazy<...>>>;
include_file_attacks: ZodOptional<ZodBoolean>;
categories: ZodRecord<ZodString, ZodUnknown>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
}, ZodTypeAny, "passthrough">>, ZodObject<{
language: ZodOptional<ZodNullable<ZodLazy<ZodObject<..., ..., ..., ..., ...>>>>;
goal_categories: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
stream_breadth: ZodOptional<ZodNumber>;
stream_depth: ZodOptional<ZodNumber>;
max_tokens: ZodOptional<ZodNumber>;
context_size: ZodOptional<ZodNumber>;
attack_goals: ZodOptional<ZodArray<ZodString, "many">>;
base_model: ZodOptional<ZodNullable<ZodString>>;
use_case: ZodOptional<ZodNullable<ZodString>>;
system_prompt: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
language: ZodOptional<ZodNullable<ZodLazy<...>>>;
goal_categories: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
stream_breadth: ZodOptional<ZodNumber>;
stream_depth: ZodOptional<ZodNumber>;
max_tokens: ZodOptional<ZodNumber>;
context_size: ZodOptional<ZodNumber>;
attack_goals: ZodOptional<ZodArray<ZodString, "many">>;
base_model: ZodOptional<ZodNullable<ZodString>>;
use_case: ZodOptional<ZodNullable<ZodString>>;
system_prompt: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
language: ZodOptional<ZodNullable<ZodLazy<...>>>;
goal_categories: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
stream_breadth: ZodOptional<ZodNumber>;
stream_depth: ZodOptional<ZodNumber>;
max_tokens: ZodOptional<ZodNumber>;
context_size: ZodOptional<ZodNumber>;
attack_goals: ZodOptional<ZodArray<ZodString, "many">>;
base_model: ZodOptional<ZodNullable<ZodString>>;
use_case: ZodOptional<ZodNullable<ZodString>>;
system_prompt: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>, ZodObject<{
language: ZodOptional<ZodNullable<ZodLazy<ZodObject<..., ..., ..., ..., ...>>>>;
custom_prompt_sets: ZodArray<ZodString, "many">;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
language: ZodOptional<ZodNullable<ZodLazy<...>>>;
custom_prompt_sets: ZodArray<ZodString, "many">;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
language: ZodOptional<ZodNullable<ZodLazy<...>>>;
custom_prompt_sets: ZodArray<ZodString, "many">;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
}, ZodTypeAny, "passthrough">>, ZodObject<{
scan_name: ZodString;
categories: ZodOptional<ZodRecord<ZodString, ZodArray<ZodString, "many">>>;
language: ZodOptional<ZodNull>;
}, "passthrough", ZodTypeAny, objectOutputType<{
scan_name: ZodString;
categories: ZodOptional<ZodRecord<ZodString, ZodArray<..., ...>>>;
language: ZodOptional<ZodNull>;
}, ZodTypeAny, "passthrough">, objectInputType<{
scan_name: ZodString;
categories: ZodOptional<ZodRecord<ZodString, ZodArray<..., ...>>>;
language: ZodOptional<ZodNull>;
}, ZodTypeAny, "passthrough">>]>;
version: ZodOptional<ZodNullable<ZodNumber>>;
extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
target_id: ZodString;
target_type: ZodString;
total: ZodOptional<ZodNullable<ZodNumber>>;
completed: ZodOptional<ZodNullable<ZodNumber>>;
status: ZodOptional<ZodString>;
score: ZodOptional<ZodNullable<ZodNumber>>;
asr: ZodOptional<ZodNullable<ZodNumber>>;
time_record: ZodOptional<ZodNullable<ZodObject<{
queued_at: ZodOptional<ZodNullable<ZodString>>;
started_at: ZodOptional<ZodNullable<ZodString>>;
completed_at: ZodOptional<ZodNullable<ZodString>>;
time_taken: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
queued_at: ZodOptional<ZodNullable<ZodString>>;
started_at: ZodOptional<ZodNullable<ZodString>>;
completed_at: ZodOptional<ZodNullable<ZodString>>;
time_taken: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
queued_at: ZodOptional<ZodNullable<ZodString>>;
started_at: ZodOptional<ZodNullable<ZodString>>;
completed_at: ZodOptional<ZodNullable<ZodString>>;
time_taken: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>>>;
created_at: ZodOptional<ZodNullable<ZodString>>;
updated_at: ZodOptional<ZodNullable<ZodString>>;
created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
report_stats: ZodOptional<ZodNullable<ZodUnion<[ZodObject<{
output_completion_percentage: ZodNumber;
partial_report_unlocked: ZodOptional<ZodBoolean>;
partial_report_unlocked_at: ZodOptional<ZodNullable<...>>;
report_summary: ZodOptional<ZodNullable<...>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
output_completion_percentage: ZodNumber;
partial_report_unlocked: ZodOptional<...>;
partial_report_unlocked_at: ZodOptional<...>;
report_summary: ZodOptional<...>;
}, ZodTypeAny, "passthrough">, objectInputType<{
output_completion_percentage: ZodNumber;
partial_report_unlocked: ZodOptional<...>;
partial_report_unlocked_at: ZodOptional<...>;
report_summary: ZodOptional<...>;
}, ZodTypeAny, "passthrough">>, ZodObject<{
total_goals: ZodOptional<ZodNumber>;
total_streams: ZodOptional<ZodNumber>;
total_threats: ZodOptional<ZodNumber>;
goals_achieved: ZodOptional<ZodNumber>;
report_summary: ZodOptional<ZodNullable<...>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
total_goals: ZodOptional<...>;
total_streams: ZodOptional<...>;
total_threats: ZodOptional<...>;
goals_achieved: ZodOptional<...>;
report_summary: ZodOptional<...>;
}, ZodTypeAny, "passthrough">, objectInputType<{
total_goals: ZodOptional<...>;
total_streams: ZodOptional<...>;
total_threats: ZodOptional<...>;
goals_achieved: ZodOptional<...>;
report_summary: ZodOptional<...>;
}, ZodTypeAny, "passthrough">>]>>>;
metering_quota_uuid: ZodOptional<ZodNullable<ZodString>>;
counted_towards_quota: ZodOptional<ZodString>;
invocation_id: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>;
Defined in: src/red-team/scans-client.ts:141
Get a single scan job by ID.
Parameters
| Parameter | Type | Description |
|---|---|---|
jobId | string | The job UUID. |
Returns
Promise<objectOutputType<{
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
target: ZodObject<{
adapter_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
canonical_id: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
adapter_secret_version: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
profiling_progress: ZodOptional<ZodUnion<[ZodNumber, ZodNull]>>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<ZodNullable<ZodString>>;
target_type: ZodOptional<ZodNullable<ZodString>>;
connection_type: ZodOptional<ZodNullable<ZodString>>;
api_endpoint_type: ZodOptional<ZodNullable<ZodString>>;
response_mode: ZodOptional<ZodNullable<ZodString>>;
session_supported: ZodOptional<ZodBoolean>;
extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<ZodNullable<ZodNumber>>;
secret_version: ZodOptional<ZodNullable<ZodString>>;
created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
updated_by_user_id: ZodOptional<ZodNullable<ZodString>>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<ZodObject<{
supports_multimodal_files: ZodOptional<ZodBoolean>;
supports_multimodal_files_error_message: ZodOptional<ZodUnion<[..., ...]>>;
multi_turn: ZodOptional<ZodBoolean>;
multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
probe_message: ZodOptional<ZodString>;
request_timeout: ZodOptional<ZodNumber>;
}, "passthrough", ZodTypeAny, objectOutputType<{
supports_multimodal_files: ZodOptional<ZodBoolean>;
supports_multimodal_files_error_message: ZodOptional<ZodUnion<...>>;
multi_turn: ZodOptional<ZodBoolean>;
multi_turn_error_message: ZodOptional<ZodNullable<...>>;
rate_limit: ZodOptional<ZodNullable<...>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit_error_code: ZodOptional<ZodNullable<...>>;
rate_limit_error_json: ZodOptional<ZodNullable<...>>;
rate_limit_error_message: ZodOptional<ZodNullable<...>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<...>>;
content_filter_error_json: ZodOptional<ZodNullable<...>>;
content_filter_error_message: ZodOptional<ZodNullable<...>>;
probe_message: ZodOptional<ZodString>;
request_timeout: ZodOptional<ZodNumber>;
}, ZodTypeAny, "passthrough">, objectInputType<{
supports_multimodal_files: ZodOptional<ZodBoolean>;
supports_multimodal_files_error_message: ZodOptional<ZodUnion<...>>;
multi_turn: ZodOptional<ZodBoolean>;
multi_turn_error_message: ZodOptional<ZodNullable<...>>;
rate_limit: ZodOptional<ZodNullable<...>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit_error_code: ZodOptional<ZodNullable<...>>;
rate_limit_error_json: ZodOptional<ZodNullable<...>>;
rate_limit_error_message: ZodOptional<ZodNullable<...>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<...>>;
content_filter_error_json: ZodOptional<ZodNullable<...>>;
content_filter_error_message: ZodOptional<ZodNullable<...>>;
probe_message: ZodOptional<ZodString>;
request_timeout: ZodOptional<ZodNumber>;
}, ZodTypeAny, "passthrough">>>;
target_background: ZodOptional<ZodNullable<ZodObject<{
agentic_profiling_enabled: ZodOptional<ZodBoolean>;
industry: ZodOptional<ZodNullable<...>>;
use_case: ZodOptional<ZodNullable<...>>;
competitors: ZodOptional<ZodNullable<...>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
agentic_profiling_enabled: ZodOptional<...>;
industry: ZodOptional<...>;
use_case: ZodOptional<...>;
competitors: ZodOptional<...>;
}, ZodTypeAny, "passthrough">, objectInputType<{
agentic_profiling_enabled: ZodOptional<...>;
industry: ZodOptional<...>;
use_case: ZodOptional<...>;
competitors: ZodOptional<...>;
}, ZodTypeAny, "passthrough">>>>;
profiling_status: ZodOptional<ZodNullable<ZodString>>;
additional_context: ZodOptional<ZodNullable<ZodObject<{
base_model: ZodOptional<ZodNullable<...>>;
core_architecture: ZodOptional<ZodNullable<...>>;
system_prompt: ZodOptional<ZodNullable<...>>;
languages_supported: ZodOptional<ZodNullable<...>>;
banned_keywords: ZodOptional<ZodNullable<...>>;
tools_accessible: ZodOptional<ZodNullable<...>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
base_model: ZodOptional<...>;
core_architecture: ZodOptional<...>;
system_prompt: ZodOptional<...>;
languages_supported: ZodOptional<...>;
banned_keywords: ZodOptional<...>;
tools_accessible: ZodOptional<...>;
}, ZodTypeAny, "passthrough">, objectInputType<{
base_model: ZodOptional<...>;
core_architecture: ZodOptional<...>;
system_prompt: ZodOptional<...>;
languages_supported: ZodOptional<...>;
banned_keywords: ZodOptional<...>;
tools_accessible: ZodOptional<...>;
}, ZodTypeAny, "passthrough">>>>;
auth_type: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
adapter_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
canonical_id: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
adapter_secret_version: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
profiling_progress: ZodOptional<ZodUnion<[ZodNumber, ZodNull]>>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<ZodNullable<ZodString>>;
target_type: ZodOptional<ZodNullable<ZodString>>;
connection_type: ZodOptional<ZodNullable<ZodString>>;
api_endpoint_type: ZodOptional<ZodNullable<ZodString>>;
response_mode: ZodOptional<ZodNullable<ZodString>>;
session_supported: ZodOptional<ZodBoolean>;
extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<ZodNullable<ZodNumber>>;
secret_version: ZodOptional<ZodNullable<ZodString>>;
created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
updated_by_user_id: ZodOptional<ZodNullable<ZodString>>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<ZodObject<{
supports_multimodal_files: ZodOptional<ZodBoolean>;
supports_multimodal_files_error_message: ZodOptional<ZodUnion<...>>;
multi_turn: ZodOptional<ZodBoolean>;
multi_turn_error_message: ZodOptional<ZodNullable<...>>;
rate_limit: ZodOptional<ZodNullable<...>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit_error_code: ZodOptional<ZodNullable<...>>;
rate_limit_error_json: ZodOptional<ZodNullable<...>>;
rate_limit_error_message: ZodOptional<ZodNullable<...>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<...>>;
content_filter_error_json: ZodOptional<ZodNullable<...>>;
content_filter_error_message: ZodOptional<ZodNullable<...>>;
probe_message: ZodOptional<ZodString>;
request_timeout: ZodOptional<ZodNumber>;
}, "passthrough", ZodTypeAny, objectOutputType<{
supports_multimodal_files: ZodOptional<...>;
supports_multimodal_files_error_message: ZodOptional<...>;
multi_turn: ZodOptional<...>;
multi_turn_error_message: ZodOptional<...>;
rate_limit: ZodOptional<...>;
rate_limit_enabled: ZodOptional<...>;
rate_limit_error_code: ZodOptional<...>;
rate_limit_error_json: ZodOptional<...>;
rate_limit_error_message: ZodOptional<...>;
content_filter_enabled: ZodOptional<...>;
content_filter_error_code: ZodOptional<...>;
content_filter_error_json: ZodOptional<...>;
content_filter_error_message: ZodOptional<...>;
probe_message: ZodOptional<...>;
request_timeout: ZodOptional<...>;
}, ZodTypeAny, "passthrough">, objectInputType<{
supports_multimodal_files: ZodOptional<...>;
supports_multimodal_files_error_message: ZodOptional<...>;
multi_turn: ZodOptional<...>;
multi_turn_error_message: ZodOptional<...>;
rate_limit: ZodOptional<...>;
rate_limit_enabled: ZodOptional<...>;
rate_limit_error_code: ZodOptional<...>;
rate_limit_error_json: ZodOptional<...>;
rate_limit_error_message: ZodOptional<...>;
content_filter_enabled: ZodOptional<...>;
content_filter_error_code: ZodOptional<...>;
content_filter_error_json: ZodOptional<...>;
content_filter_error_message: ZodOptional<...>;
probe_message: ZodOptional<...>;
request_timeout: ZodOptional<...>;
}, ZodTypeAny, "passthrough">>>;
target_background: ZodOptional<ZodNullable<ZodObject<{
agentic_profiling_enabled: ZodOptional<...>;
industry: ZodOptional<...>;
use_case: ZodOptional<...>;
competitors: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
agentic_profiling_enabled: ...;
industry: ...;
use_case: ...;
competitors: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
agentic_profiling_enabled: ...;
industry: ...;
use_case: ...;
competitors: ...;
}, ZodTypeAny, "passthrough">>>>;
profiling_status: ZodOptional<ZodNullable<ZodString>>;
additional_context: ZodOptional<ZodNullable<ZodObject<{
base_model: ZodOptional<...>;
core_architecture: ZodOptional<...>;
system_prompt: ZodOptional<...>;
languages_supported: ZodOptional<...>;
banned_keywords: ZodOptional<...>;
tools_accessible: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
base_model: ...;
core_architecture: ...;
system_prompt: ...;
languages_supported: ...;
banned_keywords: ...;
tools_accessible: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
base_model: ...;
core_architecture: ...;
system_prompt: ...;
languages_supported: ...;
banned_keywords: ...;
tools_accessible: ...;
}, ZodTypeAny, "passthrough">>>>;
auth_type: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
adapter_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
canonical_id: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
adapter_secret_version: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
profiling_progress: ZodOptional<ZodUnion<[ZodNumber, ZodNull]>>;
uuid: ZodString;
tsg_id: ZodString;
name: ZodString;
description: ZodOptional<ZodNullable<ZodString>>;
target_type: ZodOptional<ZodNullable<ZodString>>;
connection_type: ZodOptional<ZodNullable<ZodString>>;
api_endpoint_type: ZodOptional<ZodNullable<ZodString>>;
response_mode: ZodOptional<ZodNullable<ZodString>>;
session_supported: ZodOptional<ZodBoolean>;
extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
status: ZodString;
active: ZodBoolean;
validated: ZodBoolean;
version: ZodOptional<ZodNullable<ZodNumber>>;
secret_version: ZodOptional<ZodNullable<ZodString>>;
created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
updated_by_user_id: ZodOptional<ZodNullable<ZodString>>;
created_at: ZodString;
updated_at: ZodString;
target_metadata: ZodOptional<ZodObject<{
supports_multimodal_files: ZodOptional<ZodBoolean>;
supports_multimodal_files_error_message: ZodOptional<ZodUnion<...>>;
multi_turn: ZodOptional<ZodBoolean>;
multi_turn_error_message: ZodOptional<ZodNullable<...>>;
rate_limit: ZodOptional<ZodNullable<...>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit_error_code: ZodOptional<ZodNullable<...>>;
rate_limit_error_json: ZodOptional<ZodNullable<...>>;
rate_limit_error_message: ZodOptional<ZodNullable<...>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<...>>;
content_filter_error_json: ZodOptional<ZodNullable<...>>;
content_filter_error_message: ZodOptional<ZodNullable<...>>;
probe_message: ZodOptional<ZodString>;
request_timeout: ZodOptional<ZodNumber>;
}, "passthrough", ZodTypeAny, objectOutputType<{
supports_multimodal_files: ZodOptional<...>;
supports_multimodal_files_error_message: ZodOptional<...>;
multi_turn: ZodOptional<...>;
multi_turn_error_message: ZodOptional<...>;
rate_limit: ZodOptional<...>;
rate_limit_enabled: ZodOptional<...>;
rate_limit_error_code: ZodOptional<...>;
rate_limit_error_json: ZodOptional<...>;
rate_limit_error_message: ZodOptional<...>;
content_filter_enabled: ZodOptional<...>;
content_filter_error_code: ZodOptional<...>;
content_filter_error_json: ZodOptional<...>;
content_filter_error_message: ZodOptional<...>;
probe_message: ZodOptional<...>;
request_timeout: ZodOptional<...>;
}, ZodTypeAny, "passthrough">, objectInputType<{
supports_multimodal_files: ZodOptional<...>;
supports_multimodal_files_error_message: ZodOptional<...>;
multi_turn: ZodOptional<...>;
multi_turn_error_message: ZodOptional<...>;
rate_limit: ZodOptional<...>;
rate_limit_enabled: ZodOptional<...>;
rate_limit_error_code: ZodOptional<...>;
rate_limit_error_json: ZodOptional<...>;
rate_limit_error_message: ZodOptional<...>;
content_filter_enabled: ZodOptional<...>;
content_filter_error_code: ZodOptional<...>;
content_filter_error_json: ZodOptional<...>;
content_filter_error_message: ZodOptional<...>;
probe_message: ZodOptional<...>;
request_timeout: ZodOptional<...>;
}, ZodTypeAny, "passthrough">>>;
target_background: ZodOptional<ZodNullable<ZodObject<{
agentic_profiling_enabled: ZodOptional<...>;
industry: ZodOptional<...>;
use_case: ZodOptional<...>;
competitors: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
agentic_profiling_enabled: ...;
industry: ...;
use_case: ...;
competitors: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
agentic_profiling_enabled: ...;
industry: ...;
use_case: ...;
competitors: ...;
}, ZodTypeAny, "passthrough">>>>;
profiling_status: ZodOptional<ZodNullable<ZodString>>;
additional_context: ZodOptional<ZodNullable<ZodObject<{
base_model: ZodOptional<...>;
core_architecture: ZodOptional<...>;
system_prompt: ZodOptional<...>;
languages_supported: ZodOptional<...>;
banned_keywords: ZodOptional<...>;
tools_accessible: ZodOptional<...>;
}, "passthrough", ZodTypeAny, objectOutputType<{
base_model: ...;
core_architecture: ...;
system_prompt: ...;
languages_supported: ...;
banned_keywords: ...;
tools_accessible: ...;
}, ZodTypeAny, "passthrough">, objectInputType<{
base_model: ...;
core_architecture: ...;
system_prompt: ...;
languages_supported: ...;
banned_keywords: ...;
tools_accessible: ...;
}, ZodTypeAny, "passthrough">>>>;
auth_type: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>;
job_type: ZodString;
job_metadata: ZodUnion<[ZodObject<{
language: ZodOptional<ZodNullable<ZodLazy<ZodObject<..., ..., ..., ..., ...>>>>;
include_file_attacks: ZodOptional<ZodBoolean>;
categories: ZodRecord<ZodString, ZodUnknown>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
language: ZodOptional<ZodNullable<ZodLazy<...>>>;
include_file_attacks: ZodOptional<ZodBoolean>;
categories: ZodRecord<ZodString, ZodUnknown>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
language: ZodOptional<ZodNullable<ZodLazy<...>>>;
include_file_attacks: ZodOptional<ZodBoolean>;
categories: ZodRecord<ZodString, ZodUnknown>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
}, ZodTypeAny, "passthrough">>, ZodObject<{
language: ZodOptional<ZodNullable<ZodLazy<ZodObject<..., ..., ..., ..., ...>>>>;
goal_categories: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
stream_breadth: ZodOptional<ZodNumber>;
stream_depth: ZodOptional<ZodNumber>;
max_tokens: ZodOptional<ZodNumber>;
context_size: ZodOptional<ZodNumber>;
attack_goals: ZodOptional<ZodArray<ZodString, "many">>;
base_model: ZodOptional<ZodNullable<ZodString>>;
use_case: ZodOptional<ZodNullable<ZodString>>;
system_prompt: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
language: ZodOptional<ZodNullable<ZodLazy<...>>>;
goal_categories: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
stream_breadth: ZodOptional<ZodNumber>;
stream_depth: ZodOptional<ZodNumber>;
max_tokens: ZodOptional<ZodNumber>;
context_size: ZodOptional<ZodNumber>;
attack_goals: ZodOptional<ZodArray<ZodString, "many">>;
base_model: ZodOptional<ZodNullable<ZodString>>;
use_case: ZodOptional<ZodNullable<ZodString>>;
system_prompt: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
language: ZodOptional<ZodNullable<ZodLazy<...>>>;
goal_categories: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
stream_breadth: ZodOptional<ZodNumber>;
stream_depth: ZodOptional<ZodNumber>;
max_tokens: ZodOptional<ZodNumber>;
context_size: ZodOptional<ZodNumber>;
attack_goals: ZodOptional<ZodArray<ZodString, "many">>;
base_model: ZodOptional<ZodNullable<ZodString>>;
use_case: ZodOptional<ZodNullable<ZodString>>;
system_prompt: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>, ZodObject<{
language: ZodOptional<ZodNullable<ZodLazy<ZodObject<..., ..., ..., ..., ...>>>>;
custom_prompt_sets: ZodArray<ZodString, "many">;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
language: ZodOptional<ZodNullable<ZodLazy<...>>>;
custom_prompt_sets: ZodArray<ZodString, "many">;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
language: ZodOptional<ZodNullable<ZodLazy<...>>>;
custom_prompt_sets: ZodArray<ZodString, "many">;
rate_limit_enabled: ZodOptional<ZodBoolean>;
rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
content_filter_enabled: ZodOptional<ZodBoolean>;
content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
}, ZodTypeAny, "passthrough">>, ZodObject<{
scan_name: ZodString;
categories: ZodOptional<ZodRecord<ZodString, ZodArray<ZodString, "many">>>;
language: ZodOptional<ZodNull>;
}, "passthrough", ZodTypeAny, objectOutputType<{
scan_name: ZodString;
categories: ZodOptional<ZodRecord<ZodString, ZodArray<..., ...>>>;
language: ZodOptional<ZodNull>;
}, ZodTypeAny, "passthrough">, objectInputType<{
scan_name: ZodString;
categories: ZodOptional<ZodRecord<ZodString, ZodArray<..., ...>>>;
language: ZodOptional<ZodNull>;
}, ZodTypeAny, "passthrough">>]>;
version: ZodOptional<ZodNullable<ZodNumber>>;
extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
target_id: ZodString;
target_type: ZodString;
total: ZodOptional<ZodNullable<ZodNumber>>;
completed: ZodOptional<ZodNullable<ZodNumber>>;
status: ZodOptional<ZodString>;
score: ZodOptional<ZodNullable<ZodNumber>>;
asr: ZodOptional<ZodNullable<ZodNumber>>;
time_record: ZodOptional<ZodNullable<ZodObject<{
queued_at: ZodOptional<ZodNullable<ZodString>>;
started_at: ZodOptional<ZodNullable<ZodString>>;
completed_at: ZodOptional<ZodNullable<ZodString>>;
time_taken: ZodOptional<ZodNullable<ZodString>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
queued_at: ZodOptional<ZodNullable<ZodString>>;
started_at: ZodOptional<ZodNullable<ZodString>>;
completed_at: ZodOptional<ZodNullable<ZodString>>;
time_taken: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">, objectInputType<{
queued_at: ZodOptional<ZodNullable<ZodString>>;
started_at: ZodOptional<ZodNullable<ZodString>>;
completed_at: ZodOptional<ZodNullable<ZodString>>;
time_taken: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>>>;
created_at: ZodOptional<ZodNullable<ZodString>>;
updated_at: ZodOptional<ZodNullable<ZodString>>;
created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
report_stats: ZodOptional<ZodNullable<ZodUnion<[ZodObject<{
output_completion_percentage: ZodNumber;
partial_report_unlocked: ZodOptional<ZodBoolean>;
partial_report_unlocked_at: ZodOptional<ZodNullable<...>>;
report_summary: ZodOptional<ZodNullable<...>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
output_completion_percentage: ZodNumber;
partial_report_unlocked: ZodOptional<...>;
partial_report_unlocked_at: ZodOptional<...>;
report_summary: ZodOptional<...>;
}, ZodTypeAny, "passthrough">, objectInputType<{
output_completion_percentage: ZodNumber;
partial_report_unlocked: ZodOptional<...>;
partial_report_unlocked_at: ZodOptional<...>;
report_summary: ZodOptional<...>;
}, ZodTypeAny, "passthrough">>, ZodObject<{
total_goals: ZodOptional<ZodNumber>;
total_streams: ZodOptional<ZodNumber>;
total_threats: ZodOptional<ZodNumber>;
goals_achieved: ZodOptional<ZodNumber>;
report_summary: ZodOptional<ZodNullable<...>>;
}, "passthrough", ZodTypeAny, objectOutputType<{
total_goals: ZodOptional<...>;
total_streams: ZodOptional<...>;
total_threats: ZodOptional<...>;
goals_achieved: ZodOptional<...>;
report_summary: ZodOptional<...>;
}, ZodTypeAny, "passthrough">, objectInputType<{
total_goals: ZodOptional<...>;
total_streams: ZodOptional<...>;
total_threats: ZodOptional<...>;
goals_achieved: ZodOptional<...>;
report_summary: ZodOptional<...>;
}, ZodTypeAny, "passthrough">>]>>>;
metering_quota_uuid: ZodOptional<ZodNullable<ZodString>>;
counted_towards_quota: ZodOptional<ZodString>;
invocation_id: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>
The job response.
Example
import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();
const job = await rt.scans.get('550e8400-e29b-41d4-a716-446655440000');
// job =>
// { uuid: '550e8400-...', name: 'job', status: 'RUNNING', job_type: 'STATIC', target_id: '550e8400-...' }
abort()
abort(jobId): Promise<objectOutputType<{
job_id: ZodString;
message: ZodString;
}, ZodTypeAny, "passthrough">>;
Defined in: src/red-team/scans-client.ts:167
Abort a running scan job.
Parameters
| Parameter | Type | Description |
|---|---|---|
jobId | string | The job UUID. |
Returns
Promise<objectOutputType<{
job_id: ZodString;
message: ZodString;
}, ZodTypeAny, "passthrough">>
The abort response.
Example
import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();
const result = await rt.scans.abort('550e8400-e29b-41d4-a716-446655440000');
// result =>
// { job_id: '550e8400-...', message: 'aborted' }
getCategories()
getCategories(): Promise<objectOutputType<{
id: ZodString;
display_name: ZodString;
description: ZodString;
preselect: ZodOptional<ZodBoolean>;
sub_categories: ZodArray<ZodObject<{
file_supported: ZodOptional<ZodBoolean>;
id: ZodString;
display_name: ZodString;
description: ZodString;
preselect: ZodOptional<ZodBoolean>;
prerequisites: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
active: ZodOptional<ZodBoolean>;
}, "passthrough", ZodTypeAny, objectOutputType<{
file_supported: ZodOptional<ZodBoolean>;
id: ZodString;
display_name: ZodString;
description: ZodString;
preselect: ZodOptional<ZodBoolean>;
prerequisites: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
active: ZodOptional<ZodBoolean>;
}, ZodTypeAny, "passthrough">, objectInputType<{
file_supported: ZodOptional<ZodBoolean>;
id: ZodString;
display_name: ZodString;
description: ZodString;
preselect: ZodOptional<ZodBoolean>;
prerequisites: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
active: ZodOptional<ZodBoolean>;
}, ZodTypeAny, "passthrough">>, "many">;
}, ZodTypeAny, "passthrough">[]>;
Defined in: src/red-team/scans-client.ts:192
Get all categories with subcategories.
Returns
Promise<objectOutputType<{
id: ZodString;
display_name: ZodString;
description: ZodString;
preselect: ZodOptional<ZodBoolean>;
sub_categories: ZodArray<ZodObject<{
file_supported: ZodOptional<ZodBoolean>;
id: ZodString;
display_name: ZodString;
description: ZodString;
preselect: ZodOptional<ZodBoolean>;
prerequisites: ZodOptional<ZodNullable<ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">>>;
active: ZodOptional<ZodBoolean>;
}, "passthrough", ZodTypeAny, objectOutputType<{
file_supported: ZodOptional<ZodBoolean>;
id: ZodString;
display_name: ZodString;
description: ZodString;
preselect: ZodOptional<ZodBoolean>;
prerequisites: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
active: ZodOptional<ZodBoolean>;
}, ZodTypeAny, "passthrough">, objectInputType<{
file_supported: ZodOptional<ZodBoolean>;
id: ZodString;
display_name: ZodString;
description: ZodString;
preselect: ZodOptional<ZodBoolean>;
prerequisites: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
active: ZodOptional<ZodBoolean>;
}, ZodTypeAny, "passthrough">>, "many">;
}, ZodTypeAny, "passthrough">[]>
The list of category models.
Example
import { RedTeamClient } from '@cdot65/prisma-airs-sdk';
const rt = new RedTeamClient();
const categories = await rt.scans.getCategories();
// categories =>
// [{ id: 'jailbreak', display_name: 'Jailbreak', description: '...', sub_categories: [] }]