Publish App

Publish a workspace as a new app version

POST /v2/apps

Publish App

cURL

curl --request POST \
  --url https://api.studio.prisme.ai/v2/apps \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspaceId": "<string>"
}
'

200

{
  "workspaceId": "<string>",
  "slug": "<string>",
  "versions": [
    "<string>"
  ],
  "name": "<string>",
  "description": {
    "fr": "Bonjour",
    "en": "Hello"
  },
  "documentation": {
    "workspaceSlug": "<string>",
    "slug": "<string>"
  },
  "config": {
    "schema": {},
    "block": "<string>",
    "value": "<unknown>"
  },
  "photo": "<string>",
  "labels": [
    "<string>"
  ],
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "updatedBy": "<string>",
  "createdBy": "<string>"
}

Authorizations

BearerAuthOrgApiKeyAuthBearerAuth & OrgApiKeyAuth

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

workspaceId · string · required

workspaceVersion · string

An optional workspace version. If empty, will publish latest workspace version

slug · string

App slug : Required on first publish

description · object string

Hide child attributes

description. {key} · string

Example:

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

name · string

An optional version name

Response

200

application/json

Success Response

workspaceId · string · required

slug · string · required

versions · string[] object[]

name · string

description · object string

Hide child attributes

description. {key} · string

Example:

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

documentation · object

Hide child attributes

documentation. workspaceSlug · string · required

documentation. slug · string · required

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, 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 · object string

Hide child attributes

config.schema.{key}.title. {key} · string

Example:

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

config.schema.{key}. description · object string

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

Example:

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

config. block · string

config. value · any

photo · string

labels · string[]

Pattern: ^[0-9A-Za-z._:-]{2,60}$

updatedAt · string

createdAt · string

updatedBy · string

createdBy · string