Tenant | AIsuru Docs

AIsuru Docs

No operation.

get

Responses

200

Success

application/json

get

GET /api/v2/HealthCheck HTTP/1.1
Host: 
Accept: */*

200

Success

{
  "requestID": 1,
  "requestDateTime": "2025-06-07T18:33:16.301Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Gets the list of of all Tenant objects.

get

Listing of Tenant objects is granted only to administrative users.

Path parameters

strTokenstringRequired

The login token

Responses

200

Success

application/json

get

GET /api/v2/Tenants/{strToken} HTTP/1.1
Host: 
Accept: */*

200

Success

{
  "tenants": [
    {
      "tenantID": "text",
      "name": "text",
      "aliases": [
        "text"
      ],
      "tenantType": "text",
      "description": "text",
      "logoURL": "text",
      "adminEmail": "text",
      "theme": "text",
      "feedbackURL": "text",
      "privacyPolicyURL": "text",
      "speechProvider": "text",
      "speechAPIKey": "text",
      "adminCount": 1,
      "userCount": 1,
      "memoriCount": 1,
      "disableRegistration": true,
      "maxMemoriPerAdmin": 1,
      "maxMemoriPerUser": 1,
      "maxTotalMemori": 1,
      "maxAdmins": 1,
      "maxUsers": 1,
      "maxFreeSessions": 1,
      "maxFreeSessionsPerUser": 1,
      "nonFreeSessionCost": 1,
      "maxCompletions": 1,
      "maxCompletionsPerUser": 1,
      "maxImportSize": 1,
      "maxImportSizePerUser": 1,
      "paying": true,
      "enableUserMemoriCreation": true,
      "enableBoardOfExperts": true,
      "enableDCMIntegration": true,
      "enableBadges": true,
      "enableDeepThought": true,
      "enableVirtualSpaces": true,
      "billingDelegation": true,
      "creationTimestamp": "2025-06-07T18:33:16.301Z",
      "lastChangeTimestamp": "2025-06-07T18:33:16.301Z"
    }
  ],
  "requestID": 1,
  "requestDateTime": "2025-06-07T18:33:16.301Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Gets the details of a Tenant object.

get

Path parameters

tenantNamestringRequired

The name of the Tenant

Responses

200

Success

application/json

get

GET /api/v2/Tenant/{tenantName} HTTP/1.1
Host: 
Accept: */*

200

Success

{
  "tenant": {
    "tenantID": "text",
    "name": "text",
    "aliases": [
      "text"
    ],
    "tenantType": "text",
    "description": "text",
    "logoURL": "text",
    "adminEmail": "text",
    "theme": "text",
    "feedbackURL": "text",
    "privacyPolicyURL": "text",
    "speechProvider": "text",
    "speechAPIKey": "text",
    "adminCount": 1,
    "userCount": 1,
    "memoriCount": 1,
    "disableRegistration": true,
    "maxMemoriPerAdmin": 1,
    "maxMemoriPerUser": 1,
    "maxTotalMemori": 1,
    "maxAdmins": 1,
    "maxUsers": 1,
    "maxFreeSessions": 1,
    "maxFreeSessionsPerUser": 1,
    "nonFreeSessionCost": 1,
    "maxCompletions": 1,
    "maxCompletionsPerUser": 1,
    "maxImportSize": 1,
    "maxImportSizePerUser": 1,
    "paying": true,
    "enableUserMemoriCreation": true,
    "enableBoardOfExperts": true,
    "enableDCMIntegration": true,
    "enableBadges": true,
    "enableDeepThought": true,
    "enableVirtualSpaces": true,
    "billingDelegation": true,
    "creationTimestamp": "2025-06-07T18:33:16.301Z",
    "lastChangeTimestamp": "2025-06-07T18:33:16.301Z"
  },
  "requestID": 1,
  "requestDateTime": "2025-06-07T18:33:16.301Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Duplicates a Tenant object.

post

Duplication of a Tenant object is granted only to administrative users.

Path parameters

strTokenstringRequired

The login token

tenantNamestringRequired

The name of the Tenant to duplicate

Body

Specifications of a Tenant object.

tenantIDstring | nullableOptional

Tenant ID. Returned during Get operations. Ignored in other cases.

namestring | nullableOptional

Tenant name. Usually a host name, e.g. app.memorytwin.com. Returned during Get operations. Used during Duplicate operations. Ignored in other cases.

aliasesstring[] | nullableOptional

Additional Tenant names. Usually host names, e.g. app.memorytwin.com. Returned during Get operations. Used during Update operations. Ignored in other cases.

tenantTypestring | nullableOptional

Type of the Tenant. The following values are possible: Owned: the tenant is owned Memori Customer: the tenant is owned by a customer

descriptionstring | nullableOptional

Tenant description. Usually a human-readable name, e.g. MemoryTwin. Returned during Get operations. Used during Duplicate and Update operations.

logoURLstring | nullableOptional

URL of the Tenant logo. Returned during Get operations. Used during Duplicate and Update operations.

adminEmailstring | nullableOptional

Administrative e-mail for the Tenant. Returned during Get operations. Used during Duplicate and Update operations.

themestring | nullableOptional

Color theme to be used for the Tenant. Returned during Get operations. Used during Duplicate and Update operations.

feedbackURLstring | nullableOptional

URL for the feedback form for the Tenant. Returned during Get operations. Used during Duplicate and Update operations.

privacyPolicyURLstring | nullableOptional

URL of the Privacy Policy page for the Tenant.

speechProviderstring | nullableOptional

Text to speech provider for the Tenant.

speechAPIKeystring | nullableOptional

API key for the text to speech provider.

adminCountinteger · int32Optional

Current number of administrative Users. Returned during Get operations. Ignored in other cases.

userCountinteger · int32Optional

Current number of normal Users. Returned during Get operations. Ignored in other cases.

memoriCountinteger · int32Optional

Current number of Memori objects. Returned during Get operations. Ignored in other cases.

disableRegistrationboolean | nullableOptional

If True no new User can be registered for this Tenant. Returned during Get operations. Used during Duplicate and Update operations.

maxMemoriPerAdmininteger · int32 | nullableOptional

Maximum number of Memori objects per administrative User. If 0 it means unlimited. Returned during Get operations. Used during Duplicate and Update operations.

maxMemoriPerUserinteger · int32 | nullableOptional

Maximum number of Memori objects per normal User. If 0 it means unlimited. Returned during Get operations. Used during Duplicate and Update operations.

maxTotalMemoriinteger · int32 | nullableOptional

Maximum total number of Memori objects. If 0 it means unlimited. Returned during Get operations. Used during Duplicate and Update operations.

maxAdminsinteger · int32 | nullableOptional

Maximum number of administrative Users. If 0 it means unlimited. Returned during Get operations. Used during Duplicate and Update operations.

maxUsersinteger · int32 | nullableOptional

Maximum number of normal Users. If 0 it means unlimited. Returned during Get operations. Used during Duplicate and Update operations.

maxFreeSessionsinteger · int32 | nullableOptional

Maximum total number of free sessions across all users of this Tenant. If 0 it means unlimited. Returned during Get operations. Used during Duplicate and Update operations.

maxFreeSessionsPerUserinteger · int32 | nullableOptional

Maximum number of free sessions for a User. If 0 it means unlimited. Returned during Get operations. Used during Duplicate and Update operations.

nonFreeSessionCostnumber · double | nullableOptional

Cost of each new session above the max free sessions threshold. Returned during Get operations. Used during Duplicate and Update operations.

maxCompletionsinteger · int32 | nullableOptional

Maximum total number of completions across all users of this Tenant. if 0 it means unlimited. Returned during Get operations. Used during Duplicate and Update operations.

maxCompletionsPerUserinteger · int32 | nullableOptional

Maximum number of completions for a User. if 0 it means unlimited. Returned during Get operations. Used during Duplicate and Update operations.

maxImportSizeinteger · int64 | nullableOptional

Maximum total number of characters that can be imported across all users of this Tenant. if 0 it means unlimited. Returned during Get operations. Used during Duplicate and Update operations.

maxImportSizePerUserinteger · int64 | nullableOptional

Maximum number of characters that can be imported by a User. if 0 it means unlimited. Returned during Get operations. Used during Duplicate and Update operations.

payingboolean | nullableOptional

If True means this Tenant has an actual payment contract in effect and non-free sessions (i.e. sessions above the max free session thresholds) can be performed. Returned during Get operations. Used during Duplicate and Update operations.

enableUserMemoriCreationboolean | nullableOptional

If True normal Users can create new Memori objects. Administrative Users always can. Returned during Get operations. Used during Duplicate and Update operations.

enableBoardOfExpertsboolean | nullableOptional

If True the Board of Experts feature is enabled. Returned during Get operations. Used during Duplicate and Update operations.

enableDCMIntegrationboolean | nullableOptional

If True the DCM integration feature is enabled Returned during Get operations. Used during Duplicate and Update operations.

enableBadgesboolean | nullableOptional

If True this Tenant accepts DCM outcomes and consequently can receive badges in the Open Badge format. Returned during Get operations. Used during Duplicate and Update operations.

enableDeepThoughtboolean | nullableOptional

If True the Deep Thought feature is enabled. Returned during Get operations. Used during Duplicate and Update operations.

enableVirtualSpacesboolean | nullableOptional

If True the Virtual Spaces feature is enabled. Returned during Get operations. Used during Duplicate and Update operations.

billingDelegationboolean | nullableOptional

If True the Tenant costs and limits are computed from the configured Billing interface.

creationTimestampstring · date-time | nullableOptional

Timestamp of creation. Returned during Get operations. Ignored in other cases.

lastChangeTimestampstring · date-time | nullableOptional

Timestamp of latest change. Returned during Get operations. Ignored in other cases.

Responses

200

Success

application/json

post

POST /api/v2/Tenant/{strToken}/{tenantName} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 852

{
  "tenantID": "text",
  "name": "text",
  "aliases": [
    "text"
  ],
  "tenantType": "text",
  "description": "text",
  "logoURL": "text",
  "adminEmail": "text",
  "theme": "text",
  "feedbackURL": "text",
  "privacyPolicyURL": "text",
  "speechProvider": "text",
  "speechAPIKey": "text",
  "adminCount": 1,
  "userCount": 1,
  "memoriCount": 1,
  "disableRegistration": true,
  "maxMemoriPerAdmin": 1,
  "maxMemoriPerUser": 1,
  "maxTotalMemori": 1,
  "maxAdmins": 1,
  "maxUsers": 1,
  "maxFreeSessions": 1,
  "maxFreeSessionsPerUser": 1,
  "nonFreeSessionCost": 1,
  "maxCompletions": 1,
  "maxCompletionsPerUser": 1,
  "maxImportSize": 1,
  "maxImportSizePerUser": 1,
  "paying": true,
  "enableUserMemoriCreation": true,
  "enableBoardOfExperts": true,
  "enableDCMIntegration": true,
  "enableBadges": true,
  "enableDeepThought": true,
  "enableVirtualSpaces": true,
  "billingDelegation": true,
  "creationTimestamp": "2025-06-07T18:33:16.301Z",
  "lastChangeTimestamp": "2025-06-07T18:33:16.301Z"
}

200

Success

{
  "tenant": {
    "tenantID": "text",
    "name": "text",
    "aliases": [
      "text"
    ],
    "tenantType": "text",
    "description": "text",
    "logoURL": "text",
    "adminEmail": "text",
    "theme": "text",
    "feedbackURL": "text",
    "privacyPolicyURL": "text",
    "speechProvider": "text",
    "speechAPIKey": "text",
    "adminCount": 1,
    "userCount": 1,
    "memoriCount": 1,
    "disableRegistration": true,
    "maxMemoriPerAdmin": 1,
    "maxMemoriPerUser": 1,
    "maxTotalMemori": 1,
    "maxAdmins": 1,
    "maxUsers": 1,
    "maxFreeSessions": 1,
    "maxFreeSessionsPerUser": 1,
    "nonFreeSessionCost": 1,
    "maxCompletions": 1,
    "maxCompletionsPerUser": 1,
    "maxImportSize": 1,
    "maxImportSizePerUser": 1,
    "paying": true,
    "enableUserMemoriCreation": true,
    "enableBoardOfExperts": true,
    "enableDCMIntegration": true,
    "enableBadges": true,
    "enableDeepThought": true,
    "enableVirtualSpaces": true,
    "billingDelegation": true,
    "creationTimestamp": "2025-06-07T18:33:16.301Z",
    "lastChangeTimestamp": "2025-06-07T18:33:16.301Z"
  },
  "requestID": 1,
  "requestDateTime": "2025-06-07T18:33:16.301Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Updates the details of a Tenant object.

patch

Update of a Tenant object is granted only to administrative users. Tenant admins may only change the following properties:

LogoURL
AdminEmail
FeedbackURL
MaxMemoriPerUser
MaxFreeSessionsPerUser
MaxCompletionsPerUser
MaxImportSizePerUser
EnableUserMemoriCreation

Path parameters

strTokenstringRequired

The login token

tenantNamestringRequired

The name of the Tenant to update

Body

Specifications of a Tenant object.

tenantIDstring | nullableOptional

Tenant ID. Returned during Get operations. Ignored in other cases.

namestring | nullableOptional

Tenant name. Usually a host name, e.g. app.memorytwin.com. Returned during Get operations. Used during Duplicate operations. Ignored in other cases.

aliasesstring[] | nullableOptional

Additional Tenant names. Usually host names, e.g. app.memorytwin.com. Returned during Get operations. Used during Update operations. Ignored in other cases.

tenantTypestring | nullableOptional

Type of the Tenant. The following values are possible: Owned: the tenant is owned Memori Customer: the tenant is owned by a customer

descriptionstring | nullableOptional

Tenant description. Usually a human-readable name, e.g. MemoryTwin. Returned during Get operations. Used during Duplicate and Update operations.

logoURLstring | nullableOptional

URL of the Tenant logo. Returned during Get operations. Used during Duplicate and Update operations.

adminEmailstring | nullableOptional

Administrative e-mail for the Tenant. Returned during Get operations. Used during Duplicate and Update operations.

themestring | nullableOptional

Color theme to be used for the Tenant. Returned during Get operations. Used during Duplicate and Update operations.

feedbackURLstring | nullableOptional

URL for the feedback form for the Tenant. Returned during Get operations. Used during Duplicate and Update operations.

privacyPolicyURLstring | nullableOptional

URL of the Privacy Policy page for the Tenant.

speechProviderstring | nullableOptional

Text to speech provider for the Tenant.

speechAPIKeystring | nullableOptional

API key for the text to speech provider.

adminCountinteger · int32Optional

Current number of administrative Users. Returned during Get operations. Ignored in other cases.

userCountinteger · int32Optional

Current number of normal Users. Returned during Get operations. Ignored in other cases.

memoriCountinteger · int32Optional

Current number of Memori objects. Returned during Get operations. Ignored in other cases.

disableRegistrationboolean | nullableOptional

If True no new User can be registered for this Tenant. Returned during Get operations. Used during Duplicate and Update operations.

maxMemoriPerAdmininteger · int32 | nullableOptional

Maximum number of Memori objects per administrative User. If 0 it means unlimited. Returned during Get operations. Used during Duplicate and Update operations.

maxMemoriPerUserinteger · int32 | nullableOptional

Maximum number of Memori objects per normal User. If 0 it means unlimited. Returned during Get operations. Used during Duplicate and Update operations.

maxTotalMemoriinteger · int32 | nullableOptional

Maximum total number of Memori objects. If 0 it means unlimited. Returned during Get operations. Used during Duplicate and Update operations.

maxAdminsinteger · int32 | nullableOptional

Maximum number of administrative Users. If 0 it means unlimited. Returned during Get operations. Used during Duplicate and Update operations.

maxUsersinteger · int32 | nullableOptional

Maximum number of normal Users. If 0 it means unlimited. Returned during Get operations. Used during Duplicate and Update operations.

maxFreeSessionsinteger · int32 | nullableOptional

Maximum total number of free sessions across all users of this Tenant. If 0 it means unlimited. Returned during Get operations. Used during Duplicate and Update operations.

maxFreeSessionsPerUserinteger · int32 | nullableOptional

Maximum number of free sessions for a User. If 0 it means unlimited. Returned during Get operations. Used during Duplicate and Update operations.

nonFreeSessionCostnumber · double | nullableOptional

Cost of each new session above the max free sessions threshold. Returned during Get operations. Used during Duplicate and Update operations.

maxCompletionsinteger · int32 | nullableOptional

Maximum total number of completions across all users of this Tenant. if 0 it means unlimited. Returned during Get operations. Used during Duplicate and Update operations.

maxCompletionsPerUserinteger · int32 | nullableOptional

Maximum number of completions for a User. if 0 it means unlimited. Returned during Get operations. Used during Duplicate and Update operations.

maxImportSizeinteger · int64 | nullableOptional

Maximum total number of characters that can be imported across all users of this Tenant. if 0 it means unlimited. Returned during Get operations. Used during Duplicate and Update operations.

maxImportSizePerUserinteger · int64 | nullableOptional

Maximum number of characters that can be imported by a User. if 0 it means unlimited. Returned during Get operations. Used during Duplicate and Update operations.

payingboolean | nullableOptional

enableUserMemoriCreationboolean | nullableOptional

If True normal Users can create new Memori objects. Administrative Users always can. Returned during Get operations. Used during Duplicate and Update operations.

enableBoardOfExpertsboolean | nullableOptional

If True the Board of Experts feature is enabled. Returned during Get operations. Used during Duplicate and Update operations.

enableDCMIntegrationboolean | nullableOptional

If True the DCM integration feature is enabled Returned during Get operations. Used during Duplicate and Update operations.

enableBadgesboolean | nullableOptional

If True this Tenant accepts DCM outcomes and consequently can receive badges in the Open Badge format. Returned during Get operations. Used during Duplicate and Update operations.

enableDeepThoughtboolean | nullableOptional

If True the Deep Thought feature is enabled. Returned during Get operations. Used during Duplicate and Update operations.

enableVirtualSpacesboolean | nullableOptional

If True the Virtual Spaces feature is enabled. Returned during Get operations. Used during Duplicate and Update operations.

billingDelegationboolean | nullableOptional

If True the Tenant costs and limits are computed from the configured Billing interface.

creationTimestampstring · date-time | nullableOptional

Timestamp of creation. Returned during Get operations. Ignored in other cases.

lastChangeTimestampstring · date-time | nullableOptional

Timestamp of latest change. Returned during Get operations. Ignored in other cases.

Responses

200

Success

application/json

patch

PATCH /api/v2/Tenant/{strToken}/{tenantName} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 852

{
  "tenantID": "text",
  "name": "text",
  "aliases": [
    "text"
  ],
  "tenantType": "text",
  "description": "text",
  "logoURL": "text",
  "adminEmail": "text",
  "theme": "text",
  "feedbackURL": "text",
  "privacyPolicyURL": "text",
  "speechProvider": "text",
  "speechAPIKey": "text",
  "adminCount": 1,
  "userCount": 1,
  "memoriCount": 1,
  "disableRegistration": true,
  "maxMemoriPerAdmin": 1,
  "maxMemoriPerUser": 1,
  "maxTotalMemori": 1,
  "maxAdmins": 1,
  "maxUsers": 1,
  "maxFreeSessions": 1,
  "maxFreeSessionsPerUser": 1,
  "nonFreeSessionCost": 1,
  "maxCompletions": 1,
  "maxCompletionsPerUser": 1,
  "maxImportSize": 1,
  "maxImportSizePerUser": 1,
  "paying": true,
  "enableUserMemoriCreation": true,
  "enableBoardOfExperts": true,
  "enableDCMIntegration": true,
  "enableBadges": true,
  "enableDeepThought": true,
  "enableVirtualSpaces": true,
  "billingDelegation": true,
  "creationTimestamp": "2025-06-07T18:33:16.301Z",
  "lastChangeTimestamp": "2025-06-07T18:33:16.301Z"
}

200

Success

{
  "tenant": {
    "tenantID": "text",
    "name": "text",
    "aliases": [
      "text"
    ],
    "tenantType": "text",
    "description": "text",
    "logoURL": "text",
    "adminEmail": "text",
    "theme": "text",
    "feedbackURL": "text",
    "privacyPolicyURL": "text",
    "speechProvider": "text",
    "speechAPIKey": "text",
    "adminCount": 1,
    "userCount": 1,
    "memoriCount": 1,
    "disableRegistration": true,
    "maxMemoriPerAdmin": 1,
    "maxMemoriPerUser": 1,
    "maxTotalMemori": 1,
    "maxAdmins": 1,
    "maxUsers": 1,
    "maxFreeSessions": 1,
    "maxFreeSessionsPerUser": 1,
    "nonFreeSessionCost": 1,
    "maxCompletions": 1,
    "maxCompletionsPerUser": 1,
    "maxImportSize": 1,
    "maxImportSizePerUser": 1,
    "paying": true,
    "enableUserMemoriCreation": true,
    "enableBoardOfExperts": true,
    "enableDCMIntegration": true,
    "enableBadges": true,
    "enableDeepThought": true,
    "enableVirtualSpaces": true,
    "billingDelegation": true,
    "creationTimestamp": "2025-06-07T18:33:16.301Z",
    "lastChangeTimestamp": "2025-06-07T18:33:16.301Z"
  },
  "requestID": 1,
  "requestDateTime": "2025-06-07T18:33:16.301Z",
  "resultCode": 1,
  "resultMessage": "text"
}