> For the complete documentation index, see [llms.txt](https://docs.rootcause.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.rootcause.ai/api-and-integrations/rest-api-reference/applications.md).

# Applications

## List applications

> Lists the applications in the workspace. Paginated (limit, cursor). Deployed copies of an application are not listed; only the applications themselves. The builder graph, trigger and type configuration are not part of the public shape.

```json
{"openapi":"3.1.0","info":{"title":"RootCause Public API","version":"1.0.0"},"tags":[{"name":"Applications"}],"servers":[{"url":"https://sandbox.rootcause.ai","description":"Sandbox"},{"url":"https://platform.rootcause.ai","description":"Production"},{"url":"http://localhost:3000","description":"Local development"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"An API key (pk_...) created on the Organisation API page, or an OAuth access token. Every operation requires one."}},"schemas":{"ApplicationListEnvelope":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Application"}},"pagination":{"type":"object","properties":{"cursor":{"type":"string","description":"Pass back as ?cursor= to fetch the next page"},"hasMore":{"type":"boolean","description":"Whether a further page exists"},"total":{"type":"number","description":"Total matching rows, when the query can count them"}},"required":["hasMore"]}},"required":["data","pagination"]},"Application":{"type":"object","properties":{"id":{"type":"string"},"workspaceId":{"type":["string","null"]},"organisationId":{"type":"string"},"name":{"type":"string"},"date":{"type":["string","null"]},"lastSaved":{"type":["string","null"]},"tags":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"description":{"type":["string","null"]},"access":{"anyOf":[{"type":"string","enum":["public","private","restricted","organisation"]},{"type":"null"}]},"parentId":{"type":["string","null"]},"version":{"type":["string","null"]},"deployedAt":{"type":["string","null"]},"building":{"type":["boolean","null"]},"status":{"type":"string","enum":["Running","Idle","Failed"]},"isLive":{"type":["boolean","null"]},"type":{"anyOf":[{"type":"string","enum":["dashboard","api","automation","ai"]},{"type":"null"}]},"kind":{"anyOf":[{"type":"string","enum":["user","system"]},{"type":"null"}]},"slug":{"type":["string","null"]},"lifecycleStatus":{"anyOf":[{"type":"string","enum":["draft","published","archived"]},{"type":"null"}]},"publish":{"anyOf":[{"type":"object","properties":{"slug":{"type":["string","null"]},"publishedAt":{"type":["string","null"]},"publishedVersion":{"type":["string","null"]},"surfaces":{"anyOf":[{"type":"array","items":{"type":"string","enum":["rest","ui","agent","schedule","webhook","subapp"]}},{"type":"null"}]},"consumerAccess":{"anyOf":[{"type":"string","enum":["private","workspace","organisation","public"]},{"type":"null"}]},"embedOrigins":{"type":"array","items":{"type":"string"}},"notes":{"type":["string","null"]}}},{"type":"null"}]},"settings":{"anyOf":[{"type":"object","properties":{"description":{"type":["string","null"]},"icon":{"type":["string","null"]},"color":{"type":["string","null"]},"exposedTerminals":{"type":"array","items":{"type":"object","properties":{"moduleId":{"type":["string","null"]},"portId":{"type":["string","null"]},"widgetId":{"type":"string"},"direction":{"type":"string","enum":["in","out"]},"kind":{"type":"string","enum":["dataframe","scalar","json","text","document","image","binary","signal","event"]},"label":{"type":"string"}},"required":["widgetId","direction","kind","label"]}},"embeddablePages":{"type":"array","items":{"type":"string"}},"emittedEvents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"payloadSchema":{"anyOf":[{"type":"object","additionalProperties":{}},{"type":"null"}]},"description":{"type":"string","default":""}},"required":["name"]}},"agent":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"instructions":{"type":"string","default":""},"tools":{"type":"array","items":{"type":"string","enum":["app_describe","app_read_terminal","app_query_indicator","app_list_flows","app_run_status","app_read_contract_object","app_read_state","app_list_links","app_explain_module","app_press_button","app_set_control","app_open_page"]},"default":["app_describe","app_read_terminal","app_query_indicator","app_list_flows","app_run_status","app_read_contract_object","app_read_state","app_list_links","app_explain_module","app_press_button","app_set_control","app_open_page"]},"canPress":{"type":"array","items":{"type":"string"},"default":[]},"knowledge":{"type":"array","items":{"type":"string"},"default":[]},"model":{"type":["string","null"],"default":null}}}}},{"type":"null"}]}},"required":["id","organisationId","name","status"]}},"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"}},"required":["type","title","status","detail"]}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"}},"required":["type","title","status","detail"]}}}},"429":{"description":"Too Many Requests; the response carries Retry-After","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"}},"required":["type","title","status","detail"]}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"}},"required":["type","title","status","detail"]}}}}}},"paths":{"/api/v1/workspaces/{wsId}/applications":{"get":{"operationId":"get-api-v1-workspaces-{wsId}-applications","summary":"List applications","description":"Lists the applications in the workspace. Paginated (limit, cursor). Deployed copies of an application are not listed; only the applications themselves. The builder graph, trigger and type configuration are not part of the public shape.","tags":["Applications"],"parameters":[{"in":"query","name":"limit","required":false,"schema":{"description":"Page size (1-1000, default 50).","type":"number","minimum":1,"maximum":1000},"description":"Page size (1-1000, default 50)."},{"in":"query","name":"cursor","required":false,"schema":{"type":"string","description":"Opaque cursor from a previous response's `pagination.cursor`."},"description":"Opaque cursor from a previous response's `pagination.cursor`."},{"name":"wsId","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter: wsId"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationListEnvelope"}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Get application

> Returns the application by id from platform MongoDB. Must belong to the workspace; deployed copies are not addressable. The builder graph, trigger and type configuration are not part of the public shape.

```json
{"openapi":"3.1.0","info":{"title":"RootCause Public API","version":"1.0.0"},"tags":[{"name":"Applications"}],"servers":[{"url":"https://sandbox.rootcause.ai","description":"Sandbox"},{"url":"https://platform.rootcause.ai","description":"Production"},{"url":"http://localhost:3000","description":"Local development"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"An API key (pk_...) created on the Organisation API page, or an OAuth access token. Every operation requires one."}},"schemas":{"ApplicationEnvelope":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Application"}},"required":["data"]},"Application":{"type":"object","properties":{"id":{"type":"string"},"workspaceId":{"type":["string","null"]},"organisationId":{"type":"string"},"name":{"type":"string"},"date":{"type":["string","null"]},"lastSaved":{"type":["string","null"]},"tags":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}]},"description":{"type":["string","null"]},"access":{"anyOf":[{"type":"string","enum":["public","private","restricted","organisation"]},{"type":"null"}]},"parentId":{"type":["string","null"]},"version":{"type":["string","null"]},"deployedAt":{"type":["string","null"]},"building":{"type":["boolean","null"]},"status":{"type":"string","enum":["Running","Idle","Failed"]},"isLive":{"type":["boolean","null"]},"type":{"anyOf":[{"type":"string","enum":["dashboard","api","automation","ai"]},{"type":"null"}]},"kind":{"anyOf":[{"type":"string","enum":["user","system"]},{"type":"null"}]},"slug":{"type":["string","null"]},"lifecycleStatus":{"anyOf":[{"type":"string","enum":["draft","published","archived"]},{"type":"null"}]},"publish":{"anyOf":[{"type":"object","properties":{"slug":{"type":["string","null"]},"publishedAt":{"type":["string","null"]},"publishedVersion":{"type":["string","null"]},"surfaces":{"anyOf":[{"type":"array","items":{"type":"string","enum":["rest","ui","agent","schedule","webhook","subapp"]}},{"type":"null"}]},"consumerAccess":{"anyOf":[{"type":"string","enum":["private","workspace","organisation","public"]},{"type":"null"}]},"embedOrigins":{"type":"array","items":{"type":"string"}},"notes":{"type":["string","null"]}}},{"type":"null"}]},"settings":{"anyOf":[{"type":"object","properties":{"description":{"type":["string","null"]},"icon":{"type":["string","null"]},"color":{"type":["string","null"]},"exposedTerminals":{"type":"array","items":{"type":"object","properties":{"moduleId":{"type":["string","null"]},"portId":{"type":["string","null"]},"widgetId":{"type":"string"},"direction":{"type":"string","enum":["in","out"]},"kind":{"type":"string","enum":["dataframe","scalar","json","text","document","image","binary","signal","event"]},"label":{"type":"string"}},"required":["widgetId","direction","kind","label"]}},"embeddablePages":{"type":"array","items":{"type":"string"}},"emittedEvents":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"payloadSchema":{"anyOf":[{"type":"object","additionalProperties":{}},{"type":"null"}]},"description":{"type":"string","default":""}},"required":["name"]}},"agent":{"type":"object","properties":{"enabled":{"type":"boolean","default":false},"instructions":{"type":"string","default":""},"tools":{"type":"array","items":{"type":"string","enum":["app_describe","app_read_terminal","app_query_indicator","app_list_flows","app_run_status","app_read_contract_object","app_read_state","app_list_links","app_explain_module","app_press_button","app_set_control","app_open_page"]},"default":["app_describe","app_read_terminal","app_query_indicator","app_list_flows","app_run_status","app_read_contract_object","app_read_state","app_list_links","app_explain_module","app_press_button","app_set_control","app_open_page"]},"canPress":{"type":"array","items":{"type":"string"},"default":[]},"knowledge":{"type":"array","items":{"type":"string"},"default":[]},"model":{"type":["string","null"],"default":null}}}}},{"type":"null"}]}},"required":["id","organisationId","name","status"]}},"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"}},"required":["type","title","status","detail"]}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"}},"required":["type","title","status","detail"]}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"}},"required":["type","title","status","detail"]}}}},"429":{"description":"Too Many Requests; the response carries Retry-After","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"}},"required":["type","title","status","detail"]}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"}},"required":["type","title","status","detail"]}}}}}},"paths":{"/api/v1/workspaces/{wsId}/applications/{id}":{"get":{"operationId":"get-api-v1-workspaces-{wsId}-applications-{id}","summary":"Get application","description":"Returns the application by id from platform MongoDB. Must belong to the workspace; deployed copies are not addressable. The builder graph, trigger and type configuration are not part of the public shape.","tags":["Applications"],"parameters":[{"name":"wsId","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter: wsId"},{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter: id"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationEnvelope"}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}}}}
```

## Delete application

> Deletes the application, its module data and any deployed copies of it. Deployed copies are not deletable on their own. This is the same deletion the workspace UI performs. Requires applications:delete and full permission.

```json
{"openapi":"3.1.0","info":{"title":"RootCause Public API","version":"1.0.0"},"tags":[{"name":"Applications"}],"servers":[{"url":"https://sandbox.rootcause.ai","description":"Sandbox"},{"url":"https://platform.rootcause.ai","description":"Production"},{"url":"http://localhost:3000","description":"Local development"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"An API key (pk_...) created on the Organisation API page, or an OAuth access token. Every operation requires one."}},"responses":{"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"}},"required":["type","title","status","detail"]}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"}},"required":["type","title","status","detail"]}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"}},"required":["type","title","status","detail"]}}}},"429":{"description":"Too Many Requests; the response carries Retry-After","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"}},"required":["type","title","status","detail"]}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"}},"required":["type","title","status","detail"]}}}}}},"paths":{"/api/v1/workspaces/{wsId}/applications/{id}":{"delete":{"operationId":"delete-api-v1-workspaces-{wsId}-applications-{id}","summary":"Delete application","description":"Deletes the application, its module data and any deployed copies of it. Deployed copies are not deletable on their own. This is the same deletion the workspace UI performs. Requires applications:delete and full permission.","tags":["Applications"],"parameters":[{"name":"wsId","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter: wsId"},{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"Path parameter: id"}],"responses":{"204":{"description":"No Content"},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"}}}}}}
```