Grace Platform – Using the Public API
Updated: 2026-01-20
User Guide
1. Accessing the Grace API Documentation
- Grace provides a fully documented REST API.
- As a Grace user, you can access the API documentation at:
<your-grace-url>/api/v1/docs
This page exposes interactive API documentation that allows you to explore and test available endpoints directly.
2. Purpose of the Grace API
The Grace API allows you to programmatically interact with and manage the platform, including:
- Managing registry objects
- Submitting metrics
- Customizing configuration elements
- Automating governance and operational workflows
Over time, the API surface is continuously extended with additional capabilities.
3. Available API Capabilities (Version 1.6.0)
In the current API version ( v1.6.0), you have access to endpoints for managing:
- Lists
- Custom fields
- Metrics
- Models
- Systems
- Use cases
These endpoints allow you to fully manage the Grace registry through automation.
4. Registry Management via API
Using the API, you can:
- Create, update, and retrieve models, systems, and use cases
- Manage relationships between registry entities
- Maintain consistent governance data programmatically
This enables integration with external tools such as CI/CD pipelines, MLOps platforms, or enterprise systems.
5. Metrics & Customization
The API also enables:
- Submission of technical metrics to Grace
- Configuration of custom fields
- Management of lists used across registry objects
This makes it possible to adapt Grace to your organization’s specific governance, compliance, and reporting requirements.
6. Summary
- A documented, versioned interface for platform interaction
- Full registry management through code
- Programmatic submission of metrics
- Customization of platform configuration
This allows organizations to integrate Grace deeply into their AI lifecycle and governance processes.