AI Builder Endpoints
- GETGet v2workspaces
- POSTPost v2workspaces
- GETGet v2workspaces
- DELDelete v2workspaces
- PATCHPatch v2workspaces
- POSTPost v2workspacesimport
- POSTPost v2workspaces import
- GETGet v2workspaces versions
- POSTPost v2workspaces versions
- DELDelete v2workspaces versions
- POSTPost v2workspaces versions pull
- POSTPost v2workspaces versions duplicate
- POSTPost v2workspaces versions export
- GETGet v2workspaces status
- POSTPost v2workspacesexport
- POSTPost v2workspaces automations
- GETGet v2workspaces automations
- DELDelete v2workspaces automations
- PATCHPatch v2workspaces automations
- POSTPost v2workspaces test
- GETGet v2workspaces pages
- POSTPost v2workspaces pages
- GETGet v2workspaces pages
- DELDelete v2workspaces pages
- PATCHPatch v2workspaces pages
- GETGet v2pages
- GETGet v2workspaces security
- PUTPut v2workspaces security
- GETGet v2workspaces securityroles
- GETGet v2apps
- POSTPost v2apps
- GETGet v2apps
- DELDelete v2apps
- GETGet v2workspaces apps
- POSTPost v2workspaces apps
- GETGet v2workspaces apps config
- PATCHPatch v2workspaces apps config
- GETGet v2workspaces apps
- DELDelete v2workspaces apps
- PATCHPatch v2workspaces apps
- GETGet v2workspaces files
- DELDelete v2workspaces files
- PATCHPatch v2workspaces files
- GETGet v2workspaces files
- POSTPost v2workspaces files
- POSTPost v2workspaces files share
- GET
curl --request GET \
--url https://api.eda.prisme.ai/v2/workspaces/{workspaceId} \
--header 'Authorization: Bearer <token>'{
"name": "<string>",
"description": {
"fr": "Bonjour",
"en": "Hello"
},
"photo": "<string>",
"config": {
"schema": {},
"block": "<string>",
"value": "<unknown>"
},
"blocks": {},
"slug": "<string>",
"id": "<string>",
"labels": [
"<string>"
],
"customDomains": [
"<string>"
],
"registerWorkspace": true,
"repositories": {},
"secrets": {
"schema": {}
},
"events": {
"mapping": {},
"types": {}
},
"automations": {},
"pages": {},
"imports": {},
"createdAt": "<string>",
"updatedAt": "<string>",
"createdBy": "<string>"
}Get v2workspaces
Fetch a workspace
curl --request GET \
--url https://api.eda.prisme.ai/v2/workspaces/{workspaceId} \
--header 'Authorization: Bearer <token>'{
"name": "<string>",
"description": {
"fr": "Bonjour",
"en": "Hello"
},
"photo": "<string>",
"config": {
"schema": {},
"block": "<string>",
"value": "<unknown>"
},
"blocks": {},
"slug": "<string>",
"id": "<string>",
"labels": [
"<string>"
],
"customDomains": [
"<string>"
],
"registerWorkspace": true,
"repositories": {},
"secrets": {
"schema": {}
},
"events": {
"mapping": {},
"types": {}
},
"automations": {},
"pages": {},
"imports": {},
"createdAt": "<string>",
"updatedAt": "<string>",
"createdBy": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Workspace id
Query Parameters
Optional version
Response
Success Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
string, number, object, array, boolean, localized:string, localized:number, localized:boolean Show child attributes
Show child attributes
Block
Show child attributes
Show child attributes
A block can be a javascript bundled file. Host it on the internet and put its url here.
Show child attributes
Show child attributes
string, number, object, array, boolean, localized:string, localized:number, localized:boolean A block can extends another one by giving its name here
default config applied to the Block. Usefull for extended Blocks.
Css applied to Block
Show child attributes
Show child attributes
string, number, object, array, boolean, localized:string, localized:number, localized:boolean If true, make this workspace metadata available to all workspaces with this variable : {{global.workspacesRegistry[WORKSPACE_SLUG]}}
Remote versioning repositories
Show child attributes
Show child attributes
Show child attributes
Show child attributes
- Option 1
- Option 2
Show child attributes
Show child attributes
git, archive read-write, read-only Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
string, number, object, array, boolean, localized:string, localized:number, localized:boolean Show child attributes
Show child attributes
Custom mapping which will be directly sent to underlying database (Elasticsearch/Opensearch)
Custom configuration per event type
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
string, number, object, array, boolean, localized:string, localized:number, localized:boolean Show child attributes
Show child attributes
Show child attributes
Show child attributes
Set this to true if you don't want your automation to be accessible outside of your app. Default is false.
false
Set this to true if you want to turn off this automation.
true
Unique & human readable id across current workspace's automations
Show child attributes
Show child attributes
Show child attributes
Show child attributes
string, number, object, array, boolean, localized:string, localized:number, localized:boolean - Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"prismeaiMessenger.message"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Page
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"prismeaiMessenger.message"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
auto, light, dark Show child attributes
Show child attributes
Show child attributes
Show child attributes
App unique id
Unique & human readable id across current workspace's appInstances, which will be used to call this app automations
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
string, number, object, array, boolean, localized:string, localized:number, localized:boolean Show child attributes
Show child attributes
Show child attributes
Show child attributes
"prismeaiMessenger.message"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
string, number, object, array, boolean, localized:string, localized:number, localized:boolean Show child attributes
Show child attributes
Show child attributes
Show child attributes
string, number, object, array, boolean, localized:string, localized:number, localized:boolean Defaults to the latest known app version
If disabled, this appInstance will be ignored during execution
Was this page helpful?