Skip to main content

Systems

Choose your language:

A system represents the AI service Mankinds evaluates.

client.systems.create(params)

Create an AI system in the authenticated organization.

SDKclient.systems.create(params, idempotency_key=None)
ReturnsSystem

Parameters:

LocationParameterTypeRequiredDescription
BodynamestringRequiredSystem name, 1 to 255 characters. Names must be unique in the organization.
BodydescriptionstringOptionalHuman-readable description.
BodyendpointSystemEndpointConfigOptionalInline endpoint configuration. Most SDK flows use client.connections.create(...) instead.
SDK optionidempotency_keystringOptionalSent as the Idempotency-Key header.

Notable behavior:

  • Returns 409 with DUPLICATE_SYSTEM_NAME when another system with the same name exists.
  • Sensitive endpoint fields are redacted when systems are read back.

client.systems.list()

List systems visible to the authenticated organization.

SDKclient.systems.list()
ReturnsSystem[]

Parameters: none.

client.systems.get(systemId)

Read one system by id.

SDKclient.systems.get(system_id)
ReturnsSystem

Parameters:

LocationParameterTypeRequiredDescription
Pathsystem_idstringRequiredSystem UUID.

client.systems.update(systemId, patch)

Patch mutable system fields.

SDKclient.systems.update(system_id, patch)
ReturnsSystem

Parameters:

LocationParameterTypeRequiredDescription
Pathsystem_idstringRequiredSystem UUID.
BodynamestringOptionalNew system name, 1 to 255 characters.
BodydescriptionstringOptionalNew description.
BodyendpointSystemEndpointConfigOptionalNew inline endpoint configuration.

client.systems.archive(systemId)

Archive or delete a system through the public API.

SDKclient.systems.archive(system_id)
ReturnsStatusResponse

Parameters:

LocationParameterTypeRequiredDescription
Pathsystem_idstringRequiredSystem UUID.