Get Workspace

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

Query Parameters

version

string

Optional version

Response

Success Response

name

string

required

Pattern: ^[0-9A-Za-zÀ-ÖØ-öø-ÿ ,.'- ]{1,60}$

description

Hide child attributes

description.{key}

string

Example:

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

photo

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,

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

Example:

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

config.block

string

config.value

any

blocks

object

Hide child attributes

blocks.{key}

object

Block

Hide child attributes

blocks.{key}.description

Hide child attributes

blocks.{key}.description.{key}

string

Example:

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

blocks.{key}.name

Hide child attributes

blocks.{key}.name.{key}

string

Example:

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

blocks.{key}.photo

string

blocks.{key}.url

string

deprecated

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

blocks.{key}.edit

object

deprecated

Hide child attributes

blocks.{key}.edit.type

enum<string>

Available options:

string,

number,

object,

array,

boolean,

localized:string,

localized:number,

localized:boolean

blocks.{key}.edit.format

string

blocks.{key}.edit.properties

object

Hide child attributes

blocks.{key}.edit.properties.{key}

object

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

blocks.{key}.edit.title

Hide child attributes

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

string

Example:

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

blocks.{key}.edit.description

Hide child attributes

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

string

Example:

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

blocks.{key}.edit.items

object

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

blocks.{key}.edit.ui:widget

string

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

blocks.{key}.block

string

deprecated

A block can extends another one by giving its name here

blocks.{key}.config

any

deprecated

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

blocks.{key}.automation

blocks.{key}.blocks

object[]

Hide child attributes

blocks.{key}.blocks.slug

string

required

blocks.{key}.blocks.appInstance

string

blocks.{key}.blocks.onInit

blocks.{key}.blocks.updateOn

string

blocks.{key}.blocks.automation

blocks.{key}.css

string

Css applied to Block

blocks.{key}.schema

object

Hide child attributes

blocks.{key}.schema.type

enum<string>

Available options:

string,

number,

object,

array,

boolean,

localized:string,

localized:number,

localized:boolean

blocks.{key}.schema.format

string

blocks.{key}.schema.properties

object

Hide child attributes

blocks.{key}.schema.properties.{key}

object

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

blocks.{key}.schema.title

Hide child attributes

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

string

Example:

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

blocks.{key}.schema.description

Hide child attributes

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

string

Example:

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

blocks.{key}.schema.items

object

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

blocks.{key}.schema.ui:widget

string

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

slug

string

labels

string[]

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

customDomains

string[]

registerWorkspace

boolean

If true, make this workspace metadata available to all workspaces with this variable : {{global.workspacesRegistry[WORKSPACE_SLUG]}}

repositories

object

Remote versioning repositories

Hide child attributes

repositories.{key}

object

Hide child attributes

repositories.{key}.name

string

required

repositories.{key}.config

object

required

Option 1
Option 2
Option 3

Hide child attributes

repositories.{key}.config.url

string

required

repositories.{key}.config.branch

string

required

repositories.{key}.config.dirpath

string

Sub-directory path within the repository where the workspace is stored

repositories.{key}.config.auth

object

Hide child attributes

repositories.{key}.config.auth.user

string

repositories.{key}.config.auth.password

string

repositories.{key}.config.auth.sshkey

string

repositories.{key}.type

enum<string>

Available options:

git,

archive,

filesystem

repositories.{key}.mode

enum<string>

Available options:

read-write,

read-only

repositories.{key}.groups

string[]

Only for platform repositories fetched from the Platform workspaces ; indicates which groups can be pulled/pushed

repositories.{key}.pull

object

Hide child attributes

repositories.{key}.pull.exclude

object[]

Hide child attributes

repositories.{key}.pull.exclude.path

string

required

platformRepositories

object

Platform remote versioning repositories

Hide child attributes

platformRepositories.{key}

object

Hide child attributes

platformRepositories.{key}.name

string

required

platformRepositories.{key}.config

object

required

Option 1
Option 2
Option 3

Hide child attributes

platformRepositories.{key}.config.url

string

required

platformRepositories.{key}.config.branch

string

required

platformRepositories.{key}.config.dirpath

string

Sub-directory path within the repository where the workspace is stored

platformRepositories.{key}.config.auth

object

Hide child attributes

platformRepositories.{key}.config.auth.user

string

platformRepositories.{key}.config.auth.password

string

platformRepositories.{key}.config.auth.sshkey

string

platformRepositories.{key}.type

enum<string>

Available options:

git,

archive,

filesystem

platformRepositories.{key}.mode

enum<string>

Available options:

read-write,

read-only

platformRepositories.{key}.groups

string[]

Only for platform repositories fetched from the Platform workspaces ; indicates which groups can be pulled/pushed

platformRepositories.{key}.pull

object

Hide child attributes

platformRepositories.{key}.pull.exclude

object[]

Hide child attributes

platformRepositories.{key}.pull.exclude.path

string

required

secrets

object

Hide child attributes

secrets.schema

object

Hide child attributes

secrets.schema.{key}

object

Hide child attributes

secrets.schema.{key}.type

enum<string>

Available options:

string,

number,

object,

array,

boolean,

localized:string,

localized:number,

localized:boolean

secrets.schema.{key}.format

string

secrets.schema.{key}.properties

object

Hide child attributes

secrets.schema.{key}.properties.{key}

object

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

secrets.schema.{key}.title

Hide child attributes

secrets.schema.{key}.title.{key}

string

Example:

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

secrets.schema.{key}.description

Hide child attributes

secrets.schema.{key}.description.{key}

string

Example:

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

secrets.schema.{key}.items

object

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

secrets.schema.{key}.ui:widget

string

secrets.schema.{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" }
}

events

object

Hide child attributes

events.mapping

object

Custom mapping which will be directly sent to underlying database (Elasticsearch/Opensearch)

events.types

object

Custom configuration per event type

Hide child attributes

events.types.{key}

object

Hide child attributes

events.types.{key}.schema

object

Hide child attributes

events.types.{key}.schema.{key}

object

Hide child attributes

events.types.{key}.schema.{key}.type

enum<string>

Available options:

string,

number,

object,

array,

boolean,

localized:string,

localized:number,

localized:boolean

events.types.{key}.schema.{key}.format

string

events.types.{key}.schema.{key}.properties

object

Hide child attributes

events.types.{key}.schema.{key}.properties.{key}

object

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

events.types.{key}.schema.{key}.title

Hide child attributes

events.types.{key}.schema.{key}.title.{key}

string

Example:

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

events.types.{key}.schema.{key}.description

Hide child attributes

events.types.{key}.schema.{key}.description.{key}

string

Example:

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

events.types.{key}.schema.{key}.items

object

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

events.types.{key}.schema.{key}.ui:widget

string

events.types.{key}.schema.{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" }
}

writeLock

object

Lock preventing writes during versioning operations or unresolved merge conflicts

Hide child attributes

writeLock.lockedAt

string

writeLock.lockedBy

string

User ID who initiated the lock

writeLock.reason

string

Reason for the lock (e.g., pull_in_progress, merge_conflict)

automations

object

Hide child attributes

automations.{key}

object

Hide child attributes

automations.{key}.name

required

Hide child attributes

automations.{key}.name.{key}

string

Example:

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

automations.{key}.description

Hide child attributes

automations.{key}.description.{key}

string

Example:

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

automations.{key}.private

boolean

Set this to true if you don't want your automation to be accessible outside of your app. Default is false.

Example:

false

automations.{key}.disabled

boolean

Set this to true if you want to turn off this automation.

Example:

true

automations.{key}.slug

string

Unique & human readable id across current workspace's automations

automations.{key}.arguments

object

Hide child attributes

automations.{key}.arguments.{key}

object

Hide child attributes

automations.{key}.arguments.{key}.type

enum<string>

Available options:

string,

number,

object,

array,

boolean,

localized:string,

localized:number,

localized:boolean

automations.{key}.arguments.{key}.format

string

automations.{key}.arguments.{key}.properties

object

Hide child attributes

automations.{key}.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.{key}.arguments.{key}.title

Hide child attributes

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

string

Example:

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

automations.{key}.arguments.{key}.description

Hide child attributes

automations.{key}.arguments.{key}.description.{key}

string

Example:

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

automations.{key}.arguments.{key}.items

object

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

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

string

automations.{key}.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.{key}.validateArguments

boolean

automations.{key}.when

object

Option 1
Option 2
Option 3
Option 4

Hide child attributes

automations.{key}.when.events

string[]

required

Example:

["prismeaiMessenger.event"]

automations.{key}.when.schedules

string[]

Example:

["2021-12-25T00:00", "* * 1 * *"]

automations.{key}.when.endpoint

Example:

"Set to true in order to activate HTTP endpoint. Slug will be trigger name by default"

automations.{key}.labels

string[]

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

automations.{key}.events

object

Hide child attributes

automations.{key}.events.emit

string[]

automations.{key}.events.listen

string[]

automations.{key}.events.autocomplete

object[]

Hide child attributes

automations.{key}.events.autocomplete.event

string

required

Example:

"prismeaiMessenger.message"

automations.{key}.events.autocomplete.autocomplete

object

Hide child attributes

automations.{key}.events.autocomplete.autocomplete.{key}

object

Hide child attributes

automations.{key}.events.autocomplete.autocomplete.{key}.from

string

automations.{key}.events.autocomplete.autocomplete.{key}.path

string

automations.{key}.events.autocomplete.autocomplete.{key}.template

string

automations.{key}.updatedAt

string

automations.{key}.createdAt

string

automations.{key}.updatedBy

string

automations.{key}.createdBy

string

automations.{key}.checksum

string

pages

object

Hide child attributes

pages.{key}

object

Page

Hide child attributes

pages.{key}.name

required

Hide child attributes

pages.{key}.name.{key}

string

Example:

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

pages.{key}.description

Hide child attributes

pages.{key}.description.{key}

string

Example:

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

pages.{key}.workspaceId

string

pages.{key}.workspaceSlug

string

pages.{key}.id

string

pages.{key}.slug

string

pages.{key}.blocks

object[]

Hide child attributes

pages.{key}.blocks.slug

string

pages.{key}.blocks.appInstance

string

pages.{key}.labels

string[]

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

pages.{key}.events

object

Hide child attributes

pages.{key}.events.emit

string[]

pages.{key}.events.listen

string[]

pages.{key}.events.autocomplete

object[]

Hide child attributes

pages.{key}.events.autocomplete.event

string

required

Example:

"prismeaiMessenger.message"

pages.{key}.events.autocomplete.autocomplete

object

Hide child attributes

pages.{key}.events.autocomplete.autocomplete.{key}

object

Hide child attributes

pages.{key}.events.autocomplete.autocomplete.{key}.from

string

pages.{key}.events.autocomplete.autocomplete.{key}.path

string

pages.{key}.events.autocomplete.autocomplete.{key}.template

string

pages.{key}.createdBy

string

pages.{key}.updatedBy

string

pages.{key}.createdAt

string

pages.{key}.updatedAt

string

pages.{key}.permissions

object

Hide child attributes

pages.{key}.permissions.{key}

object

Hide child attributes

pages.{key}.permissions.{key}.role

string

pages.{key}.permissions.{key}.policies

object

Hide child attributes

pages.{key}.permissions.{key}.policies.read

boolean

pages.{key}.permissions.{key}.policies.write

boolean

pages.{key}.permissions.{key}.policies.update

boolean

pages.{key}.permissions.{key}.policies.create

boolean

pages.{key}.permissions.{key}.policies.manage_permissions

boolean

pages.{key}.customDomains

string[]

pages.{key}.colorScheme

enum<string>

Available options:

auto,

light,

dark

pages.{key}.checksum

string

pages.{key}.favicon

string

imports

object

Hide child attributes

imports.{key}

object

Hide child attributes

imports.{key}.appSlug

string

required

App unique id

imports.{key}.slug

string

required

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

imports.{key}.automations

object[]

required

Hide child attributes

imports.{key}.automations.slug

string

required

imports.{key}.automations.name

required

Hide child attributes

imports.{key}.automations.name.{key}

string

Example:

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

imports.{key}.automations.arguments

object

required

Hide child attributes

imports.{key}.automations.arguments.{key}

object

Hide child attributes

imports.{key}.automations.arguments.{key}.type

enum<string>

Available options:

string,

number,

object,

array,

boolean,

localized:string,

localized:number,

localized:boolean

imports.{key}.automations.arguments.{key}.format

string

imports.{key}.automations.arguments.{key}.properties

object

Hide child attributes

imports.{key}.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.

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

Hide child attributes

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

string

Example:

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

imports.{key}.automations.arguments.{key}.description

Hide child attributes

imports.{key}.automations.arguments.{key}.description.{key}

string

Example:

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

imports.{key}.automations.arguments.{key}.items

object

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

imports.{key}.automations.arguments.{key}.ui:widget

string

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

imports.{key}.automations.description

Hide child attributes

imports.{key}.automations.description.{key}

string

Example:

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

imports.{key}.events

object

required

Hide child attributes

imports.{key}.events.emit

string[]

imports.{key}.events.listen

string[]

imports.{key}.events.autocomplete

object[]

Hide child attributes

imports.{key}.events.autocomplete.event

string

required

Example:

"prismeaiMessenger.message"

imports.{key}.events.autocomplete.autocomplete

object

Hide child attributes

imports.{key}.events.autocomplete.autocomplete.{key}

object

Hide child attributes

imports.{key}.events.autocomplete.autocomplete.{key}.from

string

imports.{key}.events.autocomplete.autocomplete.{key}.path

string

imports.{key}.events.autocomplete.autocomplete.{key}.template

string

imports.{key}.blocks

object[]

required

Hide child attributes

imports.{key}.blocks.slug

string

required

imports.{key}.blocks.url

string

imports.{key}.blocks.edit

object

Hide child attributes

imports.{key}.blocks.edit.type

enum<string>

Available options:

string,

number,

object,

array,

boolean,

localized:string,

localized:number,

localized:boolean

imports.{key}.blocks.edit.format

string

imports.{key}.blocks.edit.properties

object

Hide child attributes

imports.{key}.blocks.edit.properties.{key}

object

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

imports.{key}.blocks.edit.title

Hide child attributes

imports.{key}.blocks.edit.title.{key}

string

Example:

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

imports.{key}.blocks.edit.description

Hide child attributes

imports.{key}.blocks.edit.description.{key}

string

Example:

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

imports.{key}.blocks.edit.items

object

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

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

string

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

imports.{key}.blocks.name

Hide child attributes

imports.{key}.blocks.name.{key}

string

Example:

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

imports.{key}.blocks.description

Hide child attributes

imports.{key}.blocks.description.{key}

string

Example:

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

imports.{key}.blocks.arguments

object

Hide child attributes

imports.{key}.blocks.arguments.{key}

object

Hide child attributes

imports.{key}.blocks.arguments.{key}.type

enum<string>

Available options:

string,

number,

object,

array,

boolean,

localized:string,

localized:number,

localized:boolean

imports.{key}.blocks.arguments.{key}.format

string

imports.{key}.blocks.arguments.{key}.properties

object

Hide child attributes

imports.{key}.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.

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

Hide child attributes

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

string

Example:

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

imports.{key}.blocks.arguments.{key}.description

Hide child attributes

imports.{key}.blocks.arguments.{key}.description.{key}

string

Example:

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

imports.{key}.blocks.arguments.{key}.items

object

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

imports.{key}.blocks.arguments.{key}.ui:widget

string

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

imports.{key}.appName

Hide child attributes

imports.{key}.appName.{key}

string

Example:

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

imports.{key}.appVersion

string

Defaults to the latest known app version

imports.{key}.disabled

boolean

If disabled, this appInstance will be ignored during execution

imports.{key}.labels

string[]

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

imports.{key}.updatedAt

string

imports.{key}.createdAt

string

imports.{key}.updatedBy

string

imports.{key}.createdBy

string

imports.{key}.checksum

string

imports.{key}.photo

string

createdAt

string

updatedAt

string

createdBy

string

Introduction

Platform API

Agent Creator API

LLM Gateway API

Governance API

Knowledges API

Collections API

Authorizations

Path Parameters

Query Parameters

Response