List App Instances

Get installed aps

GET /v2/workspaces/{workspaceId}/apps

List App Instances

cURL

curl --request GET \
  --url https://api.studio.prisme.ai/v2/workspaces/{workspaceId}/apps \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "appSlug": "<string>",
    "slug": "<string>",
    "automations": [
      {
        "slug": "<string>",
        "name": {
          "fr": "Bonjour",
          "en": "Hello"
        },
        "arguments": {},
        "description": {
          "fr": "Bonjour",
          "en": "Hello"
        }
      }
    ],
    "events": {
      "emit": [
        "<string>"
      ],
      "listen": [
        "<string>"
      ],
      "autocomplete": [
        {
          "event": "prismeaiMessenger.message",
          "autocomplete": {}
        }
      ]
    },
    "blocks": [
      {
        "slug": "<string>",
        "url": "<string>",
        "edit": {
          "type": "string",
          "title": {
            "en": "User ID"
          },
          "description": {
            "en": "The unique identifier of the user"
          },
          "secret": {
            "type": "boolean"
          },
          "event": {
            "type": "boolean"
          }
        },
        "name": {
          "fr": "Bonjour",
          "en": "Hello"
        },
        "description": {
          "fr": "Bonjour",
          "en": "Hello"
        },
        "arguments": {}
      }
    ],
    "appName": {
      "fr": "Bonjour",
      "en": "Hello"
    },
    "appVersion": "<string>",
    "disabled": true,
    "labels": [
      "<string>"
    ],
    "updatedAt": "<string>",
    "createdAt": "<string>",
    "updatedBy": "<string>",
    "createdBy": "<string>",
    "checksum": "<string>",
    "photo": "<string>"
  }
]

Authorizations

BearerAuthOrgApiKeyAuthBearerAuth & OrgApiKeyAuth

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId · string · required

Workspace id

Response

200

application/json

Success Response

appSlug · string · required

App unique id

slug · string · required

Unique & human readable id across current workspace's appInstances, which will be used to call this app automations

automations · object[] · required

Hide child attributes

automations. slug · string · required

automations. name · object string · required

Hide child attributes

automations.name. {key} · string

Example:

{ "fr": "Bonjour", "en": "Hello" }

automations. arguments · object · required

Hide child attributes

automations.arguments. {key} · object

Hide child attributes

automations.arguments.{key}. type · enum<string>

Available options: string, number, object, array, boolean, localized:string, localized:number, localized:boolean

automations.arguments.{key}. format · string

automations.arguments.{key}. properties · object

Hide child attributes

automations.arguments.{key}.properties. {key} · object

Recursive reference to TypedArgument — nesting is truncated here to avoid the infinite expansion that crashes the API reference renderer.

automations.arguments.{key}. title · object string

Hide child attributes

automations.arguments.{key}.title. {key} · string

Example:

{ "fr": "Bonjour", "en": "Hello" }

automations.arguments.{key}. description · object string

Hide child attributes

automations.arguments.{key}.description. {key} · string

Example:

{ "fr": "Bonjour", "en": "Hello" }

automations.arguments.{key}. items · object

Recursive reference to TypedArgument — nesting is truncated here to avoid the infinite expansion that crashes the API reference renderer.

automations.arguments.{key}. ui:widget · string

automations.arguments.{key}. ui:options · object

Example:

{
  "type": "string",
  "title": { "en": "User ID" },
  "description": { "en": "The unique identifier of the user" },
  "secret": { "type": "boolean" },
  "event": { "type": "boolean" }
}

automations. description · object string

Hide child attributes

automations.description. {key} · string

Example:

{ "fr": "Bonjour", "en": "Hello" }

events · object · required

Hide child attributes

events. emit · string[]

events. listen · string[]

events. autocomplete · object[]

Hide child attributes

events.autocomplete. event · string · required

Example:

"prismeaiMessenger.message"

events.autocomplete. autocomplete · object

Hide child attributes

events.autocomplete.autocomplete. {key} · object

Hide child attributes

events.autocomplete.autocomplete.{key}. from · string

events.autocomplete.autocomplete.{key}. path · string

events.autocomplete.autocomplete.{key}. template · string

blocks · object[] · required

Hide child attributes

blocks. slug · string · required

blocks. url · string

blocks. edit · object

Hide child attributes

blocks.edit. type · enum<string>

Available options: string, number, object, array, boolean, localized:string, localized:number, localized:boolean

blocks.edit. format · string

blocks.edit. properties · object

Hide child attributes

blocks.edit.properties. {key} · object

Recursive reference to TypedArgument — nesting is truncated here to avoid the infinite expansion that crashes the API reference renderer.

blocks.edit. title · object string

Hide child attributes

blocks.edit.title. {key} · string

Example:

{ "fr": "Bonjour", "en": "Hello" }

blocks.edit. description · object string

Hide child attributes

blocks.edit.description. {key} · string

Example:

{ "fr": "Bonjour", "en": "Hello" }

blocks.edit. items · object

Recursive reference to TypedArgument — nesting is truncated here to avoid the infinite expansion that crashes the API reference renderer.

blocks.edit. ui:widget · string

blocks.edit. ui:options · object

Example:

{
  "type": "string",
  "title": { "en": "User ID" },
  "description": { "en": "The unique identifier of the user" },
  "secret": { "type": "boolean" },
  "event": { "type": "boolean" }
}

blocks. name · object string

Hide child attributes

blocks.name. {key} · string

Example:

{ "fr": "Bonjour", "en": "Hello" }

blocks. description · object string

Hide child attributes

blocks.description. {key} · string

Example:

{ "fr": "Bonjour", "en": "Hello" }

blocks. arguments · object

Hide child attributes

blocks.arguments. {key} · object

Hide child attributes

blocks.arguments.{key}. type · enum<string>

Available options: string, number, object, array, boolean, localized:string, localized:number, localized:boolean

blocks.arguments.{key}. format · string

blocks.arguments.{key}. properties · object

Hide child attributes

blocks.arguments.{key}.properties. {key} · object

Recursive reference to TypedArgument — nesting is truncated here to avoid the infinite expansion that crashes the API reference renderer.

blocks.arguments.{key}. title · object string

Hide child attributes

blocks.arguments.{key}.title. {key} · string

Example:

{ "fr": "Bonjour", "en": "Hello" }

blocks.arguments.{key}. description · object string

Hide child attributes

blocks.arguments.{key}.description. {key} · string

Example:

{ "fr": "Bonjour", "en": "Hello" }

blocks.arguments.{key}. items · object

Recursive reference to TypedArgument — nesting is truncated here to avoid the infinite expansion that crashes the API reference renderer.

blocks.arguments.{key}. ui:widget · string

blocks.arguments.{key}. ui:options · object

Example:

{
  "type": "string",
  "title": { "en": "User ID" },
  "description": { "en": "The unique identifier of the user" },
  "secret": { "type": "boolean" },
  "event": { "type": "boolean" }
}

appName · object string

Hide child attributes

appName. {key} · string

Example:

{ "fr": "Bonjour", "en": "Hello" }

appVersion · string

Defaults to the latest known app version

disabled · boolean

If disabled, this appInstance will be ignored during execution

labels · string[]

Pattern: ^[0-9A-Za-z._:-]{2,60}$

updatedAt · string

createdAt · string

updatedBy · string

createdBy · string

checksum · string

photo · string