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

    • ValidMind Library
    • Python API
    • Public REST API

    • Training Courses
  • Log In
  1. ValidMind Public REST API
  • ValidMind Library
  • Supported records and frameworks

  • Quickstart
  • Quickstart for documentation
  • Quickstart for validation
  • Install and initialize ValidMind
    • Install and initialize the library
    • Install and initialize the library for R
    • Use an HTTP proxy with the library
  • Store credentials in .env files

  • End-to-End Tutorials
  • Development
    • 1 — Set up ValidMind Library
    • 2 — Start the development process
    • 3 — Integrate custom tests
    • 4 — Finalize testing & documentation
  • Validation
    • 1 — Set up ValidMind Library for validation
    • 2 — Start the validation process
    • 3 — Developing a challenger
    • 4 — Finalize validation & reporting

  • How-To
  • Run tests & test suites
    • Explore tests
      • Explore tests
      • Explore test suites
    • Run tests
      • Run dataset-based tests
      • Run comparison tests
      • Configuring tests
        • Configure judge LLM and judge embeddings
        • Customize test result descriptions
        • Enable PII detection in tests
        • Dataset Column Filters when Running Tests
        • Run tests with multiple datasets
        • Understand and utilize RawData in ValidMind tests
      • Using tests in documentation
        • Document multiple results for the same test
        • Run individual documentation sections
        • Run documentation tests with custom configurations
    • Custom tests
      • Implement custom tests
      • Integrate external test providers
  • Use library features
    • Data and datasets
      • Introduction to ValidMind Dataset and Model Objects
      • Dataset inputs
        • Configure dataset features
        • Load dataset predictions
    • Metrics
      • Log metrics over time
      • Intro to Unit Metrics
    • Qualitative text
      • Generate qualitative text with the ValidMind library
    • Scoring
      • Intro to Assign Scores

  • Notebooks
  • Code samples
    • Agents
      • Document an agentic AI system
    • Capital markets
      • Quickstart for knockout option pricing model documentation
      • Quickstart for Heston option pricing model using QuantLib
    • Code explainer
      • Quickstart for model code documentation
    • Credit risk
      • Document an application scorecard model
      • Document an application scorecard model
      • Document a credit risk model
      • Document an application scorecard model
      • Document an Excel-based application scorecard model
    • NLP and LLM
      • Sentiment analysis of financial data using a large language model (LLM)
      • Summarization of financial data using a large language model (LLM)
      • Sentiment analysis of financial data using Hugging Face NLP models
      • Summarization of financial data using Hugging Face NLP models
      • Automate news summarization using LLMs
      • Prompt validation for large language models (LLMs)
      • RAG Model Benchmarking Demo
      • RAG Model Documentation Demo
    • Ongoing monitoring
      • Ongoing Monitoring for Application Scorecard
      • Quickstart for ongoing monitoring of models with ValidMind
    • Regression
      • Document a California Housing Price Prediction regression model
    • Time series
      • Document a time series forecasting model
      • Document a time series forecasting model
    • Validation
      • Validate an application scorecard model

  • Reference
  • ​ValidMind test sandbox
  • ValidMind Library Python API
  • ValidMind Public REST API

On this page

  • Base URL
  • Versioning
  • Authentication
    • Required headers
    • Request example
    • Get your API key and secret
  • Data formats
  • Common response codes
  • Reference
  • Edit this page
  • Report an issue

​ValidMind Public REST API

Published

June 2, 2026

The ValidMind Platform provides a RESTful APIs to programmatically interact with:

  • Models
  • Groups
  • Business units
  • Use cases
  • Templates

Base URL

https://api.prod.validmind.ai/vm/api/v1/

Versioning

This version of the API is v1, specified in the path (/vm/api/v1). Future breaking changes will be introduced under a new version path.

Authentication

Required headers

All API endpoints require authentication using two headers that must be included with every request:

  • x-api-key: Your ValidMind API key
  • x-api-secret: Your ValidMind API secret

Request example

To use this cURL example, replace API_KEY and API_SECRET with your own credentials:

curl -X GET "https://api.prod.validmind.ai/vm/api/v1/models" \
  -H 'accept: application/json' \
  -H 'x-api-key: API_KEY' \
  -H 'x-api-secret: API_SECRET'

Get your API key and secret

  1. In the left sidebar, click Settings.

  2. Under Your Account, select Profile.

  3. Under Access Keys:

    • Locate api key and click Copy to Clipboard.
    • Locate secret key and click Copy to Clipboard.

Data formats

The APIs follows REST principles and uses JSON for both requests and responses.

  • All endpoints consume and produce application/json.
  • CSV format is optionally supported for some listing endpoints using the format=csv query parameter.

Common response codes

Code Meaning
200 Success
400 Bad request (validation)
401 Authentication failed
403 Authorization failed
404 Resource not found
500 Internal server error

Reference

​ValidMind Public REST API Reference

Programmatically interact with models, groups, business units, use cases, and templates.

No matching items
ValidMind Library Python API
  • ValidMind Logo
    ©
    Copyright 2026 ValidMind Inc.
    All Rights Reserved.
    Cookie preferences
    Legal
  • Get started
    • Development
    • Validation
    • Setup & admin
  • Guides
    • Access
    • Configuration
    • Integrations
    • Workflows
    • Inventory
    • Documents & templates
    • Documentation
    • Validation
    • Reporting
    • Monitoring
    • Attestation
  • ValidMind Library
    • Quickstarts
    • Development tutorial
    • Validation tutorial
    • Run tests & test suites
    • Use library features
    • Code samples
    • Python API
    • Public REST API
  • Training
    • Learning paths
    • Courses
    • Videos
  • Support
    • Troubleshooting
    • FAQ
    • Get help
  • Edit this page
  • Report an issue
  • Community
    • GitHub
    • LinkedIn
    • Events
    • Blog