Get Page - Prisme.ai

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

Page slug

Response

Success Response

slug

string

required

appInstances

object[]

required

Hide child attributes

appInstances.slug

string

appInstances.blocks

object

Map block slugs to their specification

Option 1
Option 2

Hide child attributes

appInstances.blocks.{key}

object

Block

Hide child attributes

appInstances.blocks.{key}.description

Hide child attributes

appInstances.blocks.{key}.description.{key}

string

Example:

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

appInstances.blocks.{key}.name

Hide child attributes

appInstances.blocks.{key}.name.{key}

string

Example:

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

appInstances.blocks.{key}.photo

string

appInstances.blocks.{key}.url

string

deprecated

A block can be a javascript bundled file. Host it on the internet and put its url here.

appInstances.blocks.{key}.edit

object

deprecated

Hide child attributes

appInstances.blocks.{key}.edit.type

enum<string>

Available options:

string,

number,

object,

array,

boolean,

localized:string,

localized:number,

localized:boolean

appInstances.blocks.{key}.edit.format

string

appInstances.blocks.{key}.edit.properties

object

Hide child attributes

appInstances.blocks.{key}.edit.title

Hide child attributes

appInstances.blocks.{key}.edit.title.{key}

string

Example:

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

appInstances.blocks.{key}.edit.description

Hide child attributes

appInstances.blocks.{key}.edit.description.{key}

string

Example:

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

appInstances.blocks.{key}.edit.items

any

appInstances.blocks.{key}.edit.ui:widget

string

appInstances.blocks.{key}.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" }
}

appInstances.blocks.{key}.block

string

deprecated

A block can extends another one by giving its name here

appInstances.blocks.{key}.config

any

deprecated

default config applied to the Block. Usefull for extended Blocks.

appInstances.blocks.{key}.automation

appInstances.blocks.{key}.blocks

object[]

Hide child attributes

appInstances.blocks.{key}.blocks.slug

string

required

appInstances.blocks.{key}.blocks.appInstance

string

appInstances.blocks.{key}.blocks.onInit

appInstances.blocks.{key}.blocks.updateOn

string

appInstances.blocks.{key}.blocks.automation

appInstances.blocks.{key}.css

string

Css applied to Block

appInstances.blocks.{key}.schema

object

Hide child attributes

appInstances.blocks.{key}.schema.type

enum<string>

Available options:

string,

number,

object,

array,

boolean,

localized:string,

localized:number,

localized:boolean

appInstances.blocks.{key}.schema.format

string

appInstances.blocks.{key}.schema.properties

object

Hide child attributes

appInstances.blocks.{key}.schema.title

Hide child attributes

appInstances.blocks.{key}.schema.title.{key}

string

Example:

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

appInstances.blocks.{key}.schema.description

Hide child attributes

appInstances.blocks.{key}.schema.description.{key}

string

Example:

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

appInstances.blocks.{key}.schema.items

any

appInstances.blocks.{key}.schema.ui:widget

string

appInstances.blocks.{key}.schema.ui:options

object

Example:

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

Example:

{
  "Dialog Manager.config": {
    "url": "https://cdn-assets.prisme.ai/widgets/nlu/setup-widget/main.js"
  }
}

name

Hide child attributes

name.{key}

string

Example:

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

description

Hide child attributes

description.{key}

string

Example:

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

workspaceId

string

workspaceSlug

string

blocks

object[]

Hide child attributes

blocks.slug

string

required

blocks.appInstance

string

blocks.onInit

blocks.updateOn

string

blocks.automation

labels

string[]

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

events

object

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

createdBy

string

updatedBy

string

createdAt

string

updatedAt

string

permissions

object

Hide child attributes

permissions.{key}

object

Hide child attributes

permissions.{key}.role

string

permissions.{key}.policies

object

Hide child attributes

permissions.{key}.policies.read

boolean

permissions.{key}.policies.write

boolean

permissions.{key}.policies.update

boolean

permissions.{key}.policies.create

boolean

permissions.{key}.policies.manage_permissions

boolean

customDomains

string[]

colorScheme

enum<string>

Available options:

auto,

light,

dark

checksum

string

favicon

string

styles

string

onInit

updateOn

string

notifyOn

string

automation

public

boolean

Indicates whether this page is public. Reflects page permissions and cannot be set directly

apiKey

string

clientId

string