Skip to content

Cmd palette

CompozyOS Cmd palette HTTP endpoints.

16 endpoints32 pages in API Reference

Endpoints16

GET/api/cmd-palette/clients

List attached command palette clients

httpuds

Query parameters

workspace*string

Workspace id, name, or path

profile?string

Read one profile's rows by name

all_profiles?boolean

Read the owner-labeled all-profiles aggregate

Responses

200
OK
400
Invalid workspace
503
Command palette unavailable
Request
curl -X GET 'http://localhost:2123/api/cmd-palette/clients?workspace=string'
200 OK
[  {    "attached_at": "2019-08-24T14:15:22Z",    "client_id": "string",    "kind": "string",    "workspace": "string"  }]

GET/api/cmd-palette/commands

List command palette commands

httpuds

Query parameters

workspace*string

Workspace id, name, or path

client?string

Attached client whose context resolves availability

profile?string

Read one profile's rows by name

all_profiles?boolean

Read the owner-labeled all-profiles aggregate

Responses

200
OK
400
Invalid workspace
503
Command palette unavailable
Request
curl -X GET 'http://localhost:2123/api/cmd-palette/commands?workspace=string'
200 OK
{  "catalog_revision": "string",  "commands": [    {      "action": {        "app": "string",        "args": {          "property1": null,          "property2": null        },        "kind": "string",        "op": "string",        "tool": "string",        "url": "string",        "view": "string"      },      "alias": "string",      "arguments": [        {          "name": "string",          "options": [            "string"          ],          "placeholder": "string",          "required": true,          "type": "string"        }      ],      "availability_exempt": true,      "available": true,      "bindings": [        "string"      ],      "confirmation": {        "body": "string",        "confirm": "string",        "title": "string"      },      "destructive": true,      "execution": {        "retry_safe": true,        "single_flight": true      },      "global_shortcut": {        "active_chord": "string",        "intended_chord": "string",        "reason": "string",        "settings_url": "string",        "status": "string"      },      "icon": "string",      "id": "string",      "keywords": [        "string"      ],      "reason": "string",      "section": "string",      "source": "string",      "title": "string",      "when": [        {          "key": "string",          "operator": "string",          "reason": "string",          "value": null        }      ]    }  ],  "context_revision": "string",  "profile_lens": {    "profile_lens_id": "string",    "profile_name": "string"  },  "sources": [    {      "reason": "string",      "source": "string",      "status": "string"    }  ]}

POST/api/cmd-palette/commands/{id}/invoke

Invoke one command palette command

httpuds

Path parameters

id*string

Canonical command id

Query parameters

profile?string

Act as this profile by name

Header parameters

X-Compozy-Client-Token*string

Attached client identity token

Request body

JSON request body

application/json
  1. body
args*
client?string
workspace*string

Responses

200
Completed
202
Approval pending
400
Invalid request
401
Invalid client attachment
404
Command not found
409
Invocation conflict
412
Command unavailable
422
Invalid command arguments
503
Command palette unavailable
Request
curl -X POST 'http://localhost:2123/api/cmd-palette/commands/string/invoke' \  -H 'X-Compozy-Client-Token: string' \  -H 'Content-Type: application/json' \  -d '{  "args": {    "property1": null,    "property2": null  },  "workspace": "string"}'
200 Completed
{  "approval_id": "string",  "invocation_id": "string",  "profile_lens": {    "profile_lens_id": "string",    "profile_name": "string"  },  "result": null,  "status": "string"}

GET/api/cmd-palette/personalization

Get command palette personalization summary

httpuds

Query parameters

workspace*string

Workspace id, name, or path

profile?string

Read one profile's rows by name

all_profiles?boolean

Read the owner-labeled all-profiles aggregate

Responses

200
OK
400
Invalid workspace
503
Command palette unavailable
Request
curl -X GET 'http://localhost:2123/api/cmd-palette/personalization?workspace=string'
200 OK
{  "frecency_entries": 0,  "pins": [    "string"  ],  "profile_lens": {    "profile_lens_id": "string",    "profile_name": "string"  },  "query_associations": 0,  "recents": 0,  "workspace": "string"}

DELETE/api/cmd-palette/personalization

Reset command palette personalization

httpuds

Query parameters

workspace*string

Workspace id, name, or path

profile?string

Act as this profile by name

Responses

200
Reset
400
Invalid workspace
503
Command palette unavailable
Request
curl -X DELETE 'http://localhost:2123/api/cmd-palette/personalization?workspace=string'
200 Reset
{  "status": "string"}

DELETE/api/cmd-palette/pins/{id}

Unpin one command palette command

httpuds

Path parameters

id*string

Canonical command id

Query parameters

workspace*string

Workspace id, name, or path

profile?string

Act as this profile by name

Responses

200
Unpinned
400
Invalid workspace
404
Command not found
503
Command palette unavailable
Request
curl -X DELETE 'http://localhost:2123/api/cmd-palette/pins/string?workspace=string'
200 Unpinned
{  "pinned": true}

PUT/api/cmd-palette/pins/{id}

Pin one command palette command

httpuds

Path parameters

id*string

Canonical command id

Query parameters

workspace*string

Workspace id, name, or path

profile?string

Act as this profile by name

Responses

200
Pinned
400
Invalid workspace
404
Command not found
503
Command palette unavailable
Request
curl -X PUT 'http://localhost:2123/api/cmd-palette/pins/string?workspace=string'
200 Pinned
{  "pinned": true}

GET/api/cmd-palette/rank-signals

Get command palette rank signals

httpuds

Query parameters

workspace*string

Workspace id, name, or path

profile?string

Read one profile's rows by name

all_profiles?boolean

Read the owner-labeled all-profiles aggregate

Responses

200
OK
400
Invalid workspace
503
Command palette unavailable
Request
curl -X GET 'http://localhost:2123/api/cmd-palette/rank-signals?workspace=string'
200 OK
{  "pins": [    "string"  ],  "profile_lens": {    "profile_lens_id": "string",    "profile_name": "string"  },  "query_hits": [    {      "command_id": "string",      "query": "string",      "weight": 0.1    }  ],  "revision": "string",  "usage": [    {      "command_id": "string",      "last_used_at": 0,      "weight": 0.1    }  ],  "weights": {    "context_boost": 0.1,    "deadband": 0.1,    "domain_view_mount_cap": 0,    "entity_section_visible_cap": 0,    "fallback_weak_match_threshold": 0.1,    "frecency_cap": 0.1,    "frecency_half_life_days": 0,    "frecency_scale": 0.1,    "ghost_min_score": 0.1,    "group_order": [      "string"    ],    "match_alias_exact": 0.1,    "match_compact_prefix": 0.1,    "match_contains": 0.1,    "match_exact": 0.1,    "match_prefix": 0.1,    "match_subsequence_max": 0.1,    "match_subsequence_min": 0.1,    "match_token_prefix": 0.1,    "match_word_boundary_max": 0.1,    "match_word_boundary_min": 0.1,    "max_query_length": 0,    "min_entity_query_length": 0,    "promotion_command_floor": 0.1,    "promotion_default_floor": 0.1,    "promotion_path_floor": 0.1,    "promotion_tab_floor": 0.1,    "prune_after_days": 0,    "prune_threshold": 0.1,    "query_half_life_days": 0,    "query_learning_cap": 0.1,    "secondary_field_cap": 0.1,    "secondary_field_multiplier": 0.1,    "version": 0  }}

GET/api/cmd-palette/stream

Stream command palette catalog invalidations

httpuds

Query parameters

workspace*string

Workspace id, name, or path

profile?string

Read one profile's rows by name

all_profiles?boolean

Read the owner-labeled all-profiles aggregate

Responses

200
Catalog invalidation stream
400
Invalid workspace
503
Command palette unavailable
Request
curl -X GET 'http://localhost:2123/api/cmd-palette/stream?workspace=string'
200 Catalog invalidation stream
{  "catalog_revision": "string",  "profile_lens": {    "profile_lens_id": "string",    "profile_name": "string"  },  "workspace": "string"}

POST/api/cmd-palette/usage

Record command palette usage

httpuds

Query parameters

profile?string

Read one profile's rows by name

all_profiles?boolean

Read the owner-labeled all-profiles aggregate

Request body

JSON request body

application/json
  1. body
command_id*string
query*string
workspace*string

Responses

204
Recorded
400
Invalid request
404
Command not found
503
Command palette unavailable
Request
curl -X POST 'http://localhost:2123/api/cmd-palette/usage' \  -H 'Content-Type: application/json' \  -d '{  "command_id": "string",  "query": "string",  "workspace": "string"}'
400 Invalid request
{  "clients": [    "string"  ],  "error": "string",  "fields": {    "property1": "string",    "property2": "string"  },  "message": "string",  "reason": "string"}

DELETE/api/cmd-palette/view-sessions/{session}

Close one programmable command palette view

httpuds

Path parameters

session*string

Opaque view session id

Header parameters

X-Compozy-Client-Token*string

Attached client identity token

Responses

200
Closed
403
Session ownership mismatch
Request
curl -X DELETE 'http://localhost:2123/api/cmd-palette/view-sessions/string' \  -H 'X-Compozy-Client-Token: string'
200 Closed
{  "closed": true}

POST/api/cmd-palette/view-sessions/{session}/events

Send one programmable view event

httpuds

Path parameters

session*string

Opaque view session id

Header parameters

X-Compozy-Client-Token*string

Attached client identity token

Request body

JSON request body

application/json
  1. body
ack_effects?array<string>
args?array<unknown>
effect_result?|
handler*string
revision*string
seq*integer
Formatint64

Responses

202
Accepted
400
Invalid request
403
Session ownership mismatch
409
View event cap reached
410
View session is gone
Request
curl -X POST 'http://localhost:2123/api/cmd-palette/view-sessions/string/events' \  -H 'X-Compozy-Client-Token: string' \  -H 'Content-Type: application/json' \  -d '{  "handler": "string",  "revision": "string",  "seq": 0}'
202 Accepted
{  "accepted": true}

GET/api/cmd-palette/view-sessions/{session}/stream

Stream one programmable command palette view

httpuds

Path parameters

session*string

Opaque view session id

Query parameters

token*string

Opaque session stream token

Responses

200
Session-scoped view frames
403
Invalid stream token
410
View session is gone
Request
curl -X GET 'http://localhost:2123/api/cmd-palette/view-sessions/string/stream?token=string'
200 Session-scoped view frames
{  "effects": [    {      "copy": {        "content": "string"      },      "id": "string",      "open_app": {        "app": "string"      },      "open_url": {        "url": "string"      },      "pick_files": {        "directories": true      },      "toast": {        "message": "string",        "tone": "string"      }    }  ],  "generation": 0,  "handlers": [    "string"  ],  "in_reply_to": 0,  "patch": {    "from": "string",    "ops": [      {        "op": "string",        "path": "string",        "value": null      }    ],    "to": "string",    "view_id": "string"  },  "payload": {    "chips": [      {        "count": 0,        "fallback": "string",        "id": "string",        "label": "string",        "requires": {          "property1": "string",          "property2": "string"        }      }    ],    "chrome": {      "active_chip": "string",      "columns": 0,      "complete": true,      "event_count": 0,      "filtering": true,      "is_loading": true,      "on_chip": "string",      "on_load_more": "string",      "on_search": "string",      "on_selection": "string",      "pagination": {        "has_more": true,        "page_size": 0      },      "search_placeholder": "string",      "search_text": "string",      "throttle_ms": 0    },    "detail": {      "actions": [        {          "action": {            "app": "string",            "args": {              "property1": null,              "property2": null            },            "kind": "string",            "op": "string",            "tool": "string",            "url": "string",            "view": "string"          },          "confirmation": {            "body": "string",            "confirm": "string",            "title": "string"          },          "destructive": true,          "fallback": "string",          "handler": "string",          "icon": "string",          "primary": true,          "requires": {            "property1": "string",            "property2": "string"          },          "section": "string",          "shortcut": "string",          "submit_form": true,          "title": "string"        }      ],      "is_loading": true,      "markdown": "string",      "metadata": [        {          "fallback": "string",          "label": "string",          "requires": {            "property1": "string",            "property2": "string"          },          "value": "string"        }      ]    },    "empty": {      "hint": "string",      "icon": "string",      "title": "string"    },    "form": {      "fields": [        {          "default": null,          "directories": true,          "empty_hint": "string",          "error": "string",          "event_count": 0,          "fallback": "string",          "id": "string",          "label": "string",          "on_blur": "string",          "on_change": "string",          "options": [            "string"          ],          "placeholder": "string",          "required": true,          "requires": {            "property1": "string",            "property2": "string"          },          "type": "string"        }      ],      "on_submit": "string",      "submit": {        "action": {          "app": "string",          "args": {            "property1": null,            "property2": null          },          "kind": "string",          "op": "string",          "tool": "string",          "url": "string",          "view": "string"        },        "confirmation": {          "body": "string",          "confirm": "string",          "title": "string"        },        "destructive": true,        "fallback": "string",        "handler": "string",        "icon": "string",        "primary": true,        "requires": {          "property1": "string",          "property2": "string"        },        "section": "string",        "shortcut": "string",        "submit_form": true,        "title": "string"      }    },    "grid": {      "sections": [        {          "tiles": [            {              "actions": [                {                  "action": {                    "app": "string",                    "args": {                      "property1": null,                      "property2": null                    },                    "kind": "string",                    "op": "string",                    "tool": "string",                    "url": "string",                    "view": "string"                  },                  "confirmation": {                    "body": "string",                    "confirm": "string",                    "title": "string"                  },                  "destructive": true,                  "fallback": "string",                  "handler": "string",                  "icon": "string",                  "primary": true,                  "requires": {                    "property1": "string",                    "property2": "string"                  },                  "section": "string",                  "shortcut": "string",                  "submit_form": true,                  "title": "string"                }              ],              "badge": {                "label": "string",                "tone": "string"              },              "fallback": "string",              "id": "string",              "image": {                "emoji": "string",                "token": "string",                "url": "string"              },              "requires": {                "property1": "string",                "property2": "string"              },              "title": "string"            }          ],          "title": "string"        }      ]    },    "sections": [      {        "rows": [          {            "accessories": [              "string"            ],            "actions": [              {                "action": {                  "app": "string",                  "args": {                    "property1": null,                    "property2": null                  },                  "kind": "string",                  "op": "string",                  "tool": "string",                  "url": "string",                  "view": "string"                },                "confirmation": {                  "body": "string",                  "confirm": "string",                  "title": "string"                },                "destructive": true,                "fallback": "string",                "handler": "string",                "icon": "string",                "primary": true,                "requires": {                  "property1": "string",                  "property2": "string"                },                "section": "string",                "shortcut": "string",                "submit_form": true,                "title": "string"              }            ],            "badge": {              "label": "string",              "tone": "string"            },            "detail": {              "actions": [                {                  "action": {                    "app": "string",                    "args": {                      "property1": null,                      "property2": null                    },                    "kind": "string",                    "op": "string",                    "tool": "string",                    "url": "string",                    "view": "string"                  },                  "confirmation": {                    "body": "string",                    "confirm": "string",                    "title": "string"                  },                  "destructive": true,                  "fallback": "string",                  "handler": "string",                  "icon": "string",                  "primary": true,                  "requires": {                    "property1": "string",                    "property2": "string"                  },                  "section": "string",                  "shortcut": "string",                  "submit_form": true,                  "title": "string"                }              ],              "is_loading": true,              "markdown": "string",              "metadata": [                {                  "fallback": "string",                  "label": "string",                  "requires": {                    "property1": "string",                    "property2": "string"                  },                  "value": "string"                }              ]            },            "fallback": "string",            "icon": "string",            "id": "string",            "keywords": [              "string"            ],            "requires": {              "property1": "string",              "property2": "string"            },            "subtitle": "string",            "title": "string"          }        ],        "title": "string"      }    ],    "view": "string"  },  "revision": "string",  "view_session": "string"}

GET/api/cmd-palette/views/{id}

Get one declarative command palette view

httpuds

Path parameters

id*string

Canonical view id

Query parameters

workspace*string

Workspace id, name, or path

profile?string

Read one profile's rows by name

all_profiles?boolean

Read the owner-labeled all-profiles aggregate

Responses

200
OK
400
Invalid workspace
404
View not found
422
Invalid view payload
503
Command palette unavailable
Request
curl -X GET 'http://localhost:2123/api/cmd-palette/views/string?workspace=string'
200 OK
{  "kind": "string",  "payload": {    "chips": [      {        "count": 0,        "fallback": "string",        "id": "string",        "label": "string",        "requires": {          "property1": "string",          "property2": "string"        }      }    ],    "chrome": {      "active_chip": "string",      "columns": 0,      "complete": true,      "event_count": 0,      "filtering": true,      "is_loading": true,      "on_chip": "string",      "on_load_more": "string",      "on_search": "string",      "on_selection": "string",      "pagination": {        "has_more": true,        "page_size": 0      },      "search_placeholder": "string",      "search_text": "string",      "throttle_ms": 0    },    "detail": {      "actions": [        {          "action": {            "app": "string",            "args": {              "property1": null,              "property2": null            },            "kind": "string",            "op": "string",            "tool": "string",            "url": "string",            "view": "string"          },          "confirmation": {            "body": "string",            "confirm": "string",            "title": "string"          },          "destructive": true,          "fallback": "string",          "handler": "string",          "icon": "string",          "primary": true,          "requires": {            "property1": "string",            "property2": "string"          },          "section": "string",          "shortcut": "string",          "submit_form": true,          "title": "string"        }      ],      "is_loading": true,      "markdown": "string",      "metadata": [        {          "fallback": "string",          "label": "string",          "requires": {            "property1": "string",            "property2": "string"          },          "value": "string"        }      ]    },    "empty": {      "hint": "string",      "icon": "string",      "title": "string"    },    "form": {      "fields": [        {          "default": null,          "directories": true,          "empty_hint": "string",          "error": "string",          "event_count": 0,          "fallback": "string",          "id": "string",          "label": "string",          "on_blur": "string",          "on_change": "string",          "options": [            "string"          ],          "placeholder": "string",          "required": true,          "requires": {            "property1": "string",            "property2": "string"          },          "type": "string"        }      ],      "on_submit": "string",      "submit": {        "action": {          "app": "string",          "args": {            "property1": null,            "property2": null          },          "kind": "string",          "op": "string",          "tool": "string",          "url": "string",          "view": "string"        },        "confirmation": {          "body": "string",          "confirm": "string",          "title": "string"        },        "destructive": true,        "fallback": "string",        "handler": "string",        "icon": "string",        "primary": true,        "requires": {          "property1": "string",          "property2": "string"        },        "section": "string",        "shortcut": "string",        "submit_form": true,        "title": "string"      }    },    "grid": {      "sections": [        {          "tiles": [            {              "actions": [                {                  "action": {                    "app": "string",                    "args": {                      "property1": null,                      "property2": null                    },                    "kind": "string",                    "op": "string",                    "tool": "string",                    "url": "string",                    "view": "string"                  },                  "confirmation": {                    "body": "string",                    "confirm": "string",                    "title": "string"                  },                  "destructive": true,                  "fallback": "string",                  "handler": "string",                  "icon": "string",                  "primary": true,                  "requires": {                    "property1": "string",                    "property2": "string"                  },                  "section": "string",                  "shortcut": "string",                  "submit_form": true,                  "title": "string"                }              ],              "badge": {                "label": "string",                "tone": "string"              },              "fallback": "string",              "id": "string",              "image": {                "emoji": "string",                "token": "string",                "url": "string"              },              "requires": {                "property1": "string",                "property2": "string"              },              "title": "string"            }          ],          "title": "string"        }      ]    },    "sections": [      {        "rows": [          {            "accessories": [              "string"            ],            "actions": [              {                "action": {                  "app": "string",                  "args": {                    "property1": null,                    "property2": null                  },                  "kind": "string",                  "op": "string",                  "tool": "string",                  "url": "string",                  "view": "string"                },                "confirmation": {                  "body": "string",                  "confirm": "string",                  "title": "string"                },                "destructive": true,                "fallback": "string",                "handler": "string",                "icon": "string",                "primary": true,                "requires": {                  "property1": "string",                  "property2": "string"                },                "section": "string",                "shortcut": "string",                "submit_form": true,                "title": "string"              }            ],            "badge": {              "label": "string",              "tone": "string"            },            "detail": {              "actions": [                {                  "action": {                    "app": "string",                    "args": {                      "property1": null,                      "property2": null                    },                    "kind": "string",                    "op": "string",                    "tool": "string",                    "url": "string",                    "view": "string"                  },                  "confirmation": {                    "body": "string",                    "confirm": "string",                    "title": "string"                  },                  "destructive": true,                  "fallback": "string",                  "handler": "string",                  "icon": "string",                  "primary": true,                  "requires": {                    "property1": "string",                    "property2": "string"                  },                  "section": "string",                  "shortcut": "string",                  "submit_form": true,                  "title": "string"                }              ],              "is_loading": true,              "markdown": "string",              "metadata": [                {                  "fallback": "string",                  "label": "string",                  "requires": {                    "property1": "string",                    "property2": "string"                  },                  "value": "string"                }              ]            },            "fallback": "string",            "icon": "string",            "id": "string",            "keywords": [              "string"            ],            "requires": {              "property1": "string",              "property2": "string"            },            "subtitle": "string",            "title": "string"          }        ],        "title": "string"      }    ],    "view": "string"  },  "profile_lens": {    "profile_lens_id": "string",    "profile_name": "string"  },  "revision": "string",  "stream_epoch": "string",  "title": "string",  "view_id": "string"}

POST/api/cmd-palette/views/{id}/open

Open one programmable command palette view

httpuds

Path parameters

id*string

Canonical view id

Query parameters

profile?string

Act as this profile by name

Header parameters

X-Compozy-Client-Token*string

Attached client identity token

Request body

JSON request body

application/json
  1. body
args?
workspace*string

Responses

200
Opened
400
Invalid request
401
Invalid client attachment
404
View not found
422
View is not programmable
503
Command palette unavailable
Request
curl -X POST 'http://localhost:2123/api/cmd-palette/views/string/open' \  -H 'X-Compozy-Client-Token: string' \  -H 'Content-Type: application/json' \  -d '{  "workspace": "string"}'
200 Opened
{  "first_frame": {    "effects": [      {        "copy": {          "content": "string"        },        "id": "string",        "open_app": {          "app": "string"        },        "open_url": {          "url": "string"        },        "pick_files": {          "directories": true        },        "toast": {          "message": "string",          "tone": "string"        }      }    ],    "generation": 0,    "handlers": [      "string"    ],    "in_reply_to": 0,    "patch": {      "from": "string",      "ops": [        {          "op": "string",          "path": "string",          "value": null        }      ],      "to": "string",      "view_id": "string"    },    "payload": {      "chips": [        {          "count": 0,          "fallback": "string",          "id": "string",          "label": "string",          "requires": {            "property1": "string",            "property2": "string"          }        }      ],      "chrome": {        "active_chip": "string",        "columns": 0,        "complete": true,        "event_count": 0,        "filtering": true,        "is_loading": true,        "on_chip": "string",        "on_load_more": "string",        "on_search": "string",        "on_selection": "string",        "pagination": {          "has_more": true,          "page_size": 0        },        "search_placeholder": "string",        "search_text": "string",        "throttle_ms": 0      },      "detail": {        "actions": [          {            "action": {              "app": "string",              "args": {                "property1": null,                "property2": null              },              "kind": "string",              "op": "string",              "tool": "string",              "url": "string",              "view": "string"            },            "confirmation": {              "body": "string",              "confirm": "string",              "title": "string"            },            "destructive": true,            "fallback": "string",            "handler": "string",            "icon": "string",            "primary": true,            "requires": {              "property1": "string",              "property2": "string"            },            "section": "string",            "shortcut": "string",            "submit_form": true,            "title": "string"          }        ],        "is_loading": true,        "markdown": "string",        "metadata": [          {            "fallback": "string",            "label": "string",            "requires": {              "property1": "string",              "property2": "string"            },            "value": "string"          }        ]      },      "empty": {        "hint": "string",        "icon": "string",        "title": "string"      },      "form": {        "fields": [          {            "default": null,            "directories": true,            "empty_hint": "string",            "error": "string",            "event_count": 0,            "fallback": "string",            "id": "string",            "label": "string",            "on_blur": "string",            "on_change": "string",            "options": [              "string"            ],            "placeholder": "string",            "required": true,            "requires": {              "property1": "string",              "property2": "string"            },            "type": "string"          }        ],        "on_submit": "string",        "submit": {          "action": {            "app": "string",            "args": {              "property1": null,              "property2": null            },            "kind": "string",            "op": "string",            "tool": "string",            "url": "string",            "view": "string"          },          "confirmation": {            "body": "string",            "confirm": "string",            "title": "string"          },          "destructive": true,          "fallback": "string",          "handler": "string",          "icon": "string",          "primary": true,          "requires": {            "property1": "string",            "property2": "string"          },          "section": "string",          "shortcut": "string",          "submit_form": true,          "title": "string"        }      },      "grid": {        "sections": [          {            "tiles": [              {                "actions": [                  {                    "action": {                      "app": "string",                      "args": {                        "property1": null,                        "property2": null                      },                      "kind": "string",                      "op": "string",                      "tool": "string",                      "url": "string",                      "view": "string"                    },                    "confirmation": {                      "body": "string",                      "confirm": "string",                      "title": "string"                    },                    "destructive": true,                    "fallback": "string",                    "handler": "string",                    "icon": "string",                    "primary": true,                    "requires": {                      "property1": "string",                      "property2": "string"                    },                    "section": "string",                    "shortcut": "string",                    "submit_form": true,                    "title": "string"                  }                ],                "badge": {                  "label": "string",                  "tone": "string"                },                "fallback": "string",                "id": "string",                "image": {                  "emoji": "string",                  "token": "string",                  "url": "string"                },                "requires": {                  "property1": "string",                  "property2": "string"                },                "title": "string"              }            ],            "title": "string"          }        ]      },      "sections": [        {          "rows": [            {              "accessories": [                "string"              ],              "actions": [                {                  "action": {                    "app": "string",                    "args": {                      "property1": null,                      "property2": null                    },                    "kind": "string",                    "op": "string",                    "tool": "string",                    "url": "string",                    "view": "string"                  },                  "confirmation": {                    "body": "string",                    "confirm": "string",                    "title": "string"                  },                  "destructive": true,                  "fallback": "string",                  "handler": "string",                  "icon": "string",                  "primary": true,                  "requires": {                    "property1": "string",                    "property2": "string"                  },                  "section": "string",                  "shortcut": "string",                  "submit_form": true,                  "title": "string"                }              ],              "badge": {                "label": "string",                "tone": "string"              },              "detail": {                "actions": [                  {                    "action": {                      "app": "string",                      "args": {                        "property1": null,                        "property2": null                      },                      "kind": "string",                      "op": "string",                      "tool": "string",                      "url": "string",                      "view": "string"                    },                    "confirmation": {                      "body": "string",                      "confirm": "string",                      "title": "string"                    },                    "destructive": true,                    "fallback": "string",                    "handler": "string",                    "icon": "string",                    "primary": true,                    "requires": {                      "property1": "string",                      "property2": "string"                    },                    "section": "string",                    "shortcut": "string",                    "submit_form": true,                    "title": "string"                  }                ],                "is_loading": true,                "markdown": "string",                "metadata": [                  {                    "fallback": "string",                    "label": "string",                    "requires": {                      "property1": "string",                      "property2": "string"                    },                    "value": "string"                  }                ]              },              "fallback": "string",              "icon": "string",              "id": "string",              "keywords": [                "string"              ],              "requires": {                "property1": "string",                "property2": "string"              },              "subtitle": "string",              "title": "string"            }          ],          "title": "string"        }      ],      "view": "string"    },    "revision": "string",    "view_session": "string"  },  "profile_lens": {    "profile_lens_id": "string",    "profile_name": "string"  },  "stream_token": "string",  "view_session": "string"}

GET/api/cmd-palette/views/{id}/stream

Stream declarative command palette view patches

httpuds

Path parameters

id*string

Canonical view id

Query parameters

workspace*string

Workspace id, name, or path

after?string

Last applied patch sequence

stream_epoch?string

Stream epoch required when after is greater than zero

profile?string

Read one profile's rows by name

all_profiles?boolean

Read the owner-labeled all-profiles aggregate

Responses

200
Revision-fenced view patch stream
400
Invalid stream cursor
404
View not found
422
Invalid view payload
503
Command palette unavailable
Request
curl -X GET 'http://localhost:2123/api/cmd-palette/views/string/stream?workspace=string'
200 Revision-fenced view patch stream
{  "patch": {    "from": "string",    "ops": [      {        "op": "string",        "path": "string",        "value": null      }    ],    "to": "string",    "view_id": "string"  },  "payload": {    "chips": [      {        "count": 0,        "fallback": "string",        "id": "string",        "label": "string",        "requires": {          "property1": "string",          "property2": "string"        }      }    ],    "chrome": {      "active_chip": "string",      "columns": 0,      "complete": true,      "event_count": 0,      "filtering": true,      "is_loading": true,      "on_chip": "string",      "on_load_more": "string",      "on_search": "string",      "on_selection": "string",      "pagination": {        "has_more": true,        "page_size": 0      },      "search_placeholder": "string",      "search_text": "string",      "throttle_ms": 0    },    "detail": {      "actions": [        {          "action": {            "app": "string",            "args": {              "property1": null,              "property2": null            },            "kind": "string",            "op": "string",            "tool": "string",            "url": "string",            "view": "string"          },          "confirmation": {            "body": "string",            "confirm": "string",            "title": "string"          },          "destructive": true,          "fallback": "string",          "handler": "string",          "icon": "string",          "primary": true,          "requires": {            "property1": "string",            "property2": "string"          },          "section": "string",          "shortcut": "string",          "submit_form": true,          "title": "string"        }      ],      "is_loading": true,      "markdown": "string",      "metadata": [        {          "fallback": "string",          "label": "string",          "requires": {            "property1": "string",            "property2": "string"          },          "value": "string"        }      ]    },    "empty": {      "hint": "string",      "icon": "string",      "title": "string"    },    "form": {      "fields": [        {          "default": null,          "directories": true,          "empty_hint": "string",          "error": "string",          "event_count": 0,          "fallback": "string",          "id": "string",          "label": "string",          "on_blur": "string",          "on_change": "string",          "options": [            "string"          ],          "placeholder": "string",          "required": true,          "requires": {            "property1": "string",            "property2": "string"          },          "type": "string"        }      ],      "on_submit": "string",      "submit": {        "action": {          "app": "string",          "args": {            "property1": null,            "property2": null          },          "kind": "string",          "op": "string",          "tool": "string",          "url": "string",          "view": "string"        },        "confirmation": {          "body": "string",          "confirm": "string",          "title": "string"        },        "destructive": true,        "fallback": "string",        "handler": "string",        "icon": "string",        "primary": true,        "requires": {          "property1": "string",          "property2": "string"        },        "section": "string",        "shortcut": "string",        "submit_form": true,        "title": "string"      }    },    "grid": {      "sections": [        {          "tiles": [            {              "actions": [                {                  "action": {                    "app": "string",                    "args": {                      "property1": null,                      "property2": null                    },                    "kind": "string",                    "op": "string",                    "tool": "string",                    "url": "string",                    "view": "string"                  },                  "confirmation": {                    "body": "string",                    "confirm": "string",                    "title": "string"                  },                  "destructive": true,                  "fallback": "string",                  "handler": "string",                  "icon": "string",                  "primary": true,                  "requires": {                    "property1": "string",                    "property2": "string"                  },                  "section": "string",                  "shortcut": "string",                  "submit_form": true,                  "title": "string"                }              ],              "badge": {                "label": "string",                "tone": "string"              },              "fallback": "string",              "id": "string",              "image": {                "emoji": "string",                "token": "string",                "url": "string"              },              "requires": {                "property1": "string",                "property2": "string"              },              "title": "string"            }          ],          "title": "string"        }      ]    },    "sections": [      {        "rows": [          {            "accessories": [              "string"            ],            "actions": [              {                "action": {                  "app": "string",                  "args": {                    "property1": null,                    "property2": null                  },                  "kind": "string",                  "op": "string",                  "tool": "string",                  "url": "string",                  "view": "string"                },                "confirmation": {                  "body": "string",                  "confirm": "string",                  "title": "string"                },                "destructive": true,                "fallback": "string",                "handler": "string",                "icon": "string",                "primary": true,                "requires": {                  "property1": "string",                  "property2": "string"                },                "section": "string",                "shortcut": "string",                "submit_form": true,                "title": "string"              }            ],            "badge": {              "label": "string",              "tone": "string"            },            "detail": {              "actions": [                {                  "action": {                    "app": "string",                    "args": {                      "property1": null,                      "property2": null                    },                    "kind": "string",                    "op": "string",                    "tool": "string",                    "url": "string",                    "view": "string"                  },                  "confirmation": {                    "body": "string",                    "confirm": "string",                    "title": "string"                  },                  "destructive": true,                  "fallback": "string",                  "handler": "string",                  "icon": "string",                  "primary": true,                  "requires": {                    "property1": "string",                    "property2": "string"                  },                  "section": "string",                  "shortcut": "string",                  "submit_form": true,                  "title": "string"                }              ],              "is_loading": true,              "markdown": "string",              "metadata": [                {                  "fallback": "string",                  "label": "string",                  "requires": {                    "property1": "string",                    "property2": "string"                  },                  "value": "string"                }              ]            },            "fallback": "string",            "icon": "string",            "id": "string",            "keywords": [              "string"            ],            "requires": {              "property1": "string",              "property2": "string"            },            "subtitle": "string",            "title": "string"          }        ],        "title": "string"      }    ],    "view": "string"  },  "reset": true,  "revision": "string",  "sequence": 0,  "stream_epoch": "string"}