Skip to content

Cmd palette

16 methods on the Cmd palette resource.

16 methods · 0 available to app tokens36 pages in SDK Reference

OpenAI Open in ChatGPTClaude Open in ClaudeGitHub Invertocat
import { Compozy } from "@compozy/client";

16 of 16

admitCmdPaletteViewSessionEvent

Send one programmable view event

compozy.cmdPalette.admitCmdPaletteViewSessionEvent({ path, headers, body }) → Promise<CmdPaletteViewSessionAccepted>

Options

sessionstringpathrequired
Opaque view session id
X-Compozy-Client-Tokenstringheaderrequired
Attached client identity token

Request bodyCmdPaletteViewSessionEventRequest

POST /api/cmd-palette/view-sessions/{session}/eventsapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.cmdPalette.admitCmdPaletteViewSessionEvent({ path: { "session": "session" }, headers: { "X-Compozy-Client-Token": "X-Compozy-Client-Token" }, body: { /* request fields */ } });

closeCmdPaletteViewSession

Close one programmable command palette view

compozy.cmdPalette.closeCmdPaletteViewSession({ path, headers }) → Promise<CmdPaletteViewSessionClosed>

Options

sessionstringpathrequired
Opaque view session id
X-Compozy-Client-Tokenstringheaderrequired
Attached client identity token

DELETE /api/cmd-palette/view-sessions/{session}app tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.cmdPalette.closeCmdPaletteViewSession({ path: { "session": "session" }, headers: { "X-Compozy-Client-Token": "X-Compozy-Client-Token" } });

getCmdPalettePersonalization

Get command palette personalization summary

compozy.cmdPalette.getCmdPalettePersonalization({ query }) → Promise<CmdPalettePersonalizationResponse>

Options

workspacestringqueryrequired
Workspace id, name, or path
profilestringquery
Read one profile's rows by name
all_profilesbooleanquery
Read the owner-labeled all-profiles aggregate

GET /api/cmd-palette/personalizationapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.cmdPalette.getCmdPalettePersonalization({ query: { "workspace": "workspace" } });

getCmdPaletteRankSignals

Get command palette rank signals

compozy.cmdPalette.getCmdPaletteRankSignals({ query }) → Promise<CmdPaletteRankSignalsResponse>

Options

workspacestringqueryrequired
Workspace id, name, or path
profilestringquery
Read one profile's rows by name
all_profilesbooleanquery
Read the owner-labeled all-profiles aggregate

GET /api/cmd-palette/rank-signalsapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.cmdPalette.getCmdPaletteRankSignals({ query: { "workspace": "workspace" } });

getCmdPaletteView

Get one declarative command palette view

compozy.cmdPalette.getCmdPaletteView({ path, query }) → Promise<CmdPaletteViewEnvelope>

Options

idstringpathrequired
Canonical view id
workspacestringqueryrequired
Workspace id, name, or path
profilestringquery
Read one profile's rows by name
all_profilesbooleanquery
Read the owner-labeled all-profiles aggregate

GET /api/cmd-palette/views/{id}app tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.cmdPalette.getCmdPaletteView({ path: { "id": "id" }, query: { "workspace": "workspace" } });

invokeCmdPaletteCommand

Invoke one command palette command

compozy.cmdPalette.invokeCmdPaletteCommand({ path, query, headers, body }) → Promise<InvokeCmdPaletteCommandResponse>

Options

idstringpathrequired
Canonical command id
X-Compozy-Client-Tokenstringheaderrequired
Attached client identity token
profilestringquery
Act as this profile by name

Request bodyCmdPaletteInvokeRequest

POST /api/cmd-palette/commands/{id}/invokeapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.cmdPalette.invokeCmdPaletteCommand({ path: { "id": "id" }, headers: { "X-Compozy-Client-Token": "X-Compozy-Client-Token" }, body: { /* request fields */ } });

listCmdPaletteClients

List attached command palette clients

compozy.cmdPalette.listCmdPaletteClients({ query }) → Promise<Array<CmdPaletteClient>>

Options

workspacestringqueryrequired
Workspace id, name, or path
profilestringquery
Read one profile's rows by name
all_profilesbooleanquery
Read the owner-labeled all-profiles aggregate

GET /api/cmd-palette/clientsapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.cmdPalette.listCmdPaletteClients({ query: { "workspace": "workspace" } });

listCmdPaletteCommands

List command palette commands

compozy.cmdPalette.listCmdPaletteCommands({ query }) → Promise<CmdPaletteCommandsResponse>

Options

workspacestringqueryrequired
Workspace id, name, or path
clientstringquery
Attached client whose context resolves availability
profilestringquery
Read one profile's rows by name
all_profilesbooleanquery
Read the owner-labeled all-profiles aggregate

GET /api/cmd-palette/commandsapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.cmdPalette.listCmdPaletteCommands({ query: { "workspace": "workspace" } });

openCmdPaletteViewSession

Open one programmable command palette view

compozy.cmdPalette.openCmdPaletteViewSession({ path, query, headers, body }) → Promise<CmdPaletteViewSessionOpenResponse>

Options

idstringpathrequired
Canonical view id
X-Compozy-Client-Tokenstringheaderrequired
Attached client identity token
profilestringquery
Act as this profile by name

Request bodyCmdPaletteViewSessionOpenRequest

POST /api/cmd-palette/views/{id}/openapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.cmdPalette.openCmdPaletteViewSession({ path: { "id": "id" }, headers: { "X-Compozy-Client-Token": "X-Compozy-Client-Token" }, body: { /* request fields */ } });

pinCmdPaletteCommand

Pin one command palette command

compozy.cmdPalette.pinCmdPaletteCommand({ path, query }) → Promise<CmdPalettePinResponse>

Options

idstringpathrequired
Canonical command id
workspacestringqueryrequired
Workspace id, name, or path
profilestringquery
Act as this profile by name

PUT /api/cmd-palette/pins/{id}app tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.cmdPalette.pinCmdPaletteCommand({ path: { "id": "id" }, query: { "workspace": "workspace" } });
Show all 16 methods

recordCmdPaletteUsage

Record command palette usage

compozy.cmdPalette.recordCmdPaletteUsage({ query, body }) → Promise<void>

Options

profilestringquery
Read one profile's rows by name
all_profilesbooleanquery
Read the owner-labeled all-profiles aggregate

Request bodyCmdPaletteUsageRequest

POST /api/cmd-palette/usageapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.cmdPalette.recordCmdPaletteUsage({ body: { /* request fields */ } });

resetCmdPalettePersonalization

Reset command palette personalization

compozy.cmdPalette.resetCmdPalettePersonalization({ query }) → Promise<CmdPalettePersonalizationResetResponse>

Options

workspacestringqueryrequired
Workspace id, name, or path
profilestringquery
Act as this profile by name

DELETE /api/cmd-palette/personalizationapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.cmdPalette.resetCmdPalettePersonalization({ query: { "workspace": "workspace" } });

streamCmdPalette

Stream command palette catalog invalidations

compozy.events("streamCmdPalette", { query }) → AsyncIterable<StreamEvent<SseFrame<"streamCmdPalette">>>

Options

workspacestringqueryrequired
Workspace id, name, or path
profilestringquery
Read one profile's rows by name
all_profilesbooleanquery
Read the owner-labeled all-profiles aggregate

GET /api/cmd-palette/streamapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();for await (const frame of compozy.events("streamCmdPalette", { query: { "workspace": "workspace" } })) {  console.log(frame);}

streamCmdPaletteView

Stream declarative command palette view patches

compozy.events("streamCmdPaletteView", { path, query }) → AsyncIterable<StreamEvent<SseFrame<"streamCmdPaletteView">>>

Options

idstringpathrequired
Canonical view id
workspacestringqueryrequired
Workspace id, name, or path
afterstringquery
Last applied patch sequence
stream_epochstringquery
Stream epoch required when after is greater than zero
profilestringquery
Read one profile's rows by name
all_profilesbooleanquery
Read the owner-labeled all-profiles aggregate

GET /api/cmd-palette/views/{id}/streamapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();for await (const frame of compozy.events("streamCmdPaletteView", { path: { "id": "id" }, query: { "workspace": "workspace" } })) {  console.log(frame);}

streamCmdPaletteViewSession

Stream one programmable command palette view

compozy.events("streamCmdPaletteViewSession", { path, query }) → AsyncIterable<StreamEvent<SseFrame<"streamCmdPaletteViewSession">>>

Options

sessionstringpathrequired
Opaque view session id
tokenstringqueryrequired
Opaque session stream token

GET /api/cmd-palette/view-sessions/{session}/streamapp tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();for await (const frame of compozy.events("streamCmdPaletteViewSession", { path: { "session": "session" }, query: { "token": "token" } })) {  console.log(frame);}

unpinCmdPaletteCommand

Unpin one command palette command

compozy.cmdPalette.unpinCmdPaletteCommand({ path, query }) → Promise<CmdPalettePinResponse>

Options

idstringpathrequired
Canonical command id
workspacestringqueryrequired
Workspace id, name, or path
profilestringquery
Act as this profile by name

DELETE /api/cmd-palette/pins/{id}app tokens denied

example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.cmdPalette.unpinCmdPaletteCommand({ path: { "id": "id" }, query: { "workspace": "workspace" } });