Create IM Integration

curl -X POST 'https://app.memorylake.ai/openapi/memorylake/admin/v1/integrations' \
  -H 'Authorization: Bearer sk_xxxxxx' \
  -H 'Idempotency-Key: 7c1d2e3f-0a9b-4c8d-b7e6-f5a4d3c2b1a0' \
  -H 'Content-Type: application/json' \
  -d '{
    "agent_id": "010480e33a3f952c9d61c9f8d39bb410",
    "channel": "dingtalk",
    "credentials": {
      "appId": "example",
      "appKey": "example",
      "appSecret": "example",
      "appToken": "example",
      "botId": "example",
      "botToken": "example",
      "secret": "example"
    },
    "name": "Example name",
    "read_write_project_id": "b60e42e8ed8f4c1a4eca1eaa53ad7c90",
    "workspace_id": "9c542f78770f7e85ff018ddfc2c63541",
    "daily_message_limit": 1,
    "dataset_ids": [
      "3748f84ef0d2e877c0097b8f32d45cf0"
    ],
    "read_only_project_ids": [
      "5af1515af082229ccfd68f981a6cf886"
    ],
    "settings": {
      "card_template_id": "870213bad9d43369a8af134b1b482d6e"
    }
  }'

{
  "success": true,
  "message": "Operation completed successfully",
  "data": {
    "agent_id": "9926a90400d85f0a54e9e195e915db44",
    "channel": "dingtalk",
    "created_at": 1760000000,
    "credentials_configured": false,
    "daily_message_limit": 1,
    "dataset_ids": [
      "3748f84ef0d2e877c0097b8f32d45cf0"
    ],
    "enabled": true,
    "external_app_id": "524832f3cb1ba8ef33208d0692b8d565",
    "id": "f58008acc066bab6dfb73de8efde8905",
    "name": "Example name",
    "read_only_project_ids": [
      "5af1515af082229ccfd68f981a6cf886"
    ],
    "read_write_project_id": "aed31b20113b86ecc2587aa0cbc0eb2f",
    "settings": {
      "card_template_id": "870213bad9d43369a8af134b1b482d6e"
    },
    "status": "pending",
    "updated_at": 1760000000,
    "workspace_id": "ce55865bcc4c12c26161d24b238a888e",
    "status_error": "example",
    "status_error_code": "credentials_invalid"
  }
}

curl -X POST 'https://app.memorylake.ai/openapi/memorylake/admin/v1/integrations' \
  -H 'Authorization: Bearer sk_xxxxxx' \
  -H 'Idempotency-Key: 7c1d2e3f-0a9b-4c8d-b7e6-f5a4d3c2b1a0' \
  -H 'Content-Type: application/json' \
  -d '{
    "agent_id": "010480e33a3f952c9d61c9f8d39bb410",
    "channel": "dingtalk",
    "credentials": {
      "appId": "example",
      "appKey": "example",
      "appSecret": "example",
      "appToken": "example",
      "botId": "example",
      "botToken": "example",
      "secret": "example"
    },
    "name": "Example name",
    "read_write_project_id": "b60e42e8ed8f4c1a4eca1eaa53ad7c90",
    "workspace_id": "9c542f78770f7e85ff018ddfc2c63541",
    "daily_message_limit": 1,
    "dataset_ids": [
      "3748f84ef0d2e877c0097b8f32d45cf0"
    ],
    "read_only_project_ids": [
      "5af1515af082229ccfd68f981a6cf886"
    ],
    "settings": {
      "card_template_id": "870213bad9d43369a8af134b1b482d6e"
    }
  }'

{
  "success": true,
  "message": "Operation completed successfully",
  "data": {
    "agent_id": "9926a90400d85f0a54e9e195e915db44",
    "channel": "dingtalk",
    "created_at": 1760000000,
    "credentials_configured": false,
    "daily_message_limit": 1,
    "dataset_ids": [
      "3748f84ef0d2e877c0097b8f32d45cf0"
    ],
    "enabled": true,
    "external_app_id": "524832f3cb1ba8ef33208d0692b8d565",
    "id": "f58008acc066bab6dfb73de8efde8905",
    "name": "Example name",
    "read_only_project_ids": [
      "5af1515af082229ccfd68f981a6cf886"
    ],
    "read_write_project_id": "aed31b20113b86ecc2587aa0cbc0eb2f",
    "settings": {
      "card_template_id": "870213bad9d43369a8af134b1b482d6e"
    },
    "status": "pending",
    "updated_at": 1760000000,
    "workspace_id": "ce55865bcc4c12c26161d24b238a888e",
    "status_error": "example",
    "status_error_code": "credentials_invalid"
  }
}

POST /openapi/memorylake/admin/v1/integrations

Connects a DingTalk, WeCom, Feishu or Slack bot to an agent. The integration is enabled at once and starts in status pending. DingTalk, Feishu and Slack credentials are verified with the platform before anything is saved (an access-token exchange or auth.test — no message is sent); WeCom credentials are checked by connecting, so follow status with Get IM Integration. A bot can be connected only once. You also need write access to read_write_project_id and search access to each read-only project.

Permission required: workspace:integration_manage on workspace_id

When you set read_write_project_id: project:mem_add on read_write_project_id
When you set read_only_project_ids: project:mem_search on read_only_project_ids

Headers

string

Optional. Retrying with the same value replays the first result instead of creating a second integration. Credential values are not compared.

Request Body

string

required

Agent that answers messages sent to the bot

string

required

IM platform. Must be enabled on this deployment. One of: dingtalk, wecom, feishu, slack.

object

required

Write-only. dingtalk: appKey + appSecret; feishu: appId + appSecret; slack: botToken + appToken; wecom: botId + secret. DingTalk, Feishu and Slack credentials are verified with the platform before saving.

Show Integration Credentials object

string

Feishu: App ID. Identifies the bot; cannot change after creation.

string

DingTalk: Client ID (AppKey). Identifies the bot; cannot change after creation.

string

DingTalk: Client Secret (AppSecret). Feishu: App Secret.

string

Slack: App-Level Token (xapp-…) with connections:write.

string

WeCom: Bot ID of the intelligent robot. Identifies the bot; cannot change after creation.

string

Slack: Bot User OAuth Token (xoxb-…). Apps with token rotation enabled are not supported.

string

WeCom: Secret of the intelligent robot.

string

required

Display name

string

required

Project that memories extracted from IM conversations are written to. Anyone who can message the bot can add to it.

string

required

Workspace the integration belongs to. Cannot change later.

integer

Maximum messages handled per day; omit or 0 = unlimited

array

Open-data datasets the agent may use

array

Additional projects searched (read only). Must not repeat read_write_project_id.

object

Channel-specific settings

Show Integration Settings object

string

DingTalk only: AI card template id. Set it to stream replies into an interactive card; omit or send "" to reply with plain messages.

curl -X POST 'https://app.memorylake.ai/openapi/memorylake/admin/v1/integrations' \
  -H 'Authorization: Bearer sk_xxxxxx' \
  -H 'Idempotency-Key: 7c1d2e3f-0a9b-4c8d-b7e6-f5a4d3c2b1a0' \
  -H 'Content-Type: application/json' \
  -d '{
    "agent_id": "010480e33a3f952c9d61c9f8d39bb410",
    "channel": "dingtalk",
    "credentials": {
      "appId": "example",
      "appKey": "example",
      "appSecret": "example",
      "appToken": "example",
      "botId": "example",
      "botToken": "example",
      "secret": "example"
    },
    "name": "Example name",
    "read_write_project_id": "b60e42e8ed8f4c1a4eca1eaa53ad7c90",
    "workspace_id": "9c542f78770f7e85ff018ddfc2c63541",
    "daily_message_limit": 1,
    "dataset_ids": [
      "3748f84ef0d2e877c0097b8f32d45cf0"
    ],
    "read_only_project_ids": [
      "5af1515af082229ccfd68f981a6cf886"
    ],
    "settings": {
      "card_template_id": "870213bad9d43369a8af134b1b482d6e"
    }
  }'

Response

object

Show Integration object

string

Agent that answers messages sent to the bot

string

IM platform. One of: dingtalk, wecom, feishu, slack.

integer

Creation time, Unix seconds

boolean

Whether credentials are stored. Credentials themselves are write-only and never returned.

integer

Maximum messages this integration handles per day; 0 = unlimited

array

Open-data datasets the agent may use

boolean

Whether the integration should be connected

string

The bot’s identifier on the IM platform (DingTalk Client ID, Feishu App ID, WeCom Bot ID, Slack team:bot-user). Not a secret.

string

Identifier of the integration

string

Display name

array

Additional projects searched (read only)

string

Project that memories extracted from IM conversations are written to

object

Channel-specific settings

Show Integration Settings object

string

DingTalk only: AI card template id. Set it to stream replies into an interactive card; omit or send "" to reply with plain messages.

string

Connection state. pending right after a create or a credential change until the first connection attempt; poll Get IM Integration to follow it. One of: pending, connected, error, disabled.

integer

Last update time, Unix seconds

string

Workspace the integration belongs to. Fixed at creation.

string

Short normalized reason when status is error, for display (Chinese, the console’s wording; it may change). Never contains the platform’s raw response. Use status_error_code in programs.

string

Stable reason code, present whenever status_error is. credentials_invalid: the platform rejected the credentials (fix them); subscribe_rejected: WeCom refused the subscription — wrong credentials or the platform’s rate limit, retried automatically; preempted: another connection took over the bot, usually the same bot connected from another environment; timeout / disconnected / connection_aborted / connection_failed: connection problems, retried automatically; dependency_unavailable: a service this deployment depends on is down, retried automatically; dependency_misconfigured: this deployment lacks something the channel needs (WeCom needs Redis) — contact the operator; internal_error: a fault on our side; unknown: the reason was recorded before codes existed, and is replaced on the next connection attempt. New codes may be added; treat an unrecognised one like connection_failed.

{
  "success": true,
  "message": "Operation completed successfully",
  "data": {
    "agent_id": "9926a90400d85f0a54e9e195e915db44",
    "channel": "dingtalk",
    "created_at": 1760000000,
    "credentials_configured": false,
    "daily_message_limit": 1,
    "dataset_ids": [
      "3748f84ef0d2e877c0097b8f32d45cf0"
    ],
    "enabled": true,
    "external_app_id": "524832f3cb1ba8ef33208d0692b8d565",
    "id": "f58008acc066bab6dfb73de8efde8905",
    "name": "Example name",
    "read_only_project_ids": [
      "5af1515af082229ccfd68f981a6cf886"
    ],
    "read_write_project_id": "aed31b20113b86ecc2587aa0cbc0eb2f",
    "settings": {
      "card_template_id": "870213bad9d43369a8af134b1b482d6e"
    },
    "status": "pending",
    "updated_at": 1760000000,
    "workspace_id": "ce55865bcc4c12c26161d24b238a888e",
    "status_error": "example",
    "status_error_code": "credentials_invalid"
  }
}

Errors

Errors answer with success: false, a message and an error_code. See Error Codes for every code.

Status	Meaning
`400`	A parameter or the body is invalid
`401`	The API key is missing, invalid, disabled or expired
`403`	The key is not allowed to do this
`404`	The resource does not exist
`409`	The request conflicts with the current state, e.g. a duplicate or a limit reached
`422`	The body or a parameter failed validation
`429`	Too many requests. Wait for the time in `Retry-After`
`500`	Server-side error
`503`	Temporarily unavailable. Retry later

MemoryLake API

Memory Router API

Headers

Request Body

Response

Errors

​Headers

​Request Body

​Response

​Errors

Headers

Request Body

Response

Errors