Serenities AI™
Back to API Overview

Official Apps API

Install, update, and remove the apps Serenities ships, and inspect an install.

5 endpoints

Endpoints

POST
/api/v1/workspaceApp/list

The apps Serenities ships (for example Social: a calendar and composer for the account's social channels) with this account's install state: installed or not, the install id to open it at /dashboard/apps/i/<installId>/open, the version it runs, whether a newer release exists, and legacyProjectId when an older copy install has not yet moved onto a release.

Example Request

curl -X POST https://app.serenitiesai.com/api/v1/workspaceApp/list \
  -H "Authorization: Bearer mk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{}'
POST
/api/v1/workspaceApp/getInstall

One install of this account's (params: installId): its app, name, version and whether it is ready to open.

Parameters

installIdstringrequired

Example Request

curl -X POST https://app.serenitiesai.com/api/v1/workspaceApp/getInstall \
  -H "Authorization: Bearer mk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
  "installId": "example"
}'
POST
/api/v1/workspaceApp/usage

How many workspace apps this workspace has and how many its plan allows: { used, limit } (limit is null when the plan has no limit). Apps built here and apps installed from the app store count together. Check it before creating or enabling an app.

Example Request

curl -X POST https://app.serenitiesai.com/api/v1/workspaceApp/usage \
  -H "Authorization: Bearer mk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{}'
POST
/api/v1/workspaceApp/install

Enable an official app for this account (params: key, e.g. "social"). One release of the app is built once and shared by everyone who has it; enabling creates a row and a base of the account's own — no copy, no build. Re-running moves an existing install to the newest release and is never refused. A NEW install is a workspace app and counts against the plan's limit on workspace apps: when the workspace is full the call is refused with a plain message and an upgrade link — tell the person that message and give them the link, never retry.

Parameters

keystringrequired

App key from list, e.g. "social"

Example Request

curl -X POST https://app.serenitiesai.com/api/v1/workspaceApp/install \
  -H "Authorization: Bearer mk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
  "key": "example"
}'
POST
/api/v1/workspaceApp/uninstall

Remove an official app from this account (params: key). Deletes the install row; the account's base, social channels and posts are kept, and nothing of the vendor's is touched.

Parameters

keystringrequired

App key from list, e.g. "social"

Example Request

curl -X POST https://app.serenitiesai.com/api/v1/workspaceApp/uninstall \
  -H "Authorization: Bearer mk_live_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
  "key": "example"
}'