Update Workspace Config

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

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

fetch('https://api.studio.prisme.ai/v2/workspaces/{workspaceId}/config', 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}/config"

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

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

print(response.text)

{
  "schema": {},
  "block": "<string>",
  "value": "<unknown>"
}

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

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

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

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

PATCH

workspaces

{workspaceId}

config

Update Workspace Config

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

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

fetch('https://api.studio.prisme.ai/v2/workspaces/{workspaceId}/config', 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}/config"

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

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

print(response.text)

{
  "schema": {},
  "block": "<string>",
  "value": "<unknown>"
}

{
  "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

schema

object

Hide child attributes

schema.{key}

object

Hide child attributes

schema.{key}.type

enum<string>

Available options:

string,

number,

object,

array,

boolean,

localized:string,

localized:number,

localized:boolean

schema.{key}.format

string

schema.{key}.properties

object

Hide child attributes

schema.{key}.properties.{key}

object

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

schema.{key}.title

Hide child attributes

schema.{key}.title.{key}

string

Example:

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

schema.{key}.description

Hide child attributes

schema.{key}.description.{key}

string

Example:

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

schema.{key}.items

object

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

schema.{key}.ui:widget

string

schema.{key}.ui:options

object

Example:

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

block

string

value

any

Response

Success Response

schema

object

Hide child attributes

schema.{key}

object

Hide child attributes

schema.{key}.type

enum<string>

Available options:

string,

number,

object,

array,

boolean,

localized:string,

localized:number,

localized:boolean

schema.{key}.format

string

schema.{key}.properties

object

Hide child attributes

schema.{key}.properties.{key}

object

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

schema.{key}.title

Hide child attributes

schema.{key}.title.{key}

string

Example:

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

schema.{key}.description

Hide child attributes

schema.{key}.description.{key}

string

Example:

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

schema.{key}.items

object

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

schema.{key}.ui:widget

string

schema.{key}.ui:options

object

Example:

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

block

string

value

any

Get Workspace Config Import New Workspace

⌘I

Introduction

Platform API

Agent Creator API

LLM Gateway API

Governance API

Knowledges API

Update Workspace Config

Authorizations

Path Parameters

Body

Response