openapi: 3.2.0
info:
  description: Credo AI server API
  title: Credo AI server Models API
servers:
- url: /api/v2/credoai
tags:
- name: models
  description: Operations related to models and model versions
paths:
  /models/{model_id}/files:
    get:
      description: Retrieve a list of files associated with a specific model.
      operationId: CredoAIWeb.API.V2.Model.FileController.index
      parameters:
      - description: The unique ID of the model whose files are being retrieved.
        in: path
        name: model_id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ModelFilesResponse'
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
        '403':
          description: Forbidden
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - models
    post:
      description: Upload a new file for a specific model.
      operationId: CredoAIWeb.API.V2.Model.FileController.create
      parameters:
      - description: The unique ID of the model for whom the file is being created.
        in: path
        name: model_id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ModelFileResponse'
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
        '403':
          description: Forbidden
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Not Found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - models
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/ModelFileCreateRequest'
        description: The attributes of the file to be created.
  /models/{model_id}/questionnaires/{id}:
    delete:
      description: Remove a specific questionnaire from a model's collection.
      operationId: CredoAIWeb.API.V2.Model.QuestionnaireController.delete
      parameters:
      - description: The unique ID of the model.
        in: path
        name: model_id
        required: true
        schema:
          type: string
      - description: The unique ID of the questionnaire to be deleted.
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
        '403':
          description: Forbidden
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Not Found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - models
    patch:
      description: Update the version of a specific questionnaire for a model.
      operationId: CredoAIWeb.API.V2.Model.QuestionnaireController.update
      parameters:
      - description: The unique ID of the model.
        in: path
        name: model_id
        required: true
        schema:
          type: string
      - description: The unique ID of the questionnaire to be updated.
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ModelQuestionnaireResponse'
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
        '403':
          description: Forbidden
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Not Found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - models
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/ModelQuestionnaireUpdateRequest'
        description: The attributes for updating the questionnaire.
  /models/{model_id}/vendor_links:
    get:
      description: Retrieve a list of vendor links associated with a specific model.
      operationId: CredoAIWeb.API.V2.Model.VendorLinkController.index
      parameters:
      - description: The unique ID of the model.
        in: path
        name: model_id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ModelVendorLinksResponse'
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - models
    post:
      description: Create a new vendor link for a specific model.
      operationId: CredoAIWeb.API.V2.Model.VendorLinkController.create
      parameters:
      - description: The unique ID of the model.
        in: path
        name: model_id
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ModelVendorLinkResponse'
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
        '403':
          description: Forbidden
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Not Found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - models
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/ModelVendorLinkCreateRequest'
        description: The attributes for the new vendor link.
  /models/{model_id}/vendor_links/{id}:
    delete:
      description: Delete a specific vendor link associated with a model.
      operationId: CredoAIWeb.API.V2.Model.VendorLinkController.delete
      parameters:
      - description: The unique ID of the model.
        in: path
        name: model_id
        required: true
        schema:
          type: string
      - description: The unique ID of the vendor link to be deleted.
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
        '403':
          description: Forbidden
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Not Found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - models
  /models/{model_id}/custom_fields:
    get:
      description: Retrieve a list of all custom fields associated with a specific model.
      operationId: CredoAIWeb.API.V2.Model.CustomFieldController.index
      parameters:
      - description: The unique ID of the model.
        in: path
        name: model_id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ModelCustomFieldsResponse'
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
        '404':
          description: Not Found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - models
  /models/{model_id}/versions/{id}:
    delete:
      description: Delete a specific model version identified by its unique ID.
      operationId: CredoAIWeb.API.V2.Model.VersionController.delete
      parameters:
      - description: The unique identifier of the model.
        in: path
        name: model_id
        required: true
        schema:
          type: string
      - description: The unique identifier of the model version.
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
        '403':
          description: Forbidden
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Not Found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - models
    get:
      description: Retrieve details of a specific model version identified by its unique ID.
      operationId: CredoAIWeb.API.V2.Model.VersionController.show
      parameters:
      - description: The unique identifier of the model.
        in: path
        name: model_id
        required: true
        schema:
          type: string
      - description: The unique identifier of the model version.
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ModelVersionResponse'
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
        '404':
          description: Not Found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - models
    patch:
      description: Update the attributes of a specific model version identified by its unique ID.
      operationId: CredoAIWeb.API.V2.Model.VersionController.update
      parameters:
      - description: The unique identifier of the model.
        in: path
        name: model_id
        required: true
        schema:
          type: string
      - description: The unique identifier of the model version.
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ModelVersionResponse'
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
        '403':
          description: Forbidden
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Not Found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - models
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/ModelVersionUpdateRequest'
        description: Updated attributes for the model version.
  /models/{id}:
    delete:
      description: Delete a specific model identified by its ID from the system.
      operationId: CredoAIWeb.API.V2.ModelController.delete
      parameters:
      - description: Unique identifier of the model to delete
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
        '403':
          description: Forbidden
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Not Found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - models
    get:
      description: Retrieve detailed information about a specific model identified by its ID.
      operationId: CredoAIWeb.API.V2.ModelController.show
      parameters:
      - description: user,model_project,workflows,metrics,stakeholders,tags,assets,vendors
        in: query
        name: include
        required: false
        x-example: user,model_project,workflows,metrics,stakeholders,tags,assets,vendors
        schema:
          type: string
      - description: Unique identifier of the model to retrieve
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ModelResponse'
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
        '404':
          description: Not Found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - models
    patch:
      description: Update the attributes of an existing model identified by its ID.
      operationId: CredoAIWeb.API.V2.ModelController.update
      parameters:
      - description: Unique identifier of the model to update
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ModelResponse'
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
        '403':
          description: Forbidden
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Not Found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - models
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/ModelUpdateRequest'
        description: Attributes to update the model
  /models/{model_id}/questionnaire_sections/{section_id}/tasks:
    post:
      description: Creates a new task for a model questionnaire section
      operationId: CredoAIWeb.API.V2.Model.Questionnaire.SectionController.create_task
      parameters:
      - description: The unique ID of the model
        in: path
        name: model_id
        required: true
        schema:
          type: string
      - description: The unique ID of the questionnaire section
        in: path
        name: section_id
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/TaskResponse'
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
        '403':
          description: Forbidden
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Not Found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - models
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/TaskResource'
        description: The task creation details
  /models:
    get:
      description: Retrieve a list of all models available in the system.
      operationId: CredoAIWeb.API.V2.ModelController.index
      parameters:
      - description: page after cursor
        in: query
        name: page[after]
        required: false
        schema:
          type: string
      - description: page before cursor
        in: query
        name: page[before]
        required: false
        schema:
          type: string
      - description: page limit
        in: query
        name: page[limit]
        required: false
        schema:
          type: integer
      - description: sort options
        in: query
        name: sort
        required: false
        x-example: -inserted_at
        schema:
          type: string
      - description: name filter type
        in: query
        name: filter[name][type]
        required: false
        schema:
          type: string
      - description: name filter value
        in: query
        name: filter[name][value]
        required: false
        schema:
          type: string
      - description: Filter models by tag name
        in: query
        name: filter[tags.name][]
        required: false
        schema:
          type: string
      - description: Filter models by their unique identifier
        in: query
        name: filter[id][]
        required: false
        schema:
          type: string
      - description: Filter models by source
        in: query
        name: filter[source]
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ModelsPageResponse'
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - models
    post:
      description: Create a new model with the specified attributes.
      operationId: CredoAIWeb.API.V2.ModelController.create
      responses:
        '201':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ModelResponse'
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
        '403':
          description: Forbidden
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - models
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/ModelCreateRequest'
        description: Attributes required to create a new model
  /models/{model_id}/questionnaire_sections/{section_id}:
    get:
      description: Retrieves a specific questionnaire section for a model
      operationId: CredoAIWeb.API.V2.Model.Questionnaire.SectionController.show
      parameters:
      - description: The unique ID of the model
        in: path
        name: model_id
        required: true
        schema:
          type: string
      - description: The unique ID of the questionnaire section
        in: path
        name: section_id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ModelQuestionnaireSectionResponse'
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
        '403':
          description: Forbidden
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Not Found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - models
  /models/{model_id}/questionnaires:
    get:
      description: Retrieve a list of all questionnaires associated with a specific model.
      operationId: CredoAIWeb.API.V2.Model.QuestionnaireController.index
      parameters:
      - description: The unique ID of the model.
        in: path
        name: model_id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ModelQuestionnairesResponse'
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
        '404':
          description: Not Found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - models
    post:
      description: Create a new questionnaire for a specific model.
      operationId: CredoAIWeb.API.V2.Model.QuestionnaireController.create
      parameters:
      - description: The unique ID of the model.
        in: path
        name: model_id
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ModelQuestionnaireResponse'
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
        '403':
          description: Forbidden
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Not Found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - models
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/ModelQuestionnaireCreateRequest'
        description: The attributes for the new questionnaire.
  /models/{model_id}/evidences/{id}:
    delete:
      description: Deactivate a specific evidence for the given model.
      operationId: CredoAIWeb.API.V2.Model.EvidenceController.delete
      parameters:
      - description: The unique ID of the model.
        in: path
        name: model_id
        required: true
        schema:
          type: string
      - description: The unique ID of the evidence to be deactivated.
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
        '403':
          description: Forbidden
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Not Found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - models
  /models/{model_id}/versions:
    get:
      description: Retrieve a list of all model versions associated with the specified model.
      operationId: CredoAIWeb.API.V2.Model.VersionController.index
      parameters:
      - description: The unique identifier of the model.
        in: path
        name: model_id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ModelVersionsResponse'
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - models
    post:
      description: Create a new version for the specified model with the provided attributes.
      operationId: CredoAIWeb.API.V2.Model.VersionController.create
      parameters:
      - description: The unique identifier of the model.
        in: path
        name: model_id
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ModelVersionResponse'
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
        '403':
          description: Forbidden
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - models
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/ModelVersionCreateRequest'
        description: Attributes for the new model version.
  /models/{model_id}/questionnaire_sections/{section_id}/evidences:
    get:
      description: List all evidences for a specific questionnaire section in a model.
      operationId: CredoAIWeb.API.V2.Model.Questionnaire.SectionEvidenceController.index
      parameters:
      - description: The unique ID of the model.
        in: path
        name: model_id
        required: true
        schema:
          type: string
      - description: The unique ID of the questionnaire section.
        in: path
        name: section_id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ModelEvidencesResponse'
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
        '404':
          description: Not Found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - models
    post:
      description: Create a new evidence for a specific questionnaire section in a model.
      operationId: CredoAIWeb.API.V2.Model.Questionnaire.SectionEvidenceController.create
      parameters:
      - description: The unique ID of the model.
        in: path
        name: model_id
        required: true
        schema:
          type: string
      - description: The unique ID of the questionnaire section.
        in: path
        name: section_id
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Created
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ModelEvidenceResponse'
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
        '403':
          description: Forbidden
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Not Found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - models
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/ModelEvidenceCreateRequest'
        description: The attributes for the new evidence.
  /models/{model_id}/evidences:
    get:
      description: Retrieve a list of active evidences associated with a specific model.
      operationId: CredoAIWeb.API.V2.Model.EvidenceController.index
      parameters:
      - description: type match filter
        in: query
        name: filter[type]
        required: false
        schema:
          type: string
      - description: sort options
        in: query
        name: sort
        required: false
        x-example: -inserted_at
        schema:
          type: string
      - description: The unique ID of the model.
        in: path
        name: model_id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ModelEvidencesResponse'
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - models
  /models/{model_id}/files/{id}:
    delete:
      description: Delete a specific file associated with a model by its unique ID.
      operationId: CredoAIWeb.API.V2.Model.FileController.delete
      parameters:
      - description: The unique ID of the model whose file is to be deleted.
        in: path
        name: model_id
        required: true
        schema:
          type: string
      - description: The unique ID of the file to be deleted.
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/AuthError'
        '403':
          description: Forbidden
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '404':
          description: Not Found
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
      security:
      - Bearer: []
      summary: ''
      tags:
      - models
components:
  schemas:
    ModelFileResource:
      description: ''
      properties:
        attributes:
          properties:
            content_type:
              description: ''
              type: string
            entity_id:
              description: ''
              type: string
            filename:
              description: ''
              type: string
            inserted_at:
              description: ''
              type: string
            model_id:
              description: ''
              type: string
            size:
              description: ''
              type: string
            updated_at:
              description: ''
              type: string
            url:
              description: ''
              type: string
          type: object
        id:
          description: The JSON-API resource ID
          example: 64YUaLWSviHgibJaRWr3ZE
          type: string
        relationships:
          properties: {}
          type: object
        type:
          description: The JSON-API resource type
          example: model_files
          type: string
      type: object
    ModelVersionUpdateRequest:
      description: ''
      properties:
        data:
          description: ''
          properties:
            attributes:
              properties:
                description:
                  description: ''
                  type: string
              type: object
            id:
              description: The JSON-API resource ID
              example: 64YUaLWSviHgibJaRWr3ZE
              type: string
            type:
              description: The JSON-API resource type
              example: resource-type
              type: string
          type: object
      type: object
    TaskResponse:
      description: A JSON-API document with a single [TaskResource](#taskresource) resource
      properties:
        data:
          $ref: '#/components/schemas/TaskResource'
        included:
          description: Included resources
          items:
            properties:
              id:
                description: The JSON-API resource ID
                type: string
              type:
                description: The JSON-API resource type
                type: string
            type: object
          type: array
      required:
      - data
      type: object
    ModelQuestionnairesResponse:
      description: A collection of [ModelQuestionnaireResource](#modelquestionnaireresource)
      properties:
        data:
          description: Content with [ModelQuestionnaireResource](#modelquestionnaireresource) objects
          items:
            $ref: '#/components/schemas/ModelQuestionnaireResource'
          type: array
      required:
      - data
      type: object
    ModelEvidenceCreateRequest:
      description: ''
      properties:
        data:
          description: ''
          properties:
            attributes:
              properties:
                data:
                  description: value data
                  example:
                    value: This is text evidence
                  type: object
                generated_at:
                  description: evidence generated time
                  example: '2022-05-03T11:33:25.582138Z'
                  type: string
                question_id:
                  description: question id
                  type: string
              required:
              - question_id
              - data
              type: object
            id:
              description: The JSON-API resource ID
              example: 64YUaLWSviHgibJaRWr3ZE
              type: string
            type:
              description: The JSON-API resource type
              example: resource-type
              type: string
          type: object
      type: object
    ModelFilesResponse:
      description: A collection of [ModelFileResource](#modelfileresource)
      properties:
        data:
          description: Content with [ModelFileResource](#modelfileresource) objects
          items:
            $ref: '#/components/schemas/ModelFileResource'
          type: array
      required:
      - data
      type: object
    ModelCreateRequest:
      description: ''
      properties:
        data:
          description: ''
          properties:
            attributes:
              properties:
                name:
                  description: Model name
                  type: string
                questionnaire_ids:
                  description: Questionnaire Version IDs To Include
                  example:
                  - MODEL-QUEST+1
                  - MODEL-EVAL+2
                  items: string
                  type: array
                source:
                  description: ''
                  type: string
                summary:
                  description: ''
                  type: string
              required:
              - name
              type: object
            type:
              description: The JSON-API resource type
              example: resource-type
              type: string
          type: object
      type: object
    ModelCustomFieldsResponse:
      description: A collection of [ModelCustomFieldResource](#modelcustomfieldresource)
      properties:
        data:
          description: Content with [ModelCustomFieldResource](#modelcustomfieldresource) objects
          items:
            $ref: '#/components/schemas/ModelCustomFieldResource'
          type: array
      required:
      - data
      type: object
    ModelVendorLinkCreateRequest:
      description: ''
      properties:
        data:
          description: ''
          properties:
            attributes:
              properties:
                model_id:
                  description: Model ID
                  type: string
              required:
              - model_id
              type: object
            type:
              description: The JSON-API resource type
              example: resource-type
              type: string
          type: object
      type: object
    ModelCustomFieldResource:
      description: ''
      properties:
        attributes:
          properties:
            custom_field_id:
              description: ''
              type: string
            entity_id:
              description: ''
              type: string
            model_id:
              description: ''
              type: string
            name:
              description: ''
              type: string
            value:
              description: ''
              type: string
          type: object
        id:
          description: The JSON-API resource ID
          example: 64YUaLWSviHgibJaRWr3ZE
          type: string
        relationships:
          properties:
            custom_field:
              properties:
                data:
                  properties:
                    id:
                      description: Related custom_field resource id
                      type: string
                    type:
                      description: Type of related custom_field resource
                      type: string
                  type: object
              type: object
          type: object
        type:
          description: The JSON-API resource type
          example: model_custom_fields
          type: string
      type: object
    ModelQuestionnaireResource:
      description: ''
      properties:
        attributes:
          properties:
            entity_id:
              description: ''
              type: string
            inserted_at:
              description: ''
              type: string
            key:
              description: ''
              type: string
            model_id:
              description: ''
              type: string
            updated_at:
              description: ''
              type: string
            version:
              description: ''
              type: string
          type: object
        id:
          description: The JSON-API resource ID
          example: 64YUaLWSviHgibJaRWr3ZE
          type: string
        relationships:
          properties: {}
          type: object
        type:
          description: The JSON-API resource type
          example: model_questionnaires
          type: string
      type: object
    ModelFileCreateRequest:
      description: ''
      properties:
        data:
          description: ''
          properties:
            attributes:
              properties:
                content:
                  description: Base 64 encoded file content
                  type: string
                content_type:
                  description: content type
                  type: string
                filename:
                  description: File name
                  type: string
                size:
                  description: File size
                  type: integer
              required:
              - content
              type: object
            type:
              description: The JSON-API resource type
              example: resource-type
              type: string
          type: object
      type: object
    TaskResource:
      description: ''
      properties:
        attributes:
          properties:
            assigner_id:
              description: ''
              type: string
            completed_at:
              description: ''
              type: string
            due_date:
              description: ''
              type: string
            entity_questionnaire_section_id:
              description: ''
              type: string
            inserted_at:
              description: ''
              type: string
            model_id:
              description: ''
              type: string
            status:
              description: ''
              type: string
            sub_status:
              description: ''
              type: string
            team_ids:
              description: ''
              type: string
            timezone:
              description: ''
              type: string
            type:
              description: ''
              type: string
            updated_at:
              description: ''
              type: string
            use_case_control_id:
              description: ''
              type: string
            use_case_id:
              description: ''
              type: string
            use_case_review_id:
              description: ''
              type: string
            user_ids:
              description: ''
              type: string
            vendor_id:
              description: ''
              type: string
          type: object
        id:
          description: The JSON-API resource ID
          example: 64YUaLWSviHgibJaRWr3ZE
          type: string
        relationships:
          properties:
            assigner:
              properties:
                data:
                  properties:
                    id:
                      description: Related assigner resource id
                      type: string
                    type:
                      description: Type of related assigner resource
                      type: string
                  type: object
              type: object
            entity_questionnaire_section:
              properties:
                data:
                  properties:
                    id:
                      description: Related entity_questionnaire_section resource id
                      type: string
                    type:
                      description: Type of related entity_questionnaire_section resource
                      type: string
                  type: object
              type: object
            model:
              properties:
                data:
                  properties:
                    id:
                      description: Related model resource id
                      type: string
                    type:
                      description: Type of related model resource
                      type: string
                  type: object
              type: object
            teams:
              properties:
                data:
                  properties:
                    id:
                      description: Related teams resource id
                      type: string
                    type:
                      description: Type of related teams resource
                      type: string
                  type: object
              type: object
            use_case:
              properties:
                data:
                  properties:
                    id:
                      description: Related use_case resource id
                      type: string
                    type:
                      description: Type of related use_case resource
                      type: string
                  type: object
              type: object
            use_case_control:
              properties:
                data:
                  properties:
                    id:
                      description: Related use_case_control resource id
                      type: string
                    type:
                      description: Type of related use_case_control resource
                      type: string
                  type: object
              type: object
            use_case_review:
              properties:
                data:
                  properties:
                    id:
                      description: Related use_case_review resource id
                      type: string
                    type:
                      description: Type of related use_case_review resource
                      type: string
                  type: object
              type: object
            users:
              properties:
                data:
                  properties:
                    id:
                      description: Related users resource id
                      type: string
                    type:
                      description: Type of related users resource
                      type: string
                  type: object
              type: object
            vendor:
              properties:
                data:
                  properties:
                    id:
                      description: Related vendor resource id
                      type: string
                    type:
                      description: Type of related vendor resource
                      type: string
                  type: object
              type: object
          type: object
        type:
          description: The JSON-API resource type
          example: tasks
          type: string
      type: object
    ModelVersionCreateRequest:
      description: ''
      properties:
        data:
          description: ''
          properties:
            attributes:
              properties:
                description:
                  description: ''
                  type: string
                version:
                  description: v1
                  type: string
              required:
              - version
              type: object
            type:
              description: The JSON-API resource type
              example: resource-type
              type: string
          type: object
      type: object
    ModelEvidenceResource:
      description: ''
      properties:
        attributes:
          properties:
            creator:
              description: ''
              type: string
            data:
              description: ''
              type: string
            entity_id:
              description: ''
              type: string
            generated_at:
              description: ''
              type: string
            hash_key:
              description: ''
              type: string
            inserted_at:
              description: ''
              type: string
            label:
              description: ''
              type: string
            metadata:
              description: ''
              type: string
            model_id:
              description: ''
              type: string
            type:
              description: ''
              type: string
          type: object
        id:
          description: The JSON-API resource ID
          example: 64YUaLWSviHgibJaRWr3ZE
          type: string
        relationships:
          properties:
            asset_links:
              properties:
                data:
                  properties:
                    id:
                      description: Related asset_links resource id
                      type: string
                    type:
                      description: Type of related asset_links resource
                      type: string
                  type: object
              type: object
          type: object
        type:
          description: The JSON-API resource type
          example: model_evidences
          type: string
      type: object
    ModelEvidenceResponse:
      description: A JSON-API document with a single [ModelEvidenceResource](#modelevidenceresource) resource
      properties:
        data:
          $ref: '#/components/schemas/ModelEvidenceResource'
        included:
          description: Included resources
          items:
            properties:
              id:
                description: The JSON-API resource ID
                type: string
              type:
                description: The JSON-API resource type
                type: string
            type: object
          type: array
      required:
      - data
      type: object
    ModelResponse:
      description: A JSON-API document with a single [ModelResource](#modelresource) resource
      properties:
        data:
          $ref: '#/components/schemas/ModelResource'
        included:
          description: Included resources
          items:
            properties:
              id:
                description: The JSON-API resource ID
                type: string
              type:
                description: The JSON-API resource type
                type: string
            type: object
          type: array
      required:
      - data
      type: object
    ModelVersionResource:
      description: ''
      properties:
        attributes:
          properties:
            description:
              description: ''
              type: string
            model_id:
              description: ''
              type: string
            version:
              description: ''
              type: string
          type: object
        id:
          description: The JSON-API resource ID
          example: 64YUaLWSviHgibJaRWr3ZE
          type: string
        relationships:
          properties: {}
          type: object
        type:
          description: The JSON-API resource type
          example: model_versions
          type: string
      type: object
    ModelVersionResponse:
      description: A JSON-API document with a single [ModelVersionResource](#modelversionresource) resource
      properties:
        data:
          $ref: '#/components/schemas/ModelVersionResource'
        included:
          description: Included resources
          items:
            properties:
              id:
                description: The JSON-API resource ID
                type: string
              type:
                description: The JSON-API resource type
                type: string
            type: object
          type: array
      required:
      - data
      type: object
    ModelQuestionnaireSectionResource:
      description: ''
      properties:
        attributes:
          properties:
            compliances:
              description: ''
              type: string
            entity_id:
              description: ''
              type: string
            inserted_at:
              description: ''
              type: string
            model_id:
              description: ''
              type: string
            questionnaire_id:
              description: ''
              type: string
            section_id:
              description: ''
              type: string
            status:
              description: ''
              type: string
            updated_at:
              description: ''
              type: string
          type: object
        id:
          description: The JSON-API resource ID
          example: 64YUaLWSviHgibJaRWr3ZE
          type: string
        relationships:
          properties:
            task:
              properties:
                data:
                  properties:
                    id:
                      description: Related task resource id
                      type: string
                    type:
                      description: Type of related task resource
                      type: string
                  type: object
              type: object
          type: object
        type:
          description: The JSON-API resource type
          example: model_questionnaire_sections
          type: string
      type: object
    ModelQuestionnaireSectionResponse:
      description: A collection of [ModelQuestionnaireSectionResource](#modelquestionnairesectionresource)
      properties:
        data:
          description: Content with [ModelQuestionnaireSectionResource](#modelquestionnairesectionresource) objects
          items:
            $ref: '#/components/schemas/ModelQuestionnaireSectionResource'
          type: array
      required:
      - data
      type: object
    ModelResource:
      description: ''
      properties:
        attributes:
          properties:
            configurable_risk_score_classification:
              description: ''
              type: string
            custom:
              description: ''
              type: string
            entity_id:
              description: ''
              type: string
            has_use_cases:
              description: ''
              type: string
            inserted_at:
              description: ''
              type: string
            name:
              description: ''
              type: string
            questionnaire_ids:
              description: ''
              type: string
            risk_classification_id:
              description: ''
              type: string
            risk_classification_level:
              description: ''
              type: string
            risk_classification_set_at:
              description: ''
              type: string
            risk_classification_set_by:
              description: ''
              type: string
            risk_classification_set_by_user_id:
              description: ''
              type: string
            source:
              description: ''
              type: string
            status:
              description: ''
              type: string
            summary:
              description: ''
              type: string
            updated_at:
              description: ''
              type: string
            user_id:
              description: ''
              type: string
            workflow_stage_id:
              description: ''
              type: string
            workflow_stage_step:
              description: ''
              type: string
            workflow_stage_step_status:
              description: ''
              type: string
          type: object
        id:
          description: The JSON-API resource ID
          example: 64YUaLWSviHgibJaRWr3ZE
          type: string
        relationships:
          properties:
            use_cases:
              properties:
                data:
                  items:
                    properties:
                      id:
                        description: Related use_cases resource id
                        type: string
                      type:
                        description: Type of related use_cases resource
                        type: string
                    type: object
                  type: array
              type: object
            user:
              properties:
                data:
                  properties:
                    id:
                      description: Related user resource id
                      type: string
                    type:
                      description: Type of related user resource
                      type: string
                  type: object
              type: object
            vendors:
              properties:
                data:
                  properties:
                    id:
                      description: Related vendors resource id
                      type: string
                    type:
                      description: Type of related vendors resource
                      type: string
                  type: object
              type: object
            versions:
              properties:
                data:
                  properties:
                    id:
                      description: Related versions resource id
                      type: string
                    type:
                      description: Type of related versions resource
                      type: string
                  type: object
              type: object
          type: object
        type:
          description: The JSON-API resource type
          example: models
          type: string
      type: object
    ModelVendorLinkResource:
      description: ''
      properties:
        attributes:
          properties:
            inserted_at:
              description: When the link was created
              type: datetime
            model_id:
              description: The ID of the model
              type: string
            updated_at:
              description: When the link was last updated
              type: datetime
            vendor_id:
              description: The ID of the vendor
              type: string
          type: object
        id:
          description: The JSON-API resource ID
          example: 64YUaLWSviHgibJaRWr3ZE
          type: string
        relationships:
          properties:
            model:
              properties:
                data:
                  properties:
                    id:
                      description: Related model resource id
                      type: string
                    type:
                      description: Type of related model resource
                      type: string
                  type: object
              type: object
            vendor:
              properties:
                data:
                  properties:
                    id:
                      description: Related vendor resource id
                      type: string
                    type:
                      description: Type of related vendor resource
                      type: string
                  type: object
              type: object
          type: object
        type:
          description: The JSON-API resource type
          example: model_vendor_links
          type: string
      type: object
    ForbiddenError:
      properties:
        errors:
          description: Errors
          items:
            properties:
              code:
                description: an application-specific error code, expressed as a string value.
                type: integer
              detail:
                description: a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
                type: string
              title:
                description: a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
                type: string
            type: object
          type: array
      type: object
    AuthError:
      properties:
        errors:
          description: Errors
          items:
            properties:
              code:
                description: an application-specific error code, expressed as a string value.
                type: integer
              detail:
                description: a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
                type: string
              title:
                description: a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
                type: string
            type: object
          type: array
      type: object
    ModelQuestionnaireCreateRequest:
      description: ''
      properties:
        data:
          description: ''
          properties:
            attributes:
              properties:
                key:
                  description: questionnaire key
                  type: string
                version:
                  description: questionnaire version
                  type: integer
              required:
              - key
              - version
              type: object
            id:
              description: The JSON-API resource ID
              example: 64YUaLWSviHgibJaRWr3ZE
              type: string
            type:
              description: The JSON-API resource type
              example: resource-type
              type: string
          type: object
      type: object
    ModelVendorLinkResponse:
      description: A JSON-API document with a single [ModelVendorLinkResource](#modelvendorlinkresource) resource
      properties:
        data:
          $ref: '#/components/schemas/ModelVendorLinkResource'
        included:
          description: Included resources
          items:
            properties:
              id:
                description: The JSON-API resource ID
                type: string
              type:
                description: The JSON-API resource type
                type: string
            type: object
          type: array
      required:
      - data
      type: object
    ModelVersionsResponse:
      description: A collection of [ModelVersionResource](#modelversionresource)
      properties:
        data:
          description: Content with [ModelVersionResource](#modelversionresource) objects
          items:
            $ref: '#/components/schemas/ModelVersionResource'
          type: array
      required:
      - data
      type: object
    ModelUpdateRequest:
      description: ''
      properties:
        data:
          description: ''
          properties:
            attributes:
              properties:
                name:
                  description: ''
                  type: string
                questionnaire_ids:
                  description: Questionnaire Version IDs To Include
                  example:
                  - MODEL-QUEST+1
                  - MODEL-EVAL+2
                  items: string
                  type: array
                source:
                  description: ''
                  type: string
                summary:
                  description: ''
                  type: string
              type: object
            id:
              description: The JSON-API resource ID
              example: 64YUaLWSviHgibJaRWr3ZE
              type: string
            type:
              description: The JSON-API resource type
              example: resource-type
              type: string
          type: object
      type: object
    ModelsPageResponse:
      description: A page of [ModelResource](#modelresource) results
      properties:
        data:
          description: Content with [ModelResource](#modelresource) objects
          items:
            $ref: '#/components/schemas/ModelResource'
          type: array
        meta:
          properties:
            after:
              description: after cursor for the next page resources
              type: string
            before:
              description: before cursor for the previous page resources
              type: string
            limit:
              description: number of resources limit applied to this request
              type: integer
          type: object
      required:
      - data
      type: object
    ModelQuestionnaireUpdateRequest:
      description: ''
      properties:
        data:
          description: ''
          properties:
            attributes:
              properties:
                version:
                  description: questionnaire version
                  type: integer
              required:
              - version
              type: object
            id:
              description: The JSON-API resource ID
              example: 64YUaLWSviHgibJaRWr3ZE
              type: string
            type:
              description: The JSON-API resource type
              example: resource-type
              type: string
          type: object
      type: object
    ModelFileResponse:
      description: A JSON-API document with a single [ModelFileResource](#modelfileresource) resource
      properties:
        data:
          $ref: '#/components/schemas/ModelFileResource'
        included:
          description: Included resources
          items:
            properties:
              id:
                description: The JSON-API resource ID
                type: string
              type:
                description: The JSON-API resource type
                type: string
            type: object
          type: array
      required:
      - data
      type: object
    ModelQuestionnaireResponse:
      description: A JSON-API document with a single [ModelQuestionnaireResource](#modelquestionnaireresource) resource
      properties:
        data:
          $ref: '#/components/schemas/ModelQuestionnaireResource'
        included:
          description: Included resources
          items:
            properties:
              id:
                description: The JSON-API resource ID
                type: string
              type:
                description: The JSON-API resource type
                type: string
            type: object
          type: array
      required:
      - data
      type: object
    ModelEvidencesResponse:
      description: A collection of [ModelEvidenceResource](#modelevidenceresource)
      properties:
        data:
          description: Content with [ModelEvidenceResource](#modelevidenceresource) objects
          items:
            $ref: '#/components/schemas/ModelEvidenceResource'
          type: array
      required:
      - data
      type: object
    ModelVendorLinksResponse:
      description: A page of [ModelVendorLinkResource](#modelvendorlinkresource) results
      properties:
        data:
          description: Content with [ModelVendorLinkResource](#modelvendorlinkresource) objects
          items:
            $ref: '#/components/schemas/ModelVendorLinkResource'
          type: array
        meta:
          properties:
            after:
              description: after cursor for the next page resources
              type: string
            before:
              description: before cursor for the previous page resources
              type: string
            limit:
              description: number of resources limit applied to this request
              type: integer
          type: object
      required:
      - data
      type: object
    NotFoundError:
      properties:
        errors:
          description: Errors
          items:
            properties:
              code:
                description: an application-specific error code, expressed as a string value.
                type: integer
              detail:
                description: a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
                type: string
              title:
                description: a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
                type: string
            type: object
          type: array
      type: object
  securitySchemes:
    Bearer:
      in: header
      name: Authorization
      type: apiKey