List App Instances

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.studio.prisme.ai/v2/workspaces/{workspaceId}/apps', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.studio.prisme.ai/v2/workspaces/{workspaceId}/apps"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

[
  {
    "appSlug": "<string>",
    "slug": "<string>",
    "automations": [
      {
        "slug": "<string>",
        "name": {
          "fr": "Bonjour",
          "en": "Hello"
        },
        "arguments": {},
        "description": {
          "fr": "Bonjour",
          "en": "Hello"
        },
        "schemas": [
          {
            "conditions": {},
            "payload": {
              "type": "string",
              "title": {
                "en": "User ID"
              },
              "description": {
                "en": "The unique identifier of the user"
              }
            },
            "output": {
              "type": "string",
              "title": {
                "en": "User ID"
              },
              "description": {
                "en": "The unique identifier of the user"
              }
            }
          }
        ]
      }
    ],
    "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"
          }
        },
        "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>",
    "appMissing": true
  }
]

{
  "error": "BadParameters",
  "message": "<string>",
  "details": "<unknown>"
}

{
  "error": "AuthenticationError",
  "message": "Unauthenticated"
}

{
  "error": "ForbiddenError",
  "message": "Forbidden"
}

{
  "error": "ObjectNotFound",
  "message": "<string>"
}

GET

workspaces

{workspaceId}

apps

List App Instances

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.studio.prisme.ai/v2/workspaces/{workspaceId}/apps', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.studio.prisme.ai/v2/workspaces/{workspaceId}/apps"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

[
  {
    "appSlug": "<string>",
    "slug": "<string>",
    "automations": [
      {
        "slug": "<string>",
        "name": {
          "fr": "Bonjour",
          "en": "Hello"
        },
        "arguments": {},
        "description": {
          "fr": "Bonjour",
          "en": "Hello"
        },
        "schemas": [
          {
            "conditions": {},
            "payload": {
              "type": "string",
              "title": {
                "en": "User ID"
              },
              "description": {
                "en": "The unique identifier of the user"
              }
            },
            "output": {
              "type": "string",
              "title": {
                "en": "User ID"
              },
              "description": {
                "en": "The unique identifier of the user"
              }
            }
          }
        ]
      }
    ],
    "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"
          }
        },
        "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>",
    "appMissing": true
  }
]

{
  "error": "BadParameters",
  "message": "<string>",
  "details": "<unknown>"
}

{
  "error": "AuthenticationError",
  "message": "Unauthenticated"
}

{
  "error": "ForbiddenError",
  "message": "Forbidden"
}

{
  "error": "ObjectNotFound",
  "message": "<string>"
}

Authorizations

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

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

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,

integer,

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

Hide child attributes

automations.arguments.{key}.title.{key}

string

Example:

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

automations.arguments.{key}.description

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

automations.arguments.{key}.secret

boolean

automations.arguments.{key}.redact

boolean

Path-redact this field from runtime execution events (runtime.automations.executed), whatever its size. Redact itself never tracks the value: each automation the value transits through must re-declare redact on its own schema. It does not disable a secret declaration on the same or a nested field — secret takes precedence, so a field marked both is value-tracked AND path-redacted. Only reachable through nested properties: a marker inside items, additionalProperties or oneOf-style keywords is ignored (redact the parent field itself).

automations.arguments.{key}.required

string[]

automations.arguments.{key}.event

boolean

Example:

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

automations.description

Hide child attributes

automations.description.{key}

string

Example:

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

automations.schemas

object[]

Conditional input/output schemas. Takes precedence over arguments for validation when present; arguments-declared secret & redact markers remain enforced on every branch, while branch-declared secrets only apply to calls matching their branch.

Hide child attributes

automations.schemas.conditions

object

Every entry must equal the corresponding payload variable for the branch to match. Keys are dot-paths resolved from the payload root (method, body.kind…); method is matched case-insensitively. Values are compared as strings after scalar coercion (2 matches "2" — query parameters always arrive as strings); an object or array value never matches.

automations.schemas.payload

object

Hide child attributes

automations.schemas.payload.type

enum<string>

Available options:

string,

number,

integer,

object,

array,

boolean,

localized:string,

localized:number,

localized:boolean

automations.schemas.payload.format

string

automations.schemas.payload.properties

object

Hide child attributes

automations.schemas.payload.properties.{key}

object

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

automations.schemas.payload.title

Hide child attributes

automations.schemas.payload.title.{key}

string

Example:

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

automations.schemas.payload.description

Hide child attributes

automations.schemas.payload.description.{key}

string

Example:

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

automations.schemas.payload.items

object

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

automations.schemas.payload.ui:widget

string

automations.schemas.payload.ui:options

object

automations.schemas.payload.secret

boolean

automations.schemas.payload.redact

boolean

automations.schemas.payload.required

string[]

automations.schemas.payload.event

boolean

Example:

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

automations.schemas.output

object

Hide child attributes

automations.schemas.output.type

enum<string>

Available options:

string,

number,

integer,

object,

array,

boolean,

localized:string,

localized:number,

localized:boolean

automations.schemas.output.format

string

automations.schemas.output.properties

object

Hide child attributes

automations.schemas.output.properties.{key}

object

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

automations.schemas.output.title

Hide child attributes

automations.schemas.output.title.{key}

string

Example:

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

automations.schemas.output.description

Hide child attributes

automations.schemas.output.description.{key}

string

Example:

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

automations.schemas.output.items

object

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

automations.schemas.output.ui:widget

string

automations.schemas.output.ui:options

object

automations.schemas.output.secret

boolean

automations.schemas.output.redact

boolean

automations.schemas.output.required

string[]

automations.schemas.output.event

boolean

Example:

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

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,

integer,

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

Hide child attributes

blocks.edit.title.{key}

string

Example:

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

blocks.edit.description

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

blocks.edit.secret

boolean

blocks.edit.redact

boolean

blocks.edit.required

string[]

blocks.edit.event

boolean

Example:

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

blocks.name

Hide child attributes

blocks.name.{key}

string

Example:

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

blocks.description

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,

integer,

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

Hide child attributes

blocks.arguments.{key}.title.{key}

string

Example:

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

blocks.arguments.{key}.description

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

blocks.arguments.{key}.secret

boolean

blocks.arguments.{key}.redact

boolean

blocks.arguments.{key}.required

string[]

blocks.arguments.{key}.event

boolean

Example:

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

appName

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

appMissing

boolean

True when the referenced app no longer exists in the platform (uninstalled/deleted). The instance is kept in the list so it stays visible and removable.

Introduction

Platform API

Agent Creator API

LLM Gateway API

Governance API

Knowledges API

Collections API

List App Instances

Authorizations

Path Parameters

Response