Get App Instance

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

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

fetch('https://api.studio.prisme.ai/v2/workspaces/{workspaceId}/apps/{slug}', 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/{slug}"

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

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

print(response.text)

{
  "appSlug": "<string>",
  "appName": {
    "fr": "Bonjour",
    "en": "Hello"
  },
  "appVersion": "<string>",
  "slug": "<string>",
  "disabled": true,
  "labels": [
    "<string>"
  ],
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "updatedBy": "<string>",
  "createdBy": "<string>",
  "checksum": "<string>",
  "config": {
    "schema": {},
    "block": "<string>",
    "value": "<unknown>"
  },
  "documentation": {
    "name": {
      "fr": "Bonjour",
      "en": "Hello"
    },
    "description": {
      "fr": "Bonjour",
      "en": "Hello"
    },
    "workspaceId": "<string>",
    "workspaceSlug": "<string>",
    "id": "<string>",
    "slug": "<string>",
    "blocks": [
      {
        "slug": "<string>",
        "appInstance": "<string>",
        "onInit": "<string>",
        "updateOn": "<string>",
        "automation": "<string>"
      }
    ],
    "labels": [
      "<string>"
    ],
    "events": {
      "emit": [
        "<string>"
      ],
      "listen": [
        "<string>"
      ],
      "autocomplete": [
        {
          "event": "prismeaiMessenger.message",
          "autocomplete": {}
        }
      ]
    },
    "createdBy": "<string>",
    "updatedBy": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "permissions": {},
    "customDomains": [
      "<string>"
    ],
    "colorScheme": "auto",
    "checksum": "<string>",
    "favicon": "<string>",
    "styles": "<string>",
    "onInit": "<string>",
    "updateOn": "<string>",
    "notifyOn": "<string>",
    "automation": "<string>"
  }
}

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

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

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

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

GET

workspaces

{workspaceId}

apps

{slug}

Get App Instance

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

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

fetch('https://api.studio.prisme.ai/v2/workspaces/{workspaceId}/apps/{slug}', 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/{slug}"

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

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

print(response.text)

{
  "appSlug": "<string>",
  "appName": {
    "fr": "Bonjour",
    "en": "Hello"
  },
  "appVersion": "<string>",
  "slug": "<string>",
  "disabled": true,
  "labels": [
    "<string>"
  ],
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "updatedBy": "<string>",
  "createdBy": "<string>",
  "checksum": "<string>",
  "config": {
    "schema": {},
    "block": "<string>",
    "value": "<unknown>"
  },
  "documentation": {
    "name": {
      "fr": "Bonjour",
      "en": "Hello"
    },
    "description": {
      "fr": "Bonjour",
      "en": "Hello"
    },
    "workspaceId": "<string>",
    "workspaceSlug": "<string>",
    "id": "<string>",
    "slug": "<string>",
    "blocks": [
      {
        "slug": "<string>",
        "appInstance": "<string>",
        "onInit": "<string>",
        "updateOn": "<string>",
        "automation": "<string>"
      }
    ],
    "labels": [
      "<string>"
    ],
    "events": {
      "emit": [
        "<string>"
      ],
      "listen": [
        "<string>"
      ],
      "autocomplete": [
        {
          "event": "prismeaiMessenger.message",
          "autocomplete": {}
        }
      ]
    },
    "createdBy": "<string>",
    "updatedBy": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "permissions": {},
    "customDomains": [
      "<string>"
    ],
    "colorScheme": "auto",
    "checksum": "<string>",
    "favicon": "<string>",
    "styles": "<string>",
    "onInit": "<string>",
    "updateOn": "<string>",
    "notifyOn": "<string>",
    "automation": "<string>"
  }
}

{
  "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

slug

string

required

App instance slug

Response

Success Response

appSlug

string

App unique id

appName

Hide child attributes

appName.{key}

string

Example:

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

appVersion

string

Defaults to the latest known app version

slug

string

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

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

config

object

Hide child attributes

config.schema

object

Hide child attributes

config.schema.{key}

object

Hide child attributes

config.schema.{key}.type

enum<string>

Available options:

string,

number,

integer,

object,

array,

boolean,

localized:string,

localized:number,

localized:boolean

config.schema.{key}.format

string

config.schema.{key}.properties

object

Hide child attributes

config.schema.{key}.properties.{key}

object

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

config.schema.{key}.title

Hide child attributes

config.schema.{key}.title.{key}

string

Example:

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

config.schema.{key}.description

Hide child attributes

config.schema.{key}.description.{key}

string

Example:

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

config.schema.{key}.items

object

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

config.schema.{key}.ui:widget

string

config.schema.{key}.ui:options

object

config.schema.{key}.secret

boolean

config.schema.{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).

config.schema.{key}.required

string[]

config.schema.{key}.event

boolean

Example:

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

config.block

string

config.value

any

documentation

object

Hide child attributes

documentation.name

Hide child attributes

documentation.name.{key}

string

Example:

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

documentation.description

Hide child attributes

documentation.description.{key}

string

Example:

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

documentation.workspaceId

string

documentation.workspaceSlug

string

documentation.id

string

documentation.slug

string

documentation.blocks

object[]

Hide child attributes

documentation.blocks.slug

string

required

documentation.blocks.appInstance

string

documentation.blocks.onInit

documentation.blocks.updateOn

string

documentation.blocks.automation

documentation.labels

string[]

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

documentation.events

object

Hide child attributes

documentation.events.emit

string[]

documentation.events.listen

string[]

documentation.events.autocomplete

object[]

Hide child attributes

documentation.events.autocomplete.event

string

required

Example:

"prismeaiMessenger.message"

documentation.events.autocomplete.autocomplete

object

Hide child attributes

documentation.events.autocomplete.autocomplete.{key}

object

Hide child attributes

documentation.events.autocomplete.autocomplete.{key}.from

string

documentation.events.autocomplete.autocomplete.{key}.path

string

documentation.events.autocomplete.autocomplete.{key}.template

string

documentation.createdBy

string

documentation.updatedBy

string

documentation.createdAt

string

documentation.updatedAt

string

documentation.permissions

object

Hide child attributes

documentation.permissions.{key}

object

Hide child attributes

documentation.permissions.{key}.role

string

documentation.permissions.{key}.policies

object

Hide child attributes

documentation.permissions.{key}.policies.read

boolean

documentation.permissions.{key}.policies.write

boolean

documentation.permissions.{key}.policies.update

boolean

documentation.permissions.{key}.policies.create

boolean

documentation.permissions.{key}.policies.manage_permissions

boolean

documentation.customDomains

string[]

documentation.colorScheme

enum<string>

Available options:

auto,

light,

dark

documentation.checksum

string

documentation.favicon

string

documentation.styles

string

documentation.onInit

documentation.updateOn

string

documentation.notifyOn

string

documentation.automation

Introduction

Platform API

Agent Creator API

LLM Gateway API

Governance API

Knowledges API

Collections API

Get App Instance

Authorizations

Path Parameters

Response