Update Workspace

curl --request PATCH \
  --url https://api.studio.prisme.ai/v2/workspaces/{workspaceId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "config": {
    "schema": {},
    "block": "<string>",
    "value": "<unknown>"
  },
  "slug": "<string>"
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    config: {schema: {}, block: '<string>', value: '<unknown>'},
    slug: '<string>'
  })
};

fetch('https://api.studio.prisme.ai/v2/workspaces/{workspaceId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.studio.prisme.ai/v2/workspaces/{workspaceId}"

payload = {
    "name": "<string>",
    "config": {
        "schema": {},
        "block": "<string>",
        "value": "<unknown>"
    },
    "slug": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "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": {},
  "platformRepositories": {},
  "secrets": {
    "schema": {}
  },
  "events": {
    "mapping": {},
    "types": {}
  },
  "writeLock": {
    "lockedAt": "<string>",
    "lockedBy": "<string>",
    "reason": "<string>"
  },
  "generation": 123
}

{
  "error": "BadParameters",
  "message": "<string>",
  "details": "<unknown>"
}

{
  "error": "AuthenticationError",
  "message": "Unauthenticated"
}

{
  "error": "ForbiddenError",
  "message": "Forbidden"
}

{
  "error": "ObjectNotFound",
  "message": "<string>"
}

PATCH

workspaces

{workspaceId}

Update Workspace

curl --request PATCH \
  --url https://api.studio.prisme.ai/v2/workspaces/{workspaceId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "config": {
    "schema": {},
    "block": "<string>",
    "value": "<unknown>"
  },
  "slug": "<string>"
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    config: {schema: {}, block: '<string>', value: '<unknown>'},
    slug: '<string>'
  })
};

fetch('https://api.studio.prisme.ai/v2/workspaces/{workspaceId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.studio.prisme.ai/v2/workspaces/{workspaceId}"

payload = {
    "name": "<string>",
    "config": {
        "schema": {},
        "block": "<string>",
        "value": "<unknown>"
    },
    "slug": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "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": {},
  "platformRepositories": {},
  "secrets": {
    "schema": {}
  },
  "events": {
    "mapping": {},
    "types": {}
  },
  "writeLock": {
    "lockedAt": "<string>",
    "lockedBy": "<string>",
    "reason": "<string>"
  },
  "generation": 123
}

{
  "error": "BadParameters",
  "message": "<string>",
  "details": "<unknown>"
}

{
  "error": "AuthenticationError",
  "message": "Unauthenticated"
}

{
  "error": "ForbiddenError",
  "message": "Forbidden"
}

{
  "error": "ObjectNotFound",
  "message": "<string>"
}

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

Body

application/json

name

string

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,

integer,

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

config.schema.{key}.secret

boolean

config.schema.{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).

config.schema.{key}.required

string[]

config.schema.{key}.event

boolean

Example:

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

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,

integer,

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

blocks.{key}.edit.secret

boolean

blocks.{key}.edit.redact

boolean

blocks.{key}.edit.required

string[]

blocks.{key}.edit.event

boolean

Example:

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

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,

integer,

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

blocks.{key}.schema.secret

boolean

blocks.{key}.schema.redact

boolean

blocks.{key}.schema.required

string[]

blocks.{key}.schema.event

boolean

Example:

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

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,

integer,

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

secrets.schema.{key}.secret

boolean

secrets.schema.{key}.redact

boolean

secrets.schema.{key}.required

string[]

secrets.schema.{key}.event

boolean

Example:

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

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,

integer,

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

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

boolean

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

boolean

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

string[]

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

boolean

Example:

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

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)

generation

integer

Monotonic counter incremented on every workspace modification. Used by the runtime to detect a stale runtime.yml (e.g. after a crash during import) and trigger a rebuild.

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,

integer,

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

config.schema.{key}.secret

boolean

config.schema.{key}.redact

boolean

config.schema.{key}.required

string[]

config.schema.{key}.event

boolean

Example:

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

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,

integer,

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

blocks.{key}.edit.secret

boolean

blocks.{key}.edit.redact

boolean

blocks.{key}.edit.required

string[]

blocks.{key}.edit.event

boolean

Example:

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

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,

integer,

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

blocks.{key}.schema.secret

boolean

blocks.{key}.schema.redact

boolean

blocks.{key}.schema.required

string[]

blocks.{key}.schema.event

boolean

Example:

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

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,

integer,

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

secrets.schema.{key}.secret

boolean

secrets.schema.{key}.redact

boolean

secrets.schema.{key}.required

string[]

secrets.schema.{key}.event

boolean

Example:

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

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,

integer,

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

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

boolean

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

boolean

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

string[]

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

boolean

Example:

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

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)

generation

integer

Monotonic counter incremented on every workspace modification. Used by the runtime to detect a stale runtime.yml (e.g. after a crash during import) and trigger a rebuild.

Introduction

Platform API

Agent Creator API

LLM Gateway API

Governance API

Knowledges API

Collections API

Update Workspace

Authorizations

Path Parameters

Body

Response