Airia

Airia Use Case Risk Analysis API

The UseCaseRiskAnalysis API from Airia — 4 operation(s) for usecaseriskanalysis.

GitHub OpenAPI
Business capability
Artificial Intelligence Management BC-610.60

Operations 4

POST /v1/governance/usecases/{useCaseId}/risk-analysis Use case risk analysis start2 #
POST /v1/governance/usecases/{useCaseId}/risk-analysis/recompute Use case risk analysis recompute2 #
GET /v1/governance/usecases/{useCaseId}/risk-analysis/status Use case risk analysis get status2 #
GET /v1/governance/usecases/{useCaseId}/risk-analysis/profile Use case risk analysis get profile2 #

Documentation

📖
APIReference
https://api.airia.ai/docs/
📖
Documentation
https://airia.ai/docs/build/interface-options/api-deployment
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/airia/refs/heads/main/authentication/airia-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/airia/refs/heads/main/openapi/airia-usecaseriskanalysis-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/airia/refs/heads/main/errors/airia-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/airia/refs/heads/main/conventions/airia-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/airia/refs/heads/main/data-model/airia-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/airia/refs/heads/main/asyncapi/airia-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/airia:airia-usecaseriskanalysis-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

airia-usecaseriskanalysis-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Airia Web Use Case Risk Analysis API
  version: 1.0.0
servers:
- url: https://api.airia.ai
tags:
- name: UseCaseRiskAnalysis
paths:
  /v1/governance/usecases/{useCaseId}/risk-analysis:
    post:
      tags:
      - UseCaseRiskAnalysis
      operationId: UseCaseRiskAnalysis_Start2
      parameters:
      - name: useCaseId
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 1
      - name: x-correlation-id
        in: header
        schema:
          type: string
      requestBody:
        x-name: request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RiskAnalysisStartRequest'
        required: true
        x-position: 2
      responses:
        202:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RiskAnalysisRunStatusDto'
        400:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        404:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        409:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        500:
          description: ''
      summary: Use case risk analysis start2
      x-summary-source: derived
  /v1/governance/usecases/{useCaseId}/risk-analysis/recompute:
    post:
      tags:
      - UseCaseRiskAnalysis
      operationId: UseCaseRiskAnalysis_Recompute2
      parameters:
      - name: useCaseId
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 1
      - name: x-correlation-id
        in: header
        schema:
          type: string
      requestBody:
        x-name: request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RiskRecomputeRequest'
        x-position: 2
      responses:
        202:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RiskAnalysisRunStatusDto'
        400:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        404:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        409:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        500:
          description: ''
      summary: Use case risk analysis recompute2
      x-summary-source: derived
  /v1/governance/usecases/{useCaseId}/risk-analysis/status:
    get:
      tags:
      - UseCaseRiskAnalysis
      operationId: UseCaseRiskAnalysis_GetStatus2
      parameters:
      - name: useCaseId
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 1
      - name: stage
        in: query
        schema:
          default: Register
          oneOf:
          - $ref: '#/components/schemas/UseCaseStage'
        x-position: 2
      - name: x-correlation-id
        in: header
        schema:
          type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RiskAnalysisRunStatusDto'
        204:
          description: ''
      summary: Use case risk analysis get status2
      x-summary-source: derived
  /v1/governance/usecases/{useCaseId}/risk-analysis/profile:
    get:
      tags:
      - UseCaseRiskAnalysis
      operationId: UseCaseRiskAnalysis_GetProfile2
      parameters:
      - name: useCaseId
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 1
      - name: x-correlation-id
        in: header
        schema:
          type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RiskProfileDto'
        204:
          description: ''
      summary: Use case risk analysis get profile2
      x-summary-source: derived
components:
  schemas:
    RiskAnalysisRunStatusDto:
      type: object
      additionalProperties: false
      required:
      - runId
      - useCaseId
      - state
      properties:
        runId:
          type: string
          format: guid
        useCaseId:
          type: string
          format: guid
        state:
          type: string
        runType:
          type: string
        isInProgress:
          type: boolean
        startedAt:
          type:
          - string
          - 'null'
          format: date-time
        completedAt:
          type:
          - string
          - 'null'
          format: date-time
        failureReason:
          type:
          - string
          - 'null'
        attemptCount:
          type: integer
          format: int32
        contextGaps:
          type: array
          items:
            type: string
    RiskProfileSubdomainDto:
      type: object
      additionalProperties: false
      properties:
        domainName:
          type:
          - string
          - 'null'
        subDomainName:
          type:
          - string
          - 'null'
        code:
          type:
          - string
          - 'null'
        riskSubDomainId:
          type: string
          format: guid
        applicable:
          type: boolean
        confidence:
          type:
          - string
          - 'null'
        rationale:
          type:
          - string
          - 'null'
        inherentImpact:
          type:
          - integer
          - 'null'
          format: int32
        inherentLikelihood:
          type:
          - integer
          - 'null'
          format: int32
        inherentScore:
          type:
          - integer
          - 'null'
          format: int32
        residualImpact:
          type:
          - integer
          - 'null'
          format: int32
        residualLikelihood:
          type:
          - integer
          - 'null'
          format: int32
        residualScore:
          type:
          - integer
          - 'null'
          format: int32
        inherentLikelihoodDrivers:
          oneOf:
          - $ref: '#/components/schemas/LikelihoodDriversDto'
        residualLikelihoodDrivers:
          oneOf:
          - $ref: '#/components/schemas/LikelihoodDriversDto'
        inherentLevel:
          type:
          - string
          - 'null'
        residualLevel:
          type:
          - string
          - 'null'
        inherentUnknownFields:
          type: array
          items:
            type: string
        residualUnknownFields:
          type: array
          items:
            type: string
    RiskScoreFrameworkContributionDto:
      type: object
      additionalProperties: false
      required:
      - frameworkKey
      - score
      properties:
        frameworkKey:
          type: string
        score:
          type: integer
          format: int32
    RiskProfileFrameworkDto:
      type: object
      additionalProperties: false
      required:
      - frameworkKey
      properties:
        frameworkKey:
          type: string
        classificationValue:
          type:
          - string
          - 'null'
        confidence:
          type:
          - string
          - 'null'
        rationale:
          type:
          - string
          - 'null'
        applicability:
          type:
          - string
          - 'null'
    UseCaseStage:
      type: string
      description: ''
      x-enumNames:
      - Discover
      - Register
      - Triage
      - Assess
      - BuildAndConnect
      - Mitigate
      - Approve
      - Monitor
      - Quarantine
      - Change
      - Archive
      enum:
      - Discover
      - Register
      - Triage
      - Assess
      - BuildAndConnect
      - Mitigate
      - Approve
      - Monitor
      - Quarantine
      - Change
      - Archive
    ProblemDetails:
      type: object
      additionalProperties: {}
      properties:
        type:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
    RiskProfileDto:
      type: object
      additionalProperties: false
      properties:
        governanceScoreInherent:
          type:
          - integer
          - 'null'
          format: int32
        governanceScoreResidual:
          type:
          - integer
          - 'null'
          format: int32
        governanceLevel:
          type:
          - string
          - 'null'
        needsInherentRerun:
          type: boolean
        needsResidualRerun:
          type: boolean
        frameworks:
          type: array
          items:
            $ref: '#/components/schemas/RiskProfileFrameworkDto'
        subdomains:
          type: array
          items:
            $ref: '#/components/schemas/RiskProfileSubdomainDto'
        evidenceRequests:
          type: array
          items:
            $ref: '#/components/schemas/RiskEvidenceRequestDto'
        scoreBreakdownInherent:
          oneOf:
          - $ref: '#/components/schemas/RiskScoreBreakdownDto'
        scoreBreakdownResidual:
          oneOf:
          - $ref: '#/components/schemas/RiskScoreBreakdownDto'
    RiskEvidenceRequestDto:
      type: object
      additionalProperties: false
      required:
      - subDomainName
      - field
      - phase
      properties:
        subDomainName:
          type: string
        field:
          type: string
        phase:
          type: string
    RiskScoreBreakdownDto:
      type: object
      additionalProperties: false
      properties:
        frameworkScore:
          type:
          - integer
          - 'null'
          format: int32
        frameworkWeight:
          type: number
          format: double
        subdomainAggregate:
          type:
          - integer
          - 'null'
          format: int32
        subdomainWeight:
          type: number
          format: double
        combined:
          type: integer
          format: int32
        frameworkContributions:
          type: array
          items:
            $ref: '#/components/schemas/RiskScoreFrameworkContributionDto'
        drivingFrameworkKey:
          type:
          - string
          - 'null'
        unknownDriven:
          type: boolean
        mediumThreshold:
          type: integer
          format: int32
        highThreshold:
          type: integer
          format: int32
        criticalThreshold:
          type: integer
          format: int32
        regulatoryFloor:
          type:
          - integer
          - 'null'
          format: int32
    LikelihoodDriversDto:
      type: object
      additionalProperties: false
      required:
      - exposure
      - autonomy
      - opFrequency
      - inputSurface
      properties:
        exposure:
          type: integer
          format: int32
        autonomy:
          type: integer
          format: int32
        opFrequency:
          type: integer
          format: int32
        inputSurface:
          type: integer
          format: int32
    RiskAnalysisStartRequest:
      type: object
      additionalProperties: false
      required:
      - useCaseDescription
      properties:
        useCaseDescription:
          type: string
          minLength: 1
        organizationalContext:
          type:
          - string
          - 'null'
    RiskRecomputeRequest:
      type: object
      additionalProperties: false
      properties:
        stage:
          oneOf:
          - $ref: '#/components/schemas/UseCaseStage'
  securitySchemes:
    ApiKey:
      type: apiKey
      description: API Key Authentication
      name: X-API-Key
      in: header
    Cookies:
      type: apiKey
      description: Cookie based Authentication
      name: Cookie
      in: header
x-generator: NSwag v14.7.1.0 (NJsonSchema v11.6.1.0 (Newtonsoft.Json v13.0.0.0))