Post v2workspacesimport

POST

workspaces

import

curl --request POST \
  --url https://api.eda.prisme.ai/v2/workspaces/import \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-Prismeai-API-Key: <api-key>'

{
  "processing": true,
  "message": "<string>"
}

Authorizations

X-Prismeai-API-Key

string

header

required

connect.sid

string

required

Body

multipart/form-data

Response

200

application/json

Success Response

processing

boolean

message

string

processing

boolean

message

string

imported

string[]

required

createdWorkspaceIds

string[]

updatedWorkspaceIds

string[]

errors

object[]

workspace

object

workspace.name

string

required

workspace.description

Example:

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

workspace.photo

string

workspace.config

object

workspace.config.schema

object

workspace.config.schema.{key}

object

workspace.config.schema.{key}.type

enum<string>

Available options:

string,

number,

object,

array,

boolean,

localized:string,

localized:number,

localized:boolean

workspace.config.schema.{key}.format

string

workspace.config.schema.{key}.properties

object

workspace.config.schema.{key}.title

Example:

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

workspace.config.schema.{key}.description

Example:

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

items

object

workspace.config.schema.{key}.ui:widget

string

workspace.config.schema.{key}.ui:options

object

workspace.config.schema.{key}.secret

boolean

workspace.config.schema.{key}.event

boolean

workspace.config.block

string

workspace.config.value

any

workspace.blocks

object

workspace.blocks.{key}

object

Block

workspace.blocks.{key}.description

Example:

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

workspace.blocks.{key}.name

Example:

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

workspace.blocks.{key}.photo

string

workspace.blocks.{key}.url

string

deprecated

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

workspace.blocks.{key}.edit

object

workspace.blocks.{key}.edit.type

enum<string>

Available options:

string,

number,

object,

array,

boolean,

localized:string,

localized:number,

localized:boolean

workspace.blocks.{key}.edit.format

string

workspace.blocks.{key}.edit.properties

object

workspace.blocks.{key}.edit.title

Example:

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

workspace.blocks.{key}.edit.description

Example:

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

items

object

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

string

workspace.blocks.{key}.edit.ui:options

object

workspace.blocks.{key}.edit.secret

boolean

workspace.blocks.{key}.edit.event

boolean

workspace.blocks.{key}.block

string

deprecated

A block can extends another one by giving its name here

workspace.blocks.{key}.config

any

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

workspace.blocks.{key}.automation

workspace.blocks.{key}.blocks

object[]

workspace.blocks.{key}.css

string

Css applied to Block

workspace.blocks.{key}.schema

object

workspace.blocks.{key}.schema.type

enum<string>

Available options:

string,

number,

object,

array,

boolean,

localized:string,

localized:number,

localized:boolean

workspace.blocks.{key}.schema.format

string

workspace.blocks.{key}.schema.properties

object

workspace.blocks.{key}.schema.title

Example:

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

workspace.blocks.{key}.schema.description

Example:

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

items

object

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

string

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

object

workspace.blocks.{key}.schema.secret

boolean

workspace.blocks.{key}.schema.event

boolean

workspace.slug

string

workspace.id

string

workspace.labels

string[]

workspace.customDomains

string[]

workspace.registerWorkspace

boolean

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

workspace.repositories

object

Remote versioning repositories

workspace.secrets

object

workspace.secrets.schema

object

workspace.secrets.schema.{key}

object

workspace.secrets.schema.{key}.type

enum<string>

Available options:

string,

number,

object,

array,

boolean,

localized:string,

localized:number,

localized:boolean

workspace.secrets.schema.{key}.format

string

workspace.secrets.schema.{key}.properties

object

workspace.secrets.schema.{key}.title

Example:

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

workspace.secrets.schema.{key}.description

Example:

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

items

object

workspace.secrets.schema.{key}.ui:widget

string

workspace.secrets.schema.{key}.ui:options

object

workspace.secrets.schema.{key}.secret

boolean

workspace.secrets.schema.{key}.event

boolean

workspace.events

object

workspace.automations

object

workspace.automations.{key}

object

workspace.automations.{key}.name

required

Example:

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

workspace.automations.{key}.description

Example:

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

workspace.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

workspace.automations.{key}.disabled

boolean

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

Example:

true

workspace.automations.{key}.slug

string

Unique & human readable id across current workspace's automations

workspace.automations.{key}.arguments

object

workspace.automations.{key}.validateArguments

boolean

workspace.automations.{key}.when

object

workspace.automations.{key}.when.events

string[]

required

Example:

["prismeaiMessenger.event"]

workspace.automations.{key}.when.schedules

string[]

Example:

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

workspace.automations.{key}.when.endpoint

Example:

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

workspace.automations.{key}.labels

string[]

workspace.automations.{key}.events

object

workspace.automations.{key}.updatedAt

string

workspace.automations.{key}.createdAt

string

workspace.automations.{key}.updatedBy

string

workspace.automations.{key}.createdBy

string

workspace.automations.{key}.checksum

string

workspace.pages

object

workspace.pages.{key}

object

Page

workspace.pages.{key}.name

required

Example:

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

workspace.pages.{key}.description

Example:

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

workspace.pages.{key}.workspaceId

string

workspace.pages.{key}.workspaceSlug

string

workspace.pages.{key}.id

string

workspace.pages.{key}.slug

string

workspace.pages.{key}.blocks

object[]

workspace.pages.{key}.labels

string[]

workspace.pages.{key}.events

object

workspace.pages.{key}.createdBy

string

workspace.pages.{key}.updatedBy

string

workspace.pages.{key}.createdAt

string

workspace.pages.{key}.updatedAt

string

workspace.pages.{key}.permissions

object

workspace.pages.{key}.customDomains

string[]

workspace.pages.{key}.colorScheme

enum<string>

Available options:

auto,

light,

dark

workspace.pages.{key}.checksum

string

workspace.imports

object

workspace.imports.{key}

object

workspace.imports.{key}.appSlug

string

required

App unique id

workspace.imports.{key}.slug

string

required

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

workspace.imports.{key}.automations

object[]

required

workspace.imports.{key}.automations.slug

string

required

workspace.imports.{key}.automations.name

required

Example:

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

workspace.imports.{key}.automations.arguments

object

required

workspace.imports.{key}.automations.description

Example:

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

workspace.imports.{key}.events

object

required

workspace.imports.{key}.blocks

object[]

required

workspace.imports.{key}.blocks.slug

string

required

workspace.imports.{key}.blocks.url

string

workspace.imports.{key}.blocks.edit

object

workspace.imports.{key}.blocks.name

Example:

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

workspace.imports.{key}.blocks.description

Example:

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

workspace.imports.{key}.blocks.arguments

object

workspace.imports.{key}.appName

Example:

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

workspace.imports.{key}.appVersion

string

Defaults to the latest known app version

workspace.imports.{key}.disabled

boolean

If disabled, this appInstance will be ignored during execution

workspace.imports.{key}.labels

string[]

workspace.imports.{key}.updatedAt

string

workspace.imports.{key}.createdAt

string

workspace.imports.{key}.updatedBy

string

workspace.imports.{key}.createdBy

string

workspace.imports.{key}.checksum

string

workspace.imports.{key}.photo

string

workspace.createdAt

string

workspace.updatedAt

string

workspace.createdBy

string

publishedApps

object[]

publishedApps.workspaceId

string

required

publishedApps.slug

string

required

publishedApps.versions

publishedApps.name

string

publishedApps.description

Example:

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

publishedApps.documentation

object

publishedApps.config

object

publishedApps.config.schema

object

publishedApps.config.schema.{key}

object

publishedApps.config.schema.{key}.type

enum<string>

Available options:

string,

number,

object,

array,

boolean,

localized:string,

localized:number,

localized:boolean

publishedApps.config.schema.{key}.format

string

publishedApps.config.schema.{key}.properties

object

publishedApps.config.schema.{key}.title

Example:

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

publishedApps.config.schema.{key}.description

Example:

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

items

object

publishedApps.config.schema.{key}.ui:widget

string

publishedApps.config.schema.{key}.ui:options

object

publishedApps.config.schema.{key}.secret

boolean

publishedApps.config.schema.{key}.event

boolean

publishedApps.config.block

string

publishedApps.config.value

any

publishedApps.photo

string

publishedApps.labels

string[]

publishedApps.updatedAt

string

publishedApps.createdAt

string

publishedApps.updatedBy

string

publishedApps.createdBy

string

deleted

string[]

Was this page helpful?

Raise issue

Patch v2workspaces Post v2workspaces import

curl --request POST \
  --url https://api.eda.prisme.ai/v2/workspaces/import \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-Prismeai-API-Key: <api-key>'

{
  "processing": true,
  "message": "<string>"
}

Introduction

AI Builder Endpoints

Post v2workspacesimport

Authorizations

Body

Response