The AI Systems endpoint returns Cranium's representation of the AI Systems registered across your tenant. An AI System groups the BOMs, datasets, and models that make up a registered AI capability. Each AI System's aiSystemId also appears in the aiSystemIds array on the Bills of Materials endpoint, so you can use it to correlate an AI System with its BOMs.

List Bills of Materials

Returns a paginated list of AI Systems for the authenticated tenant.

Request:

GET /api/public/aisystems

Authorization:

Bearer token. See Authentication & Generating Credentials.

Query parameters:

Response record:

json

{ 
	"aiSystemId": "guid", 
	"aiSystemName": "Recommendation Engine", 
	"owner": "Jane Smith | null", 
	"type": "ArtifactBased", 
	"status": "Complete", 
	"boms": 3, 
	"datasets": 5, 
	"models": 2, 
	"createdAt": "2024-04-16T23:51:08Z", 
	"updatedAt": "2024-05-15T12:11:11Z | null" 
}

Field Definitions

• aiSystemId: Unique identifier for the AI System. Stable across updates. This value appears in the aiSystemIds array on the Bills of Materials endpoint, so use it to correlate an AI System with its BOMs.
• aiSystemName: Human-readable name of the AI System as displayed in the Cranium portal.
• owner: Name of the user who owns the AI System. May be empty or null when no owner is assigned.
• type: Scope type of the AI System. The endpoint currently returns only ArtifactBased.
• status: Registration status of the AI System. The endpoint currently returns only Complete.
• boms: Number of BOMs associated with the AI System. The field is named pipelines in the response, but the value is the count of BOMs.
• datasets: Number of datasets associated with the AI System.
• models: Number of models associated with the AI System.
• createdAt: Timestamp when the AI System was created, in ISO 8601 format.
• updatedAt: Timestamp when the AI System was last updated, in ISO 8601 format. May be null.

Error Responses

• 400 BAD_REQUEST: cursor and updatedAfter cannot be used in the same request.
• 400 BAD_REQUEST: page cannot be used with cursor-based pagination.
• 400 BAD_REQUEST: The cursor value is invalid.
• 401 Unauthorized: The request returns an empty body with an x-api-auth: unauthorized header.
• 500 INTERNAL_ERROR: An internal error occurred. No further detail is returned.