Systems
Choose your language:
A system represents the AI service Mankinds evaluates.
client.systems.create(params)
Create an AI system in the authenticated organization.
| SDK | client.systems.create(params, idempotency_key=None) |
|---|---|
| Returns | System |
Parameters:
| Location | Parameter | Type | Required | Description |
|---|---|---|---|---|
| Body | name | string | Required | System name, 1 to 255 characters. Names must be unique in the organization. |
| Body | description | string | Optional | Human-readable description. |
| Body | endpoint | SystemEndpointConfig | Optional | Inline endpoint configuration. Most SDK flows use client.connections.create(...) instead. |
| SDK option | idempotency_key | string | Optional | Sent as the Idempotency-Key header. |
Notable behavior:
- Returns
409withDUPLICATE_SYSTEM_NAMEwhen 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.
| SDK | client.systems.list() |
|---|---|
| Returns | System[] |
Parameters: none.
client.systems.get(systemId)
Read one system by id.
| SDK | client.systems.get(system_id) |
|---|---|
| Returns | System |
Parameters:
| Location | Parameter | Type | Required | Description |
|---|---|---|---|---|
| Path | system_id | string | Required | System UUID. |
client.systems.update(systemId, patch)
Patch mutable system fields.
| SDK | client.systems.update(system_id, patch) |
|---|---|
| Returns | System |
Parameters:
| Location | Parameter | Type | Required | Description |
|---|---|---|---|---|
| Path | system_id | string | Required | System UUID. |
| Body | name | string | Optional | New system name, 1 to 255 characters. |
| Body | description | string | Optional | New description. |
| Body | endpoint | SystemEndpointConfig | Optional | New inline endpoint configuration. |
client.systems.archive(systemId)
Archive or delete a system through the public API.
| SDK | client.systems.archive(system_id) |
|---|---|
| Returns | StatusResponse |
Parameters:
| Location | Parameter | Type | Required | Description |
|---|---|---|---|---|
| Path | system_id | string | Required | System UUID. |
Was this page helpful?