CompletionConfig | AIsuru Docs

Gets a list of Completion Config objects allowed for the user.

get

Path parameters

strTokenstringRequired

The login token

purposestringOptional

Optional filter on Completion Config purpose ("QA" for Question Answering, "IE" for Import/Export, "DT" for Deep Thought).

Responses

200

Success

application/json

get

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

200

Success

{
  "configs": [
    {
      "completionConfigID": "text",
      "configName": "text",
      "description": "text",
      "provider": "text",
      "endPoint": "text",
      "apiKey": "text",
      "model": "text",
      "questionAnsweringEnabled": true,
      "importExportEnabled": true,
      "deepThoughtEnabled": true,
      "ownerUserID": "text",
      "ownerUserName": "text",
      "ownerTenantName": "text",
      "visibleToTenantUsers": true,
      "visibleToOtherUsers": true,
      "useAsDefault": true,
      "chargeable": true,
      "applyTo": "text"
    }
  ],
  "requestID": 1,
  "requestDateTime": "2025-06-07T15:20:12.697Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Gets the details of a Completion Config of a specific object

get

Path parameters

strTokenstringRequired

The login token

strConfigIDstringRequired

The Completion Config object ID

Responses

200

Success

application/json

get

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

200

Success

{
  "config": {
    "completionConfigID": "text",
    "configName": "text",
    "description": "text",
    "provider": "text",
    "endPoint": "text",
    "apiKey": "text",
    "model": "text",
    "questionAnsweringEnabled": true,
    "importExportEnabled": true,
    "deepThoughtEnabled": true,
    "ownerUserID": "text",
    "ownerUserName": "text",
    "ownerTenantName": "text",
    "visibleToTenantUsers": true,
    "visibleToOtherUsers": true,
    "useAsDefault": true,
    "chargeable": true,
    "applyTo": "text"
  },
  "requestID": 1,
  "requestDateTime": "2025-06-07T15:20:12.697Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Deletes an existing Completion Config object. A user can only delete a Completion Config object owned by him, unless it has administrative rights.

delete

Path parameters

strTokenstringRequired

The login token

strConfigIDstringRequired

The ID of the Completion Config object

Responses

200

Success

application/json

delete

DELETE /api/v2/CompletionConfig/{strToken}/{strConfigID} HTTP/1.1
Host: 
Accept: */*

200

Success

{
  "requestID": 1,
  "requestDateTime": "2025-06-07T15:20:12.697Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Updates an existing Completion Config object. A user can only update a Completion Config object owned by him, unless it has administrative rights.

patch

Path parameters

strTokenstringRequired

The login token

strConfigIDstringRequired

The ID of the Completion Config object

Body

Specifications of a Completion Config object.

completionConfigIDstring | nullableOptional

Completion Config object ID. Returned during Get operations. Ignored in other cases.

configNamestring | nullableOptional

Completion Config unique name. Required during Creation operations. Used during Update operations. Returned during Get operations.

descriptionstring | nullableOptional

Optional Completion Config description. Used during Creation operations and Update. Returned during Get operations.

providerstring | nullableOptional

Name of the Completion Provider. Required during Creation operations. Used during Update operations. Returned during Get operations. Currently possible values are: OpenAI Anthropic Mistral Azure_OpenAI

endPointstring | nullableOptional

URL of the Completion Provider API end-point. Used during Creation operations and Update. Returned during Get operations.

apiKeystring | nullableOptional

API key of the Completion Provider API end-point. Required during Creation operations. Used during Update operations. Returned during Get operations as an obfuscated value.

modelstring | nullableOptional

Name of the Completion Model. This is provider-specific, and for some providers (e.g. Azure) it is also part of the end-point URL. Required during Creation operations. Used during Update operations. Returned during Get operations.

questionAnsweringEnabledboolean | nullableOptional

If True this configuration can be used for Question & Answer operations. If not specified False is assumed. At least one use must be enabled. Used during Creation operations and Update operations. Returned during Get operations.

importExportEnabledboolean | nullableOptional

If True this configuration can be used for Import/Export operations. If not specified False is assumed. At least one use must be enabled. Used during Creation operations and Update operations. Returned during Get operations.

deepThoughtEnabledboolean | nullableOptional

If True this configuration can be used for Deep Thought operations. If not specified False is assumed. At least one use must be enabled. Used during Creation operations and Update operations. Returned during Get operations.

ownerUserIDstring | nullableOptional

ID of the User this Config belongs to. Returned during Get operations if the user is the owner or an administrator. Ignored in other cases.

ownerUserNamestring | nullableOptional

Name of the User this Config belongs to. Returned during Get operations. Ignored in other cases.

ownerTenantNamestring | nullableOptional

Name of the Tenant of the User this Config belongs to. Returned during Get operations. Ignored in other cases.

visibleToTenantUsersboolean | nullableOptional

If True this configuration can be used by other users of the owner's Tenant. If not specified False is assumed. Used during Creation operations and Update operations. Returned during Get operations.

visibleToOtherUsersboolean | nullableOptional

If True this configuration can be used by users of other Tenants. If not specified False is assumed. Used during Creation operations and Update operations. Returned during Get operations.

useAsDefaultboolean | nullableOptional

If True this configuration is used as the default (for the operations it is enabled for) when a new Memori is created. The use as default requires that the configuration is visible at least to the owner's Tenant users. Used during Creation operations and Update operations. Returned during Get operations.

chargeableboolean | nullableOptional

If True the use of this configuration is chargeable to the customer.

applyTostring | nullableOptional

During Creation and Update operations, when set forces this configuration to be applied to the specified Memori objects and purposes. Ignored during Get operations. Can be one of the following: ONLY_USER_MEMORI_ON_DEFAULT_ONLY_QA_PURPOSE: the configuration is applied to user's Memori objects with the default configuration, for Question & Answer purpose only. ONLY_USER_MEMORI_ON_DEFAULT_ONLY_IE_PURPOSE: the configuration is applied to user's Memori objects with the default configuration, for Import/Export purpose only. ONLY_USER_MEMORI_ON_DEFAULT_ONLY_DT_PURPOSE: the configuration is applied to user's Memori objects with the default configuration, for Deep Thought purpose only. ONLY_USER_MEMORI_ON_DEFAULT_ALL_ENABLED_PURPOSES: the configuration is applied to user's Memori objects with the default configuration, for all enabled purposes. ALL_USER_MEMORI_ONLY_QA_PURPOSE: the configuration is applied to all user's Memori objects, for Question & Answer purpose only. ALL_USER_MEMORI_ONLY_IE_PURPOSE: the configuration is applied to all user's Memori objects, for Import/Export purpose only. ALL_USER_MEMORI_ONLY_DT_PURPOSE: the configuration is applied to all user's Memori objects, for Deep Thought purpose only. ALL_USER_MEMORI_ALL_ENABLED_PURPOSES: the configuration is applied to all user's Memori objects, for all enabled purposes. ONLY_TENANT_MEMORI_ON_DEFAULT_ONLY_QA_PURPOSE: the configuration is applied to the Tenant's Memori objects with the default configuration, for Question & Answer purpose only. ONLY_TENANT_MEMORI_ON_DEFAULT_ONLY_IE_PURPOSE: the configuration is applied to the Tenant's Memori objects with the default configuration, for Import/Export purpose only. ONLY_TENANT_MEMORI_ON_DEFAULT_ONLY_DT_PURPOSE: the configuration is applied to the Tenant's Memori objects with the default configuration, for Deep Thought purpose only. ONLY_TENANT_MEMORI_ON_DEFAULT_ALL_ENABLED_PURPOSES: the configuration is applied to the Tenant's Memori objects with the default configuration, for all enabled purposes. ALL_TENANT_MEMORI_ONLY_QA_PURPOSE: the configuration is applied to all the Tenant's Memori objects, for Question & Answer purpose only. ALL_TENANT_MEMORI_ONLY_IE_PURPOSE: the configuration is applied to all the Tenant's Memori objects, for Import/Export purpose only. ALL_TENANT_MEMORI_ONLY_DT_PURPOSE: the configuration is applied to all the Tenant's Memori objects, for Deep Thought purpose only. ALL_TENANT_MEMORI_ALL_ENABLED_PURPOSES: the configuration is applied to all the Tenant's Memori objects, for all enabled purposes.

Responses

200

Success

application/json

patch

PATCH /api/v2/CompletionConfig/{strToken}/{strConfigID} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 401

{
  "completionConfigID": "text",
  "configName": "text",
  "description": "text",
  "provider": "text",
  "endPoint": "text",
  "apiKey": "text",
  "model": "text",
  "questionAnsweringEnabled": true,
  "importExportEnabled": true,
  "deepThoughtEnabled": true,
  "ownerUserID": "text",
  "ownerUserName": "text",
  "ownerTenantName": "text",
  "visibleToTenantUsers": true,
  "visibleToOtherUsers": true,
  "useAsDefault": true,
  "chargeable": true,
  "applyTo": "text"
}

200

Success

{
  "appliedMemoriIDs": [
    "text"
  ],
  "appliedMemoriNames": [
    "text"
  ],
  "config": {
    "completionConfigID": "text",
    "configName": "text",
    "description": "text",
    "provider": "text",
    "endPoint": "text",
    "apiKey": "text",
    "model": "text",
    "questionAnsweringEnabled": true,
    "importExportEnabled": true,
    "deepThoughtEnabled": true,
    "ownerUserID": "text",
    "ownerUserName": "text",
    "ownerTenantName": "text",
    "visibleToTenantUsers": true,
    "visibleToOtherUsers": true,
    "useAsDefault": true,
    "chargeable": true,
    "applyTo": "text"
  },
  "requestID": 1,
  "requestDateTime": "2025-06-07T15:20:12.697Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Creates a new Completion Config object. The created Completion Config object is owned by the currently logged-in user.

post

Path parameters

strTokenstringRequired

The login token

Body

Specifications of a Completion Config object.

completionConfigIDstring | nullableOptional

Completion Config object ID. Returned during Get operations. Ignored in other cases.

configNamestring | nullableOptional

Completion Config unique name. Required during Creation operations. Used during Update operations. Returned during Get operations.

descriptionstring | nullableOptional

Optional Completion Config description. Used during Creation operations and Update. Returned during Get operations.

providerstring | nullableOptional

endPointstring | nullableOptional

URL of the Completion Provider API end-point. Used during Creation operations and Update. Returned during Get operations.

apiKeystring | nullableOptional

API key of the Completion Provider API end-point. Required during Creation operations. Used during Update operations. Returned during Get operations as an obfuscated value.

modelstring | nullableOptional

questionAnsweringEnabledboolean | nullableOptional

importExportEnabledboolean | nullableOptional

deepThoughtEnabledboolean | nullableOptional

ownerUserIDstring | nullableOptional

ID of the User this Config belongs to. Returned during Get operations if the user is the owner or an administrator. Ignored in other cases.

ownerUserNamestring | nullableOptional

Name of the User this Config belongs to. Returned during Get operations. Ignored in other cases.

ownerTenantNamestring | nullableOptional

Name of the Tenant of the User this Config belongs to. Returned during Get operations. Ignored in other cases.

visibleToTenantUsersboolean | nullableOptional

If True this configuration can be used by other users of the owner's Tenant. If not specified False is assumed. Used during Creation operations and Update operations. Returned during Get operations.

visibleToOtherUsersboolean | nullableOptional

If True this configuration can be used by users of other Tenants. If not specified False is assumed. Used during Creation operations and Update operations. Returned during Get operations.

useAsDefaultboolean | nullableOptional

chargeableboolean | nullableOptional

If True the use of this configuration is chargeable to the customer.

applyTostring | nullableOptional

Responses

200

Success

application/json

post

POST /api/v2/CompletionConfig/{strToken} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 401

{
  "completionConfigID": "text",
  "configName": "text",
  "description": "text",
  "provider": "text",
  "endPoint": "text",
  "apiKey": "text",
  "model": "text",
  "questionAnsweringEnabled": true,
  "importExportEnabled": true,
  "deepThoughtEnabled": true,
  "ownerUserID": "text",
  "ownerUserName": "text",
  "ownerTenantName": "text",
  "visibleToTenantUsers": true,
  "visibleToOtherUsers": true,
  "useAsDefault": true,
  "chargeable": true,
  "applyTo": "text"
}

200

Success

{
  "appliedMemoriIDs": [
    "text"
  ],
  "appliedMemoriNames": [
    "text"
  ],
  "config": {
    "completionConfigID": "text",
    "configName": "text",
    "description": "text",
    "provider": "text",
    "endPoint": "text",
    "apiKey": "text",
    "model": "text",
    "questionAnsweringEnabled": true,
    "importExportEnabled": true,
    "deepThoughtEnabled": true,
    "ownerUserID": "text",
    "ownerUserName": "text",
    "ownerTenantName": "text",
    "visibleToTenantUsers": true,
    "visibleToOtherUsers": true,
    "useAsDefault": true,
    "chargeable": true,
    "applyTo": "text"
  },
  "requestID": 1,
  "requestDateTime": "2025-06-07T15:20:12.697Z",
  "resultCode": 1,
  "resultMessage": "text"
}