Update system
Update an existing system definition. Only the fields provided in the request body will be updated. If a field is provided, the new content will replace the existing content. If a field is not provided, the existing content will remain unchanged.
When updating schemas:
- The system will accept your changes regardless of compatibility with existing configurations
- Schema updates won’t invalidate existing evaluations or configurations
- For significant redesigns, creating a new system definition provides a cleaner separation
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The ID of the system to update.
"12345678-0a8b-4f66-b6f3-2ddcfa097257"
Body
The name of the system.
The description of the system.
The schema of the system's inputs.
The schema of the system's outputs.
The schema of the system's configuration.
Response
A System Under Test (SUT) defines the interface to a component or service you want to evaluate.
It specifies three contracts through schemas:
- inputSchema: The structure of data the system accepts.
- outputSchema: The structure of data the system produces.
- configSchema: The parameters that modify system behavior.
This abstraction lets you evaluate any system as a black box, focusing on its interface rather than implementation details. It's particularly useful for systems with variable outputs or complex internal state.
Systems are templates - to run evaluations, pair them with a SystemConfig that provides specific parameter values.
The ID of the system.
The name of the system.
The description of the system.
The schema of the system's inputs.
The schema of the system's outputs.
The schema of the system's configuration.