COconfident-ai
Risk Assessments

Run Risk Assessment

Changed on

Starts a risk assessment run asynchronously against a framework's risk categories, then returns a link to the assessment.

Target your application with either an AI connection (by name) or a prompt (by alias and commit). Provide exactly one, or set generationMode to disambiguate. Requires an Enterprise plan.

post/v1/risk-assessments/frameworks/{frameworkId}/run

Request

Request body

riskCategoriesstring[] required

The names of the risk categories to assess, exactly as returned by the list frameworks endpoint.

exposure'LOW' | 'MEDIUM' | 'HIGH' required

The exposure level of the application under test.

identifierstring

An optional label for the run.

aiConnectionIdstring

The ID of the AI connection to target, you can find this in the Project Settings → AI Connections on the platform. Required for AI_CONNECTION mode.

promptAliasstring

The alias of the prompt to target. Required for PROMPT mode.

promptCommitstring

The prompt commit hash to target. Defaults to the latest commit on the prompt's main branch.

generationMode'AI_CONNECTION' | 'PROMPT'

The target type. Optional when exactly one of aiConnectionId or promptAlias is provided.

Response

successboolean required

Indicates if the risk assessment run was started.

linkstring

A link to view the risk assessment.

Changes