Tenant
Listing of Tenant objects is granted only to administrative users.
The login token
Success
GET /api/v2/Tenants/{strToken} HTTP/1.1
Host:
Accept: */*
Success
{
"tenants": [
{
"tenantID": "text",
"name": "text",
"aliases": [
"text"
],
"tenantType": "text",
"description": "text",
"logoURL": "text",
"squareLogoURL": "text",
"adminEmail": "text",
"theme": "text",
"feedbackURL": "text",
"privacyPolicyURL": "text",
"speechProvider": "text",
"speechAPIKey": "text",
"perplexityAPIKey": "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,
"chatLogsRetentionDays": 1,
"smtpConfig": {
"server": "text",
"user": "text",
"password": "text",
"port": 1,
"socketSecurity": "text",
"senderEmail": "text",
"senderName": "text"
},
"creationTimestamp": "2025-10-24T16:34:34.618Z",
"lastChangeTimestamp": "2025-10-24T16:34:34.618Z"
}
],
"requestID": 1,
"requestDateTime": "2025-10-24T16:34:34.618Z",
"resultCode": 1,
"resultMessage": "text"
}The name of the Tenant
Success
GET /api/v2/Tenant/{tenantName} HTTP/1.1
Host:
Accept: */*
Success
{
"tenant": {
"tenantID": "text",
"name": "text",
"aliases": [
"text"
],
"tenantType": "text",
"description": "text",
"logoURL": "text",
"squareLogoURL": "text",
"adminEmail": "text",
"theme": "text",
"feedbackURL": "text",
"privacyPolicyURL": "text",
"speechProvider": "text",
"speechAPIKey": "text",
"perplexityAPIKey": "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,
"chatLogsRetentionDays": 1,
"smtpConfig": {
"server": "text",
"user": "text",
"password": "text",
"port": 1,
"socketSecurity": "text",
"senderEmail": "text",
"senderName": "text"
},
"creationTimestamp": "2025-10-24T16:34:34.618Z",
"lastChangeTimestamp": "2025-10-24T16:34:34.618Z"
},
"requestID": 1,
"requestDateTime": "2025-10-24T16:34:34.618Z",
"resultCode": 1,
"resultMessage": "text"
}Retrieve all Tenant data is granted only to administrative users.
The login token
The name of the Tenant
Success
GET /api/v2/Tenant/{strToken}/{tenantName} HTTP/1.1
Host:
Accept: */*
Success
{
"tenant": {
"tenantID": "text",
"name": "text",
"aliases": [
"text"
],
"tenantType": "text",
"description": "text",
"logoURL": "text",
"squareLogoURL": "text",
"adminEmail": "text",
"theme": "text",
"feedbackURL": "text",
"privacyPolicyURL": "text",
"speechProvider": "text",
"speechAPIKey": "text",
"perplexityAPIKey": "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,
"chatLogsRetentionDays": 1,
"smtpConfig": {
"server": "text",
"user": "text",
"password": "text",
"port": 1,
"socketSecurity": "text",
"senderEmail": "text",
"senderName": "text"
},
"creationTimestamp": "2025-10-24T16:34:34.618Z",
"lastChangeTimestamp": "2025-10-24T16:34:34.618Z"
},
"requestID": 1,
"requestDateTime": "2025-10-24T16:34:34.618Z",
"resultCode": 1,
"resultMessage": "text"
}Duplication of a Tenant object is granted only to administrative users. If ChatLogsRetentionDays is not specified, it defaults to 90 days.
The login token
The name of the Tenant to duplicate
Specifications of a Tenant object.
Tenant ID. Returned during Get operations. Ignored in other cases.
Tenant name. Usually a host name, e.g. app.memorytwin.com.
Returned during Get operations.
Used during Duplicate operations.
Ignored in other cases.
Additional Tenant names. Usually host names, e.g. app.memorytwin.com.
Returned during Get operations.
Used during Update operations.
Ignored in other cases.
Type of the Tenant. The following values are possible: Owned: the tenant is owned Memori Customer: the tenant is owned by a customer
Tenant description. Usually a human-readable name, e.g. MemoryTwin.
Returned during Get operations.
Used during Duplicate and Update operations.
URL of the Tenant logo. Returned during Get operations. Used during Duplicate and Update operations.
URL of the Tenant Icons logo. Returned during Get operations. Used during Duplicate and Update operations.
Administrative e-mail for the Tenant. Returned during Get operations. Used during Duplicate and Update operations.
Color theme to be used for the Tenant. Returned during Get operations. Used during Duplicate and Update operations.
URL for the feedback form for the Tenant. Returned during Get operations. Used during Duplicate and Update operations.
URL of the Privacy Policy page for the Tenant.
Text to speech provider for the Tenant.
API key for the text to speech provider.
API key for Perplexity Search LLM Engine.
Current number of administrative Users. Returned during Get operations. Ignored in other cases.
Current number of normal Users. Returned during Get operations. Ignored in other cases.
Current number of Memori objects. Returned during Get operations. Ignored in other cases.
If True no new User can be registered for this Tenant.
Returned during Get operations.
Used during Duplicate and Update operations.
Maximum number of Memori objects per administrative User.
If 0 it means unlimited.
Returned during Get operations.
Used during Duplicate and Update operations.
Maximum number of Memori objects per normal User.
If 0 it means unlimited.
Returned during Get operations.
Used during Duplicate and Update operations.
Maximum total number of Memori objects.
If 0 it means unlimited.
Returned during Get operations.
Used during Duplicate and Update operations.
Maximum number of administrative Users.
If 0 it means unlimited.
Returned during Get operations.
Used during Duplicate and Update operations.
Maximum number of normal Users.
If 0 it means unlimited.
Returned during Get operations.
Used during Duplicate and Update operations.
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.
Maximum number of free sessions for a User.
If 0 it means unlimited.
Returned during Get operations.
Used during Duplicate and Update operations.
Cost of each new session above the max free sessions threshold. Returned during Get operations. Used during Duplicate and Update operations.
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.
Maximum number of completions for a User.
if 0 it means unlimited.
Returned during Get operations.
Used during Duplicate and Update operations.
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.
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.
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.
If True normal Users can create new Memori objects.
Administrative Users always can.
Returned during Get operations.
Used during Duplicate and Update operations.
If True the Board of Experts feature is enabled.
Returned during Get operations.
Used during Duplicate and Update operations.
If True the DCM integration feature is enabled
Returned during Get operations.
Used during Duplicate and Update operations.
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.
If True the Deep Thought feature is enabled.
Returned during Get operations.
Used during Duplicate and Update operations.
If True the Virtual Spaces feature is enabled.
Returned during Get operations.
Used during Duplicate and Update operations.
If True the Tenant costs and limits are
computed from the configured Billing interface.
Number of days to retain chat logs. Must be at least 1. Returned during Get operations. Used during Duplicate and Update operations.
Timestamp of creation. Returned during Get operations. Ignored in other cases.
Timestamp of latest change. Returned during Get operations. Ignored in other cases.
Success
POST /api/v2/Tenant/{strToken}/{tenantName} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 1064
{
"tenantID": "text",
"name": "text",
"aliases": [
"text"
],
"tenantType": "text",
"description": "text",
"logoURL": "text",
"squareLogoURL": "text",
"adminEmail": "text",
"theme": "text",
"feedbackURL": "text",
"privacyPolicyURL": "text",
"speechProvider": "text",
"speechAPIKey": "text",
"perplexityAPIKey": "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,
"chatLogsRetentionDays": 1,
"smtpConfig": {
"server": "text",
"user": "text",
"password": "text",
"port": 1,
"socketSecurity": "text",
"senderEmail": "text",
"senderName": "text"
},
"creationTimestamp": "2025-10-24T16:34:34.618Z",
"lastChangeTimestamp": "2025-10-24T16:34:34.618Z"
}Success
{
"tenant": {
"tenantID": "text",
"name": "text",
"aliases": [
"text"
],
"tenantType": "text",
"description": "text",
"logoURL": "text",
"squareLogoURL": "text",
"adminEmail": "text",
"theme": "text",
"feedbackURL": "text",
"privacyPolicyURL": "text",
"speechProvider": "text",
"speechAPIKey": "text",
"perplexityAPIKey": "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,
"chatLogsRetentionDays": 1,
"smtpConfig": {
"server": "text",
"user": "text",
"password": "text",
"port": 1,
"socketSecurity": "text",
"senderEmail": "text",
"senderName": "text"
},
"creationTimestamp": "2025-10-24T16:34:34.618Z",
"lastChangeTimestamp": "2025-10-24T16:34:34.618Z"
},
"requestID": 1,
"requestDateTime": "2025-10-24T16:34:34.618Z",
"resultCode": 1,
"resultMessage": "text"
}Update of a Tenant object is granted only to administrative users. Super admins can change all properties. Tenant admins may only change the following properties:
LogoURL
SquareLogoURL
AdminEmail
FeedbackURL
PrivacyPolicyURL
SpeechProvider
SpeechAPIKey
PerplexityAPIKey
MaxMemoriPerUser
MaxFreeSessionsPerUser
MaxCompletionsPerUser
MaxImportSizePerUser
EnableUserMemoriCreation
ChatLogsRetentionDays
SMTPConfig
The login token
The name of the Tenant to update
Specifications of a Tenant object.
Tenant ID. Returned during Get operations. Ignored in other cases.
Tenant name. Usually a host name, e.g. app.memorytwin.com.
Returned during Get operations.
Used during Duplicate operations.
Ignored in other cases.
Additional Tenant names. Usually host names, e.g. app.memorytwin.com.
Returned during Get operations.
Used during Update operations.
Ignored in other cases.
Type of the Tenant. The following values are possible: Owned: the tenant is owned Memori Customer: the tenant is owned by a customer
Tenant description. Usually a human-readable name, e.g. MemoryTwin.
Returned during Get operations.
Used during Duplicate and Update operations.
URL of the Tenant logo. Returned during Get operations. Used during Duplicate and Update operations.
URL of the Tenant Icons logo. Returned during Get operations. Used during Duplicate and Update operations.
Administrative e-mail for the Tenant. Returned during Get operations. Used during Duplicate and Update operations.
Color theme to be used for the Tenant. Returned during Get operations. Used during Duplicate and Update operations.
URL for the feedback form for the Tenant. Returned during Get operations. Used during Duplicate and Update operations.
URL of the Privacy Policy page for the Tenant.
Text to speech provider for the Tenant.
API key for the text to speech provider.
API key for Perplexity Search LLM Engine.
Current number of administrative Users. Returned during Get operations. Ignored in other cases.
Current number of normal Users. Returned during Get operations. Ignored in other cases.
Current number of Memori objects. Returned during Get operations. Ignored in other cases.
If True no new User can be registered for this Tenant.
Returned during Get operations.
Used during Duplicate and Update operations.
Maximum number of Memori objects per administrative User.
If 0 it means unlimited.
Returned during Get operations.
Used during Duplicate and Update operations.
Maximum number of Memori objects per normal User.
If 0 it means unlimited.
Returned during Get operations.
Used during Duplicate and Update operations.
Maximum total number of Memori objects.
If 0 it means unlimited.
Returned during Get operations.
Used during Duplicate and Update operations.
Maximum number of administrative Users.
If 0 it means unlimited.
Returned during Get operations.
Used during Duplicate and Update operations.
Maximum number of normal Users.
If 0 it means unlimited.
Returned during Get operations.
Used during Duplicate and Update operations.
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.
Maximum number of free sessions for a User.
If 0 it means unlimited.
Returned during Get operations.
Used during Duplicate and Update operations.
Cost of each new session above the max free sessions threshold. Returned during Get operations. Used during Duplicate and Update operations.
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.
Maximum number of completions for a User.
if 0 it means unlimited.
Returned during Get operations.
Used during Duplicate and Update operations.
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.
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.
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.
If True normal Users can create new Memori objects.
Administrative Users always can.
Returned during Get operations.
Used during Duplicate and Update operations.
If True the Board of Experts feature is enabled.
Returned during Get operations.
Used during Duplicate and Update operations.
If True the DCM integration feature is enabled
Returned during Get operations.
Used during Duplicate and Update operations.
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.
If True the Deep Thought feature is enabled.
Returned during Get operations.
Used during Duplicate and Update operations.
If True the Virtual Spaces feature is enabled.
Returned during Get operations.
Used during Duplicate and Update operations.
If True the Tenant costs and limits are
computed from the configured Billing interface.
Number of days to retain chat logs. Must be at least 1. Returned during Get operations. Used during Duplicate and Update operations.
Timestamp of creation. Returned during Get operations. Ignored in other cases.
Timestamp of latest change. Returned during Get operations. Ignored in other cases.
Success
PATCH /api/v2/Tenant/{strToken}/{tenantName} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 1064
{
"tenantID": "text",
"name": "text",
"aliases": [
"text"
],
"tenantType": "text",
"description": "text",
"logoURL": "text",
"squareLogoURL": "text",
"adminEmail": "text",
"theme": "text",
"feedbackURL": "text",
"privacyPolicyURL": "text",
"speechProvider": "text",
"speechAPIKey": "text",
"perplexityAPIKey": "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,
"chatLogsRetentionDays": 1,
"smtpConfig": {
"server": "text",
"user": "text",
"password": "text",
"port": 1,
"socketSecurity": "text",
"senderEmail": "text",
"senderName": "text"
},
"creationTimestamp": "2025-10-24T16:34:34.618Z",
"lastChangeTimestamp": "2025-10-24T16:34:34.618Z"
}Success
{
"tenant": {
"tenantID": "text",
"name": "text",
"aliases": [
"text"
],
"tenantType": "text",
"description": "text",
"logoURL": "text",
"squareLogoURL": "text",
"adminEmail": "text",
"theme": "text",
"feedbackURL": "text",
"privacyPolicyURL": "text",
"speechProvider": "text",
"speechAPIKey": "text",
"perplexityAPIKey": "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,
"chatLogsRetentionDays": 1,
"smtpConfig": {
"server": "text",
"user": "text",
"password": "text",
"port": 1,
"socketSecurity": "text",
"senderEmail": "text",
"senderName": "text"
},
"creationTimestamp": "2025-10-24T16:34:34.618Z",
"lastChangeTimestamp": "2025-10-24T16:34:34.618Z"
},
"requestID": 1,
"requestDateTime": "2025-10-24T16:34:34.618Z",
"resultCode": 1,
"resultMessage": "text"
}Last updated