Airia

Airia Use Case Assessments API

The UseCaseAssessments API from Airia — 5 operation(s) for usecaseassessments.

GitHub OpenAPI

Operations 8

GET /v1/governance/usecases/{useCaseId}/assessments Use case assessments get by use case2 #
POST /v1/governance/usecases/{useCaseId}/assessments Use case assessments create2 #
GET /v1/governance/usecases/{useCaseId}/assessments/suggested-templates Use case assessments get suggested templates2 #
GET /v1/governance/usecases/{useCaseId}/assessments/{id} Use case assessments get by id2 #
PUT /v1/governance/usecases/{useCaseId}/assessments/{id} Use case assessments update2 #
DELETE /v1/governance/usecases/{useCaseId}/assessments/{id} Use case assessments delete2 #
POST /v1/governance/usecases/{useCaseId}/assessments/{id}/auto-complete Use case assessments auto complete2 #
POST /v1/governance/usecases/{useCaseId}/assessments/{id}/rerun Use case assessments rerun2 #

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-usecaseassessments-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-usecaseassessments-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-usecaseassessments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Airia Web Use Case Assessments API
  version: 1.0.0
servers:
- url: https://api.airia.ai
tags:
- name: UseCaseAssessments
paths:
  /v1/governance/usecases/{useCaseId}/assessments:
    get:
      tags:
      - UseCaseAssessments
      operationId: UseCaseAssessments_GetByUseCase2
      parameters:
      - name: useCaseId
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 1
      - name: PageNumber
        in: query
        schema:
          type: integer
          format: int32
        x-position: 2
      - name: PageSize
        in: query
        schema:
          type: integer
          format: int32
        x-position: 3
      - name: SortBy
        in: query
        schema:
          type:
          - string
          - 'null'
        x-position: 4
      - name: SortDirection
        in: query
        schema:
          type: string
        x-position: 5
      - name: filter
        in: query
        schema:
          type:
          - string
          - 'null'
        x-position: 6
      - name: status
        in: query
        schema:
          oneOf:
          - oneOf:
            - $ref: '#/components/schemas/AssessmentStatus'
        x-position: 7
      - name: x-correlation-id
        in: header
        schema:
          type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedResultOfAssessmentListDto'
        401:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Use case assessments get by use case2
      x-summary-source: derived
    post:
      tags:
      - UseCaseAssessments
      operationId: UseCaseAssessments_Create2
      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/CreateAssessmentRequest'
        required: true
        x-position: 2
      responses:
        201:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssessmentDetailDto'
        400:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        409:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Use case assessments create2
      x-summary-source: derived
  /v1/governance/usecases/{useCaseId}/assessments/suggested-templates:
    get:
      tags:
      - UseCaseAssessments
      operationId: UseCaseAssessments_GetSuggestedTemplates2
      parameters:
      - name: useCaseId
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 1
      - name: category
        in: query
        schema:
          oneOf:
          - oneOf:
            - $ref: '#/components/schemas/AssessmentTemplateCategory'
        x-position: 2
      - name: subCategories
        in: query
        style: form
        explode: true
        schema:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AssessmentTemplateSubCategory'
        x-position: 3
      - name: excludeSubCategories
        in: query
        style: form
        explode: true
        schema:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AssessmentTemplateSubCategory'
        x-position: 4
      - name: x-correlation-id
        in: header
        schema:
          type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AssessmentTemplateListDto'
        401:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Use case assessments get suggested templates2
      x-summary-source: derived
  /v1/governance/usecases/{useCaseId}/assessments/{id}:
    get:
      tags:
      - UseCaseAssessments
      operationId: UseCaseAssessments_GetById2
      parameters:
      - name: useCaseId
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 1
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 2
      - name: x-correlation-id
        in: header
        schema:
          type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssessmentDetailDto'
        404:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Use case assessments get by id2
      x-summary-source: derived
    put:
      tags:
      - UseCaseAssessments
      operationId: UseCaseAssessments_Update2
      parameters:
      - name: useCaseId
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 1
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 2
      - name: x-correlation-id
        in: header
        schema:
          type: string
      requestBody:
        x-name: request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAssessmentRequest'
        required: true
        x-position: 3
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssessmentDetailDto'
        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'
      summary: Use case assessments update2
      x-summary-source: derived
    delete:
      tags:
      - UseCaseAssessments
      operationId: UseCaseAssessments_Delete2
      parameters:
      - name: useCaseId
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 1
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 2
      - name: x-correlation-id
        in: header
        schema:
          type: string
      responses:
        204:
          description: ''
        404:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        409:
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Use case assessments delete2
      x-summary-source: derived
  /v1/governance/usecases/{useCaseId}/assessments/{id}/auto-complete:
    post:
      tags:
      - UseCaseAssessments
      operationId: UseCaseAssessments_AutoComplete2
      parameters:
      - name: useCaseId
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 1
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 2
      - name: x-correlation-id
        in: header
        schema:
          type: string
      requestBody:
        x-name: request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AutoCompleteAssessmentRequest'
        required: true
        x-position: 3
      responses:
        202:
          description: ''
        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'
      summary: Use case assessments auto complete2
      x-summary-source: derived
  /v1/governance/usecases/{useCaseId}/assessments/{id}/rerun:
    post:
      tags:
      - UseCaseAssessments
      operationId: UseCaseAssessments_Rerun2
      parameters:
      - name: useCaseId
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 1
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: guid
        x-position: 2
      - name: x-correlation-id
        in: header
        schema:
          type: string
      requestBody:
        x-name: request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AutoCompleteAssessmentRequest'
        required: true
        x-position: 3
      responses:
        202:
          description: ''
        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'
      summary: Use case assessments rerun2
      x-summary-source: derived
components:
  schemas:
    AssessmentTemplateScope:
      type: string
      description: ''
      x-enumNames:
      - Organization
      - UseCase
      - Asset
      enum:
      - Organization
      - UseCase
      - Asset
    AssessmentTemplateCategory:
      type: string
      description: ''
      x-enumNames:
      - Exploratory
      - Attestation
      enum:
      - Exploratory
      - Attestation
    UpdateAssessmentRequest:
      type: object
      additionalProperties: false
      properties:
        name:
          type:
          - string
          - 'null'
        version:
          type:
          - string
          - 'null'
        status:
          oneOf:
          - $ref: '#/components/schemas/AssessmentStatus'
        approverId:
          type:
          - string
          - 'null'
          format: guid
        responses:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/AssessmentResponseWriteItemDto'
        fileId:
          type:
          - string
          - 'null'
    CreateAssessmentRequest:
      type: object
      additionalProperties: false
      properties:
        name:
          type: string
        templateId:
          type: string
          format: guid
        templateVersionId:
          type: string
          format: guid
        version:
          type: string
        approverId:
          type: string
          format: guid
        fileId:
          type:
          - string
          - 'null'
        originId:
          type:
          - string
          - 'null'
          format: guid
        originSource:
          type:
          - string
          - 'null'
        originContext:
          type:
          - object
          - 'null'
          additionalProperties:
            type: string
    AssessmentQuestionOptionDto:
      type: object
      additionalProperties: false
      properties:
        optionText:
          type: string
        optionValue:
          type: string
    AutoCompleteAssessmentRequest:
      type: object
      additionalProperties: false
      properties:
        includeExecutionLogs:
          type: boolean
        logSampleSize:
          type: integer
          format: int32
          maximum: 1000
          minimum: 1
        confidenceThreshold:
          type: number
          format: double
          maximum: 1
          minimum: 0
    AssessmentResponseWriteItemDto:
      type: object
      additionalProperties: false
      properties:
        sectionName:
          type: string
        question:
          type: string
        questionType:
          type: string
        answer:
          type: string
        confidence:
          type:
          - number
          - 'null'
          format: double
        reasoning:
          type: string
    AssessmentResponseItemDto:
      type: object
      additionalProperties: false
      properties:
        sectionName:
          type: string
        question:
          type: string
        questionType:
          type: string
        answer:
          type: string
        options:
          type: array
          items:
            $ref: '#/components/schemas/AssessmentQuestionOptionDto'
        guidance:
          type: string
        clauseReference:
          type: string
        confidence:
          type:
          - number
          - 'null'
          format: double
        reasoning:
          type: string
        abstained:
          type: boolean
    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'
    AssessmentListDto:
      type: object
      additionalProperties: false
      properties:
        id:
          type: string
          format: guid
        name:
          type: string
        templateName:
          type:
          - string
          - 'null'
        category:
          oneOf:
          - $ref: '#/components/schemas/AssessmentTemplateCategory'
        subCategories:
          type: array
          items:
            $ref: '#/components/schemas/AssessmentTemplateSubCategory'
        templateId:
          type: string
          format: guid
        templateVersionId:
          type: string
          format: guid
        templateVersionNumber:
          type: integer
          format: int32
        newerVersionAvailable:
          type: boolean
        version:
          type: string
        status:
          $ref: '#/components/schemas/AssessmentStatus'
        lastCompletedAt:
          type:
          - string
          - 'null'
          format: date-time
        needsReReview:
          type: boolean
        approverId:
          type: string
          format: guid
        userId:
          type:
          - string
          - 'null'
          format: guid
        createdAt:
          type: string
          format: date-time
        fileId:
          type:
          - string
          - 'null'
        updatedAt:
          type: string
          format: date-time
        originId:
          type:
          - string
          - 'null'
          format: guid
        originSource:
          type:
          - string
          - 'null'
        originContext:
          type:
          - object
          - 'null'
          additionalProperties:
            type: string
    AssessmentTemplateListDto:
      type: object
      additionalProperties: false
      properties:
        id:
          type: string
          format: guid
        name:
          type: string
        description:
          type: string
        category:
          $ref: '#/components/schemas/AssessmentTemplateCategory'
        scope:
          $ref: '#/components/schemas/AssessmentTemplateScope'
        subCategories:
          type: array
          items:
            $ref: '#/components/schemas/AssessmentTemplateSubCategory'
        frameworkId:
          type: string
          format: guid
        frameworkName:
          type:
          - string
          - 'null'
        frameworkKey:
          type:
          - string
          - 'null'
        isSystemManaged:
          type: boolean
        latestPublishedVersionNumber:
          type:
          - integer
          - 'null'
          format: int32
        latestPublishedVersionId:
          type:
          - string
          - 'null'
          format: guid
        hasDraft:
          type: boolean
        questionCount:
          type: integer
          format: int32
        isActive:
          type: boolean
        hasAssessments:
          type: boolean
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        userId:
          type:
          - string
          - 'null'
          format: guid
    AssessmentStatus:
      type: string
      description: ''
      x-enumNames:
      - Draft
      - Pending
      - Approved
      - Rejected
      - AutoComplete
      - ReadyForReview
      - AutoCompleteFailed
      enum:
      - Draft
      - Pending
      - Approved
      - Rejected
      - AutoComplete
      - ReadyForReview
      - AutoCompleteFailed
    AssessmentTemplateSubCategory:
      type: string
      description: ''
      x-enumNames:
      - Impact
      - Risk
      - Vendor
      - Register
      enum:
      - Impact
      - Risk
      - Vendor
      - Register
    AssessmentDetailDto:
      allOf:
      - $ref: '#/components/schemas/AssessmentListDto'
      - type: object
        additionalProperties: false
        properties:
          parsedResponses:
            type: array
            items:
              $ref: '#/components/schemas/AssessmentResponseItemDto'
          aiAssetAggregateId:
            type: string
            format: guid
    PagedResultOfAssessmentListDto:
      type: object
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/AssessmentListDto'
        totalCount:
          type: integer
          format: int32
  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))