Get Automation

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

automationSlug

string

required

Automation slug

Response

Success Response

name

required

Hide child attributes

name.{key}

string

Example:

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

object[]

required

Hide child attributes

do.emit

object

required

Hide child attributes

do.emit.event

string

required

Example:

"prismeaiMessenger.message"

do.emit.payload

any

do.emit.target

object

Hide child attributes

do.emit.target.userTopic

string

do.emit.target.userId

string

do.emit.target.sessionId

string

do.emit.target.currentSocket

boolean

default:true

If emitted in response to an active socket (i.e source.socketId is set), this event is only visible to this same socket. Defaults to true

do.emit.private

boolean

do.emit.autocomplete

object

Hide child attributes

do.emit.autocomplete.{key}

object

Hide child attributes

do.emit.autocomplete.{key}.from

string

do.emit.autocomplete.{key}.path

string

do.emit.autocomplete.{key}.template

string

do.emit.options

object

Hide child attributes

do.emit.options.persist

boolean

default:true

Whether to persist this event or not. Defaults to true

do.emit.options.aggPayload

boolean

default:false

Populate advanced aggregation payload for custom mappings & analytics. This is automatically enabled for events mapped in config.events.types.*

do.emit.options.async

boolean

default:false

If true, the instruction will return control without waiting for the event to be emitted. Defaults to false

Example:

[
  {
    "set": { "name": "user.welcomed", "value": true }
  },
  {
    "emit": {
      "event": "user.welcomed",
      "payload": { "userId": "{{userId}}" }
    }
  }
]

description

Hide child attributes

description.{key}

string

Example:

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

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

disabled

boolean

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

Example:

true

slug

string

Unique & human readable id across current workspace's automations

arguments

object

Hide child attributes

arguments.{key}

object

Hide child attributes

arguments.{key}.type

enum<string>

Available options:

string,

number,

integer,

object,

array,

boolean,

localized:string,

localized:number,

localized:boolean

arguments.{key}.format

string

arguments.{key}.properties

object

Hide child attributes

arguments.{key}.properties.{key}

object

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

arguments.{key}.title

Hide child attributes

arguments.{key}.title.{key}

string

Example:

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

arguments.{key}.description

Hide child attributes

arguments.{key}.description.{key}

string

Example:

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

arguments.{key}.items

object

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

arguments.{key}.ui:widget

string

arguments.{key}.ui:options

object

arguments.{key}.secret

boolean

arguments.{key}.redact

boolean

Path-redact this field from runtime execution events (runtime.automations.executed), whatever its size. Redact itself never tracks the value: each automation the value transits through must re-declare redact on its own schema. It does not disable a secret declaration on the same or a nested field — secret takes precedence, so a field marked both is value-tracked AND path-redacted. Only reachable through nested properties: a marker inside items, additionalProperties or oneOf-style keywords is ignored (redact the parent field itself).

arguments.{key}.required

string[]

arguments.{key}.event

boolean

Example:

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

schemas

object[]

Conditional input/output schemas. Takes precedence over arguments for validation when present; arguments-declared secret & redact markers remain enforced on every branch, while branch-declared secrets only apply to calls matching their branch.

Hide child attributes

schemas.conditions

object

Every entry must equal the corresponding payload variable for the branch to match. Keys are dot-paths resolved from the payload root (method, body.kind…); method is matched case-insensitively. Values are compared as strings after scalar coercion (2 matches "2" — query parameters always arrive as strings); an object or array value never matches.

schemas.payload

object

Hide child attributes

schemas.payload.type

enum<string>

Available options:

string,

number,

integer,

object,

array,

boolean,

localized:string,

localized:number,

localized:boolean

schemas.payload.format

string

schemas.payload.properties

object

Hide child attributes

schemas.payload.properties.{key}

object

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

schemas.payload.title

Hide child attributes

schemas.payload.title.{key}

string

Example:

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

schemas.payload.description

Hide child attributes

schemas.payload.description.{key}

string

Example:

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

schemas.payload.items

object

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

schemas.payload.ui:widget

string

schemas.payload.ui:options

object

schemas.payload.secret

boolean

schemas.payload.redact

boolean

schemas.payload.required

string[]

schemas.payload.event

boolean

Example:

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

schemas.output

object

Hide child attributes

schemas.output.type

enum<string>

Available options:

string,

number,

integer,

object,

array,

boolean,

localized:string,

localized:number,

localized:boolean

schemas.output.format

string

schemas.output.properties

object

Hide child attributes

schemas.output.properties.{key}

object

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

schemas.output.title

Hide child attributes

schemas.output.title.{key}

string

Example:

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

schemas.output.description

Hide child attributes

schemas.output.description.{key}

string

Example:

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

schemas.output.items

object

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

schemas.output.ui:widget

string

schemas.output.ui:options

object

schemas.output.secret

boolean

schemas.output.redact

boolean

schemas.output.required

string[]

schemas.output.event

boolean

Example:

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

validateArguments

boolean

when

object

Option 1
Option 2
Option 3
Option 4

Hide child attributes

when.events

string[]

required

Example:

["prismeaiMessenger.event"]

when.schedules

string[]

Example:

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

when.endpoint

Example:

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

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

updatedAt

string

createdAt

string

updatedBy

string

createdBy

string

checksum

string

output

any

Automation result expression. Might be a variable reference, an object/array with variables inside ...

Example:

"{{result}}"

authorizations

object

Hide child attributes

authorizations.action

string

Introduction

Platform API

Agent Creator API

LLM Gateway API

Governance API

Knowledges API

Collections API

Authorizations

Path Parameters

Response