• Documentation
    • About ​ValidMind
    • Get Started
    • Guides
    • Support
    • Releases

    • ValidMind Library
    • Python API
    • Public REST API

    • Training Courses
  • Log In
  1. Public API enhancements: Model stages, findings, custom fields, and more
  • All releases

  • Current releases
  • Feature highlights
  • ValidMind Platform releases
  • ValidMind Library releases
  • Documentation updates

  • Breaking changes and deprecations

  • Older releases
  • April 24, 2025
  • March 7, 2025
  • January 31, 2025
  • 2024 Releases
    • December 24, 2024
    • December 6, 2024
    • October 22, 2024
    • September 25, 2024
    • September 9, 2024
    • August 13, 2024
    • July 22, 2024
    • June 10, 2024
    • May 22, 2024
    • March 27, 2024
    • February 14, 2024
    • January 26, 2024
    • January 18, 2024
  • 2023 Releases
    • December 13, 2023
    • November 9, 2023
    • October 25, 2023
    • September 27, 2023
    • August 15, 2023
    • July 24, 2023
    • June 22, 2023
    • May 30, 2023

On this page

  • Public API to manage model stages
  • Public API for updating findings
  • Public API for managing custom fields in models and findings
  • Public API to check template swap dependencies
  • Include fields for /models public API by default
  • Edit this page
  • Report an issue

Public API enhancements: Model stages, findings, custom fields, and more

frontend
25.12
highlight
Published

December 10, 2025

Public API to manage model stages

You now have access to new public API endpoints for model stages to simplify workflow management.

POST /model-stages

Usage example

curl -X POST 'http://localhost:5000/vm/api/v1/model-stages'
  -H 'accept: application/json'
  -H 'content-type: application/json'
  -H 'x-api-key: <api-key>'
  -H 'x-api-secret: <api-secret>'
  -d '{
    "name": "MRM Committee review",
    "description": "Stage for formal MRM committee evaluation",
    "colors": { "primary": "#0052CC", "secondary": "#DFE1E6" }
  }

Public API for updating findings

This update introduces a public API for updating findings, making it easier to modify existing findings via the backend.

Update a finding

Public API for managing custom fields in models and findings

This update introduces a public API for managing custom fields in models and findings.

You can define custom fields with attributes, such as title, key, type, and path.

Each field can include a description and be marked as required or optional during registration.

Additionally, you can set permissions for updating fields by assigning roles, such as Model Owner, Model Validator, and Model Developer to ensure proper access control.

GET /model-fields
POST /model-fields
get /model-fields/{field_key}
PUT /model-fields/{field_key}
DELETE /model-fields/{field_key}

GET /finding-fields
POST /finding-fields
GET /finding-fields/{field_key}
PUT /finding-fields/{field_key}
DELETE /finding-fields/{field_key}

Public API to check template swap dependencies

This update introduces several functional enhancements and bug fixes across multiple components of the system.

POST /models/{cuid}/documents/{slug}/templates/check-dependencies

Include fields for /models public API by default

This update improves the public API for listing all models. You can now access more detailed information when retrieving model lists, enhancing your ability to manage and understand your inventory.

A screenshot of the public API endpoints.

Public API endpoints
  • ValidMind Logo
    ©
    Copyright 2026 ValidMind Inc.
    All Rights Reserved.
    Cookie preferences
    Legal
  • Get started
    • Model development
    • Model validation
    • Setup & admin
  • Guides
    • Access
    • Configuration
    • Model inventory
    • Model documentation
    • Model validation
    • Workflows
    • Reporting
    • Monitoring
    • Attestation
  • Library
    • For developers
    • For validators
    • Code samples
    • Python API
    • Public REST API
  • Training
    • Learning paths
    • Courses
    • Videos
  • Support
    • Troubleshooting
    • FAQ
    • Get help
  • Community
    • GitHub
    • LinkedIn
    • Events
    • Blog
  • Edit this page
  • Report an issue