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

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

input = {}  # AiSystemInput

response = platform.aiSystems.register(input)
print(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

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

params = {}  # ListAiSystemsParams

response = platform.aiSystems.list(params)
print(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

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

systemId = "<systemId>"

response = platform.aiSystems.get(systemId)
print(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

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

systemId = "<systemId>"
input = {}  # AiSystemUpdateInput

response = platform.aiSystems.update(systemId, input)
print(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

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

systemId = "<systemId>"

response = platform.aiSystems.archive(systemId)
print(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

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

systemId = "<systemId>"

response = platform.aiSystems.setDefault(systemId)
print(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

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

systemId = "<systemId>"
params = {}  # AiSystemSummaryParams

response = platform.aiSystems.summary(systemId, params)
print(response)

Response

// Response type
Promise<AiSystemSummary>

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