Skip to main content

Risk Types

Manage risk types in Credo AI.

Methods​

list​

List Risk Types List all risk types.

Returns a paginated list of risk types with optional filters.

response = client.risk_types.list(
)

Parameters:

  • custom (Any, optional) - Query parameter
  • hidden (Any, optional) - Query parameter
  • page_limit (Any, optional) - Query parameter
  • page_after (Any, optional) - Query parameter

Returns: Response object

create​

Create Risk Type Create a new custom risk type.

from credoai import RiskTypeCreate

data = RiskTypeCreate(
    name="Example Name",
)

response = client.risk_types.create(
    data=data,
)

Parameters:

Returns: Response object

update​

Update Risk Type Update an existing risk type.

For custom risk types: name and description can be updated. For OOTB risk types: only hidden can be updated.

from credoai import RiskTypeUpdate

risk_type_id = "risk_type_id-123"

data = RiskTypeUpdate(
    name="Example Name",
)

response = client.risk_types.update(
    risk_type_id=risk_type_id,
    data=data,
)

Parameters:

  • risk_type_id (str, required) - The risk type ID
  • data (RiskTypeUpdate, required) - Request payload

Returns: Response object

delete​

Delete Risk Type Delete a custom risk type.

risk_type_id = "risk_type_id-123"

response = client.risk_types.delete(
    risk_type_id=risk_type_id,
)

Parameters:

  • risk_type_id (str, required) - The risk type ID

Returns: Response object

Error Handling​

from credoai.errors import ApiError, ClientValidationError
from credoai.auth import AuthenticationError

try:
    response = client.risk_types.list(...)
except ApiError as e:
    print(f"API error {e.status_code}: {e.message}")
except ClientValidationError as e:
    print(f"Validation error: {e}")
except AuthenticationError as e:
    print(f"Auth error: {e}")