Platform API ClientClient group7 methodsAiSystemsMethods

aiSystems

Reference methods for aiSystems.

Ai Systems

aiSystems.register()

Generated exampleHTTP endpoint wrapperPOST /api/v1/ai-systems

POST /api/v1/ai-systems

Signature

register(input: AiSystemInput): Promise<AiSystemRecord>

Parameters

Name	Type	Flags
input	AiSystemInput	required

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const input = {} as AiSystemInput;
// Fill the input payload fields before calling this method.

const response = await client.aiSystems.register(input);
console.log(response);

Response

// Response type
Promise<AiSystemRecord>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

aiSystems.list()

Generated exampleHTTP endpoint wrapperGET /api/v1/ai-systems

GET /api/v1/ai-systems

Signature

list(params?: ListAiSystemsParams): Promise<ListAiSystemsResponse>

Parameters

Name	Type	Flags
params	ListAiSystemsParams	optional

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const params = {} as ListAiSystemsParams;
// Fill the params payload fields before calling this method.

const response = await client.aiSystems.list(params);
console.log(response);

Response

// Response type
Promise<ListAiSystemsResponse>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

aiSystems.get()

Generated exampleHTTP endpoint wrapperGET /api/v1/ai-systems/{systemId}

GET /api/v1/ai-systems/{systemId}

Signature

get(systemId: string): Promise<AiSystemRecord>

Parameters

Name	Type	Flags
systemId	string	required

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const systemId = "<systemId>";

const response = await client.aiSystems.get(systemId);
console.log(response);

Response

// Response type
Promise<AiSystemRecord>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

aiSystems.update()

Generated exampleHTTP endpoint wrapperPUT /api/v1/ai-systems/{systemId}

PUT /api/v1/ai-systems/{systemId}

Signature

update(systemId: string, input: AiSystemUpdateInput): Promise<AiSystemRecord>

Parameters

Name	Type	Flags
systemId	string	required
input	AiSystemUpdateInput	required

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const systemId = "<systemId>";
const input = {} as AiSystemUpdateInput;

const response = await client.aiSystems.update(systemId, input);
console.log(response);

Response

// Response type
Promise<AiSystemRecord>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

aiSystems.archive()

Generated exampleHTTP endpoint wrapperDELETE /api/v1/ai-systems/{systemId}

DELETE /api/v1/ai-systems/{systemId}

Signature

archive(systemId: string): Promise<AiSystemRecord>

Parameters

Name	Type	Flags
systemId	string	required

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const systemId = "<systemId>";

const response = await client.aiSystems.archive(systemId);
console.log(response);

Response

// Response type
Promise<AiSystemRecord>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

aiSystems.setDefault()

Generated exampleHTTP endpoint wrapperPOST /api/v1/ai-systems/{systemId}/set-default

POST /api/v1/ai-systems/{systemId}/set-default

Signature

setDefault(systemId: string): Promise<AiSystemRecord>

Parameters

Name	Type	Flags
systemId	string	required

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const systemId = "<systemId>";

const response = await client.aiSystems.setDefault(systemId);
console.log(response);

Response

// Response type
Promise<AiSystemRecord>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

aiSystems.summary()

Generated exampleHTTP endpoint wrapperGET /api/v1/ai-systems/{systemId}/summary

GET /api/v1/ai-systems/{systemId}/summary

Signature

summary(systemId: string, params?: AiSystemSummaryParams): Promise<AiSystemSummary>

Parameters

Name	Type	Flags
systemId	string	required
params	AiSystemSummaryParams	optional

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const systemId = "<systemId>";
const params = {} as AiSystemSummaryParams;

const response = await client.aiSystems.summary(systemId, params);
console.log(response);

Response

// Response type
Promise<AiSystemSummary>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));