Skip to content

Cmd palette

CompozyOS Cmd palette HTTP endpoints.

For people running agent work33 pages in this section

List attached command palette clients

GET/api/cmd-palette/clients

Query Parameters

workspace*string

Workspace id, name, or path

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/cmd-palette/clients?workspace=string"
[  {    "attached_at": "2019-08-24T14:15:22Z",    "client_id": "string",    "kind": "string",    "workspace": "string"  }]

List command palette commands

GET/api/cmd-palette/commands

Query Parameters

workspace*string

Workspace id, name, or path

client?string

Attached client whose context resolves availability

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/cmd-palette/commands?workspace=string"
{  "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",  "sources": [    {      "reason": "string",      "source": "string",      "status": "string"    }  ]}

Invoke one command palette command

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

Path Parameters

id*string

Canonical command id

Header Parameters

X-Compozy-Client-Token*string

Attached client identity token

Request Body

application/json

JSON request body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/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"  }'
{  "approval_id": "string",  "invocation_id": "string",  "result": null,  "status": "string"}

Get command palette personalization summary

GET/api/cmd-palette/personalization

Query Parameters

workspace*string

Workspace id, name, or path

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/cmd-palette/personalization?workspace=string"
{  "frecency_entries": 0,  "pins": [    "string"  ],  "query_associations": 0,  "recents": 0,  "workspace": "string"}

Reset command palette personalization

DELETE/api/cmd-palette/personalization

Query Parameters

workspace*string

Workspace id, name, or path

Response Body

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/cmd-palette/personalization?workspace=string"
{  "status": "string"}

Unpin one command palette command

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

Path Parameters

id*string

Canonical command id

Query Parameters

workspace*string

Workspace id, name, or path

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/cmd-palette/pins/string?workspace=string"
{  "pinned": true}

Pin one command palette command

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

Path Parameters

id*string

Canonical command id

Query Parameters

workspace*string

Workspace id, name, or path

Response Body

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/api/cmd-palette/pins/string?workspace=string"
{  "pinned": true}

Get command palette rank signals

GET/api/cmd-palette/rank-signals

Query Parameters

workspace*string

Workspace id, name, or path

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/cmd-palette/rank-signals?workspace=string"
{  "pins": [    "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  }}

Stream command palette catalog invalidations

GET/api/cmd-palette/stream

Query Parameters

workspace*string

Workspace id, name, or path

Response Body

text/event-stream

application/json

application/json

curl -X GET "https://example.com/api/cmd-palette/stream?workspace=string"
{  "catalog_revision": "string",  "workspace": "string"}

Record command palette usage

POST/api/cmd-palette/usage

Request Body

application/json

JSON request body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/api/cmd-palette/usage" \  -H "Content-Type: application/json" \  -d '{    "command_id": "string",    "query": "string",    "workspace": "string"  }'
Empty

Close one programmable command palette view

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

Path Parameters

session*string

Opaque view session id

Header Parameters

X-Compozy-Client-Token*string

Attached client identity token

Response Body

application/json

application/json

curl -X DELETE "https://example.com/api/cmd-palette/view-sessions/string" \  -H "X-Compozy-Client-Token: string"
{  "closed": true}

Send one programmable view event

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

Path Parameters

session*string

Opaque view session id

Header Parameters

X-Compozy-Client-Token*string

Attached client identity token

Request Body

application/json

JSON request body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/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  }'
{  "accepted": true}

Stream one programmable command palette view

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

Path Parameters

session*string

Opaque view session id

Query Parameters

token*string

Opaque session stream token

Response Body

text/event-stream

application/json

application/json

curl -X GET "https://example.com/api/cmd-palette/view-sessions/string/stream?token=string"
{  "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 one declarative command palette view

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

Path Parameters

id*string

Canonical view id

Query Parameters

workspace*string

Workspace id, name, or path

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/cmd-palette/views/string?workspace=string"
{  "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"  },  "revision": "string",  "stream_epoch": "string",  "title": "string",  "view_id": "string"}

Open one programmable command palette view

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

Path Parameters

id*string

Canonical view id

Header Parameters

X-Compozy-Client-Token*string

Attached client identity token

Request Body

application/json

JSON request body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/cmd-palette/views/string/open" \  -H "X-Compozy-Client-Token: string" \  -H "Content-Type: application/json" \  -d '{    "workspace": "string"  }'
{  "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"  },  "stream_token": "string",  "view_session": "string"}

Stream declarative command palette view patches

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

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

Response Body

text/event-stream

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/cmd-palette/views/string/stream?workspace=string"
{  "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"}

Roles

CompozyOS Roles HTTP endpoints.