Skip to main content
POST
/
apps
/
install
Install an app
curl --request POST \
  --url https://apps-studio.thena.ai/apps/install \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "teamIds": [
    "TGCA9557W4",
    "TGCA9557W5"
  ],
  "appId": "9FKHF3KJ10JQTR2YJ6QW1QZTHBZ85",
  "appConfiguration": {
    "required_settings": [
      "check the app manifest for required_settings schema"
    ],
    "optional_settings": [
      "check the app manifest for optional_settings schema"
    ]
  }
}
'
{
  "appName": "Thena.ai",
  "botSub": "OGGA0557MV",
  "botTokenKey": "pk_live_*******_*******",
  "botToken": "pk_live_*******_*******",
  "installedBySub": "UGGA0557MV",
  "installedByEmail": "[email protected]",
  "appInstalledForTeams": [
    "TGGA0557MV",
    "TGGA0557MV"
  ],
  "appIdentifier": "thena-ai",
  "installedByOrgId": "OGGA0557MV",
  "metadata": {
    "app_identifier": "thena-ai",
    "app_name": "Thena.ai",
    "app_description": "Thena.ai is a platform for creating and managing AI agents.",
    "app_version": "1.0.0",
    "app_author": "Thena.ai",
    "app_author_email": "[email protected]",
    "app_author_url": "https://thena.ai"
  }
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
teamIds
string[]
required

Array of team IDs where the app will be installed

Example:
["TGCA9557W4", "TGCA9557W5"]
​
appId
string
required

Unique identifier of the app to be installed

Example:

"9FKHF3KJ10JQTR2YJ6QW1QZTHBZ85"

​
appConfiguration
object
required

Configuration settings for the app installation

Response

App installed successfully

​
appName
string
required

Name of the installed app

Example:

"Thena.ai"

​
botSub
string
required

Bot subscriber ID

Example:

"OGGA0557MV"

​
botTokenKey
string
required

Bot token key for authentication

Example:

"pk_live_*******_*******"

​
botToken
string
required

Bot token for authentication

Example:

"pk_live_*******_*******"

​
installedBySub
string
required

Subscriber ID of the user who installed the app

Example:

"UGGA0557MV"

​
installedByEmail
string
required

Email of the user who installed the app

Example:

"[email protected]"

​
appInstalledForTeams
string[]
required

List of team IDs where the app is installed

Example:
["TGGA0557MV", "TGGA0557MV"]
​
appIdentifier
string
required

Identifier of the app

Example:

"thena-ai"

​
installedByOrgId
string
required

Organization ID of the user who installed the app

Example:

"OGGA0557MV"

​
metadata
object
required

Metadata of the app

Example:
{
  "app_identifier": "thena-ai",
  "app_name": "Thena.ai",
  "app_description": "Thena.ai is a platform for creating and managing AI agents.",
  "app_version": "1.0.0",
  "app_author": "Thena.ai",
  "app_author_email": "[email protected]",
  "app_author_url": "https://thena.ai"
}