Platform API
- GETGet Workspace Labels
- GETGet Workspaces
- POSTCreate Workspace
- GETGet Workspace
- DELDelete Workspace
- PATCHUpdate Workspace
- POSTImport New Workspace
- POSTImport Existing Workspace
- GETList Workspace Versions
- POSTPublish Workspace Version
- DELDelete Workspace Version
- POSTPull Workspace Version
- POSTPull Platform Versions
- POSTPush Platform Versions
- POSTDuplicate Workspace Version
- POSTExport Workspace Version
- GETGet Workspace Status
- POSTSet Write Lock
- DELClear Write Lock
- POSTExport Multiple Workspaces
- POSTCreate Automation
- GETGet Automation
- DELDelete Automation
- PATCHUpdate Automation
- POSTTest Automation
- GETList Pages
- POSTCreate Page
- GETGet Page
- DELDelete Page
- PATCHUpdate Page
- GETGet Workspace Bundle
- GETGet Page By Slug
- GETGet Security
- PUTUpdate Security
- GETGet Roles
- GETSearch Apps
- POSTPublish App
- GETGet App
- DELDelete App
- GETList App Instances
- POSTInstall App Instance
- GETGet App Instance Config
- PATCHUpdate App Instance Config
- GETGet App Instance
- DELUninstall App Instance
- PATCHConfigure App Instance
- GETGet File
- PUTReplace File Content
- DELDelete File
- PATCHUpdate File
- GETList Files
- POSTUpload File
- POSTShare File
Agent Creator API
LLM Gateway API
Governance API
Get Automation
curl --request GET \
--url https://api.studio.prisme.ai/v2/workspaces/{workspaceId}/automations/{automationSlug} \
--header 'Authorization: Bearer <token>'{
"name": {
"fr": "Bonjour",
"en": "Hello"
},
"do": [
{
"emit": {
"event": "prismeaiMessenger.message",
"payload": "<unknown>",
"target": {
"userTopic": "<string>",
"userId": "<string>",
"sessionId": "<string>",
"currentSocket": true
},
"private": true,
"autocomplete": {},
"options": {
"persist": true,
"aggPayload": false,
"async": false
}
}
}
],
"description": {
"fr": "Bonjour",
"en": "Hello"
},
"private": false,
"disabled": true,
"slug": "<string>",
"arguments": {},
"validateArguments": true,
"when": {
"events": [
"prismeaiMessenger.event"
],
"schedules": [
"2021-12-25T00:00",
"* * 1 * *"
],
"endpoint": "Set to true in order to activate HTTP endpoint. Slug will be trigger name by default"
},
"labels": [
"<string>"
],
"events": {
"emit": [
"<string>"
],
"listen": [
"<string>"
],
"autocomplete": [
{
"event": "prismeaiMessenger.message",
"autocomplete": {}
}
]
},
"updatedAt": "<string>",
"createdAt": "<string>",
"updatedBy": "<string>",
"createdBy": "<string>",
"checksum": "<string>",
"output": "{{result}}",
"authorizations": {
"action": "<string>"
}
}Prisme.ai Workspaces
Get Automation
Fetch an automation
GET
/
v2
/
workspaces
/
{workspaceId}
/
automations
/
{automationSlug}
Get Automation
curl --request GET \
--url https://api.studio.prisme.ai/v2/workspaces/{workspaceId}/automations/{automationSlug} \
--header 'Authorization: Bearer <token>'{
"name": {
"fr": "Bonjour",
"en": "Hello"
},
"do": [
{
"emit": {
"event": "prismeaiMessenger.message",
"payload": "<unknown>",
"target": {
"userTopic": "<string>",
"userId": "<string>",
"sessionId": "<string>",
"currentSocket": true
},
"private": true,
"autocomplete": {},
"options": {
"persist": true,
"aggPayload": false,
"async": false
}
}
}
],
"description": {
"fr": "Bonjour",
"en": "Hello"
},
"private": false,
"disabled": true,
"slug": "<string>",
"arguments": {},
"validateArguments": true,
"when": {
"events": [
"prismeaiMessenger.event"
],
"schedules": [
"2021-12-25T00:00",
"* * 1 * *"
],
"endpoint": "Set to true in order to activate HTTP endpoint. Slug will be trigger name by default"
},
"labels": [
"<string>"
],
"events": {
"emit": [
"<string>"
],
"listen": [
"<string>"
],
"autocomplete": [
{
"event": "prismeaiMessenger.message",
"autocomplete": {}
}
]
},
"updatedAt": "<string>",
"createdAt": "<string>",
"updatedBy": "<string>",
"createdBy": "<string>",
"checksum": "<string>",
"output": "{{result}}",
"authorizations": {
"action": "<string>"
}
}Documentation Index
Fetch the complete documentation index at: https://docs.prisme.ai/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
BearerAuthWorkspaceApiKeyAuthBearerAuth & WorkspaceApiKeyAuth
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Response
Success Response
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Example:
"prismeaiMessenger.message"
Hide child attributes
Hide child attributes
Whether to persist this event or not. Defaults to true
Populate advanced aggregation payload for custom mappings & analytics. This is automatically enabled for events mapped in config.events.types.*
If true, the instruction will return control without waiting for the event to be emitted. Defaults to false
Set this to true if you don't want your automation to be accessible outside of your app. Default is false.
Example:
false
Set this to true if you want to turn off this automation.
Example:
true
Unique & human readable id across current workspace's automations
Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Available options:
string, number, object, array, boolean, localized:string, localized:number, localized:boolean Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Available options:
string, number, object, array, boolean, localized:string, localized:number, localized:boolean Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Available options:
string, number, object, array, boolean, localized:string, localized:number, localized:boolean Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Available options:
string, number, object, array, boolean, localized:string, localized:number, localized:boolean Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Available options:
string, number, object, array, boolean, localized:string, localized:number, localized:boolean arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties
object
Hide child attributes
Hide child attributes
arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}
object
Hide child attributes
Hide child attributes
arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.type
string
Available options:
string, number, object, array, boolean, localized:string, localized:number, localized:boolean arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.format
string
arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties
object
Hide child attributes
Hide child attributes
arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}
object
Hide child attributes
Hide child attributes
arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.type
string
Available options:
string, number, object, array, boolean, localized:string, localized:number, localized:boolean arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.format
string
arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties
object
Hide child attributes
Hide child attributes
arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}
object
Hide child attributes
Hide child attributes
arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.type
string
Available options:
string, number, object, array, boolean, localized:string, localized:number, localized:boolean arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.format
string
arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties
object
Hide child attributes
Hide child attributes
arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}
object
Hide child attributes
Hide child attributes
arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.type
string
Available options:
string, number, object, array, boolean, localized:string, localized:number, localized:boolean arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.format
string
arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties
object
Hide child attributes
Hide child attributes
arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}
object
Hide child attributes
Hide child attributes
arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.type
string
Available options:
string, number, object, array, boolean, localized:string, localized:number, localized:boolean arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.format
string
arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties
object
Hide child attributes
Hide child attributes
arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}
object
Hide child attributes
Hide child attributes
arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.type
string
Available options:
string, number, object, array, boolean, localized:string, localized:number, localized:boolean arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.format
string
arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties
object
Hide child attributes
Hide child attributes
arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}
object
Hide child attributes
Hide child attributes
arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.type
string
Available options:
string, number, object, array, boolean, localized:string, localized:number, localized:boolean arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.format
string
arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties
object
Hide child attributes
Hide child attributes
arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}
object
Hide child attributes
Hide child attributes
arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.type
string
Available options:
string, number, object, array, boolean, localized:string, localized:number, localized:boolean arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.format
string
arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties
object
Hide child attributes
Hide child attributes
arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}
object
Hide child attributes
Hide child attributes
arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.type
string
Available options:
string, number, object, array, boolean, localized:string, localized:number, localized:boolean arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.format
string
arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties
object
Hide child attributes
Hide child attributes
arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}
object
Hide child attributes
Hide child attributes
arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.type
string
Available options:
string, number, object, array, boolean, localized:string, localized:number, localized:boolean arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.format
string
arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties
object
Hide child attributes
Hide child attributes
arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}
object
Hide child attributes
Hide child attributes
arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.type
string
Available options:
string, number, object, array, boolean, localized:string, localized:number, localized:boolean arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.format
string
arguments.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties.{key}.properties
object
Hide child attributes
Hide child attributes