Model Risks

Create New Model Risk

Changed on
post/modelRisks

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/modelRisks
  • Auth
    HTTP bearer

Request body

risk_namestring required
risk_category'Performance' | 'Bias & Fairness' | 'Security' | 'Data Quality' | 'Compliance' required
risk_level'Low' | 'Medium' | 'High' | 'Critical' required
status'Open' | 'In Progress' | 'Resolved' | 'Accepted'
ownerstring required

Name or identifier of the risk owner.

target_datestring date required

Next review / target date.

descriptionstring
mitigation_planstring
impactstring
likelihoodstring
key_metricsstring
current_valuesstring
thresholdstring
model_idinteger nullable

ID of the model inventory entry this risk is linked to.

is_demoboolean

Response

Created successfully

messagestring

Changes

  • 55cdc040840cRevision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      request body became required

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the media type application/json for the response with the status

  • ac49160fcab0Revision changes
    • breaking

      api path removed without deprecation

    • info

      endpoint added