> For the complete documentation index, see [llms.txt](https://navixy.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://navixy.com/docs/navixy-api/user-api/backend-api/resources/commons/user/applications/models.md).

# Models

## The SuccessResponse object

```json
{"openapi":"3.1.0","info":{"title":"User Applications API","version":"1.0.0"},"components":{"schemas":{"SuccessResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Operation success status"}}}}}}
```

## The ErrorResponse object

```json
{"openapi":"3.1.0","info":{"title":"User Applications API","version":"1.0.0"},"components":{"schemas":{"ErrorResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Operation failed status"},"error":{"type":"object","properties":{"code":{"type":"integer","description":"Error code"},"message":{"type":"string","description":"Error message"}}}}}}}}
```

## The ApiKeyAuthorization object

```json
{"openapi":"3.1.0","info":{"title":"User Applications API","version":"1.0.0"},"components":{"schemas":{"ApiKeyAuthorization":{"type":"object","required":["type","hash"],"properties":{"type":{"type":"string","description":"Authorization type identifier","enum":["api_key"]},"hash":{"type":"string","description":"An API key hash"}}}}}}
```

## The UserSessionAuthorization object

```json
{"openapi":"3.1.0","info":{"title":"User Applications API","version":"1.0.0"},"components":{"schemas":{"UserSessionAuthorization":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Authorization type identifier","enum":["user_session"]}}}}}}
```

## The ApplicationAuthorization object

```json
{"openapi":"3.1.0","info":{"title":"User Applications API","version":"1.0.0"},"components":{"schemas":{"ApplicationAuthorization":{"oneOf":[{"$ref":"#/components/schemas/ApiKeyAuthorization"},{"$ref":"#/components/schemas/UserSessionAuthorization"}]},"ApiKeyAuthorization":{"type":"object","required":["type","hash"],"properties":{"type":{"type":"string","description":"Authorization type identifier","enum":["api_key"]},"hash":{"type":"string","description":"An API key hash"}}},"UserSessionAuthorization":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Authorization type identifier","enum":["user_session"]}}}}}}
```

## The Application object

```json
{"openapi":"3.1.0","info":{"title":"User Applications API","version":"1.0.0"},"components":{"schemas":{"Application":{"type":"object","required":["id","label","url_template"],"properties":{"id":{"type":"integer","description":"Application's ID"},"label":{"type":"string","description":"Application's name"},"url_template":{"type":"string","description":"URL template (including variables)"},"enabled":{"type":"boolean","description":"Determines visibility in the users' side menu","default":true},"authorization":{"$ref":"#/components/schemas/ApplicationAuthorization","description":"Authorization that will be used while accessing the URL"},"display_method":{"type":"string","description":"Determines how the application will be opened","enum":["new_tab","embedded"],"default":"new_tab"},"icon":{"type":"string","description":"Application's icon identifier","default":"extension"},"description":{"type":"string","description":"Longer plain text description is shown to users","default":""}}},"ApplicationAuthorization":{"oneOf":[{"$ref":"#/components/schemas/ApiKeyAuthorization"},{"$ref":"#/components/schemas/UserSessionAuthorization"}]},"ApiKeyAuthorization":{"type":"object","required":["type","hash"],"properties":{"type":{"type":"string","description":"Authorization type identifier","enum":["api_key"]},"hash":{"type":"string","description":"An API key hash"}}},"UserSessionAuthorization":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Authorization type identifier","enum":["user_session"]}}}}}}
```

## The CreateApplicationRequest object

```json
{"openapi":"3.1.0","info":{"title":"User Applications API","version":"1.0.0"},"components":{"schemas":{"CreateApplicationRequest":{"type":"object","required":["label","url_template"],"properties":{"label":{"type":"string","description":"Application's name"},"url_template":{"type":"string","description":"URL template (including variables)"},"authorization":{"$ref":"#/components/schemas/ApplicationAuthorization","description":"Authorization that will be used while accessing the URL"},"display_method":{"type":"string","description":"Determines how the application will be opened","enum":["new_tab","embedded"],"default":"new_tab"},"icon":{"type":"string","description":"Application's icon identifier","default":"extension"},"description":{"type":"string","description":"Longer plain text description is shown to users","default":""}}},"ApplicationAuthorization":{"oneOf":[{"$ref":"#/components/schemas/ApiKeyAuthorization"},{"$ref":"#/components/schemas/UserSessionAuthorization"}]},"ApiKeyAuthorization":{"type":"object","required":["type","hash"],"properties":{"type":{"type":"string","description":"Authorization type identifier","enum":["api_key"]},"hash":{"type":"string","description":"An API key hash"}}},"UserSessionAuthorization":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Authorization type identifier","enum":["user_session"]}}}}}}
```

## The ApplicationListResponse object

```json
{"openapi":"3.1.0","info":{"title":"User Applications API","version":"1.0.0"},"components":{"schemas":{"ApplicationListResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Operation success status"},"list":{"type":"array","description":"List of applications","items":{"$ref":"#/components/schemas/Application"}}}},"Application":{"type":"object","required":["id","label","url_template"],"properties":{"id":{"type":"integer","description":"Application's ID"},"label":{"type":"string","description":"Application's name"},"url_template":{"type":"string","description":"URL template (including variables)"},"enabled":{"type":"boolean","description":"Determines visibility in the users' side menu","default":true},"authorization":{"$ref":"#/components/schemas/ApplicationAuthorization","description":"Authorization that will be used while accessing the URL"},"display_method":{"type":"string","description":"Determines how the application will be opened","enum":["new_tab","embedded"],"default":"new_tab"},"icon":{"type":"string","description":"Application's icon identifier","default":"extension"},"description":{"type":"string","description":"Longer plain text description is shown to users","default":""}}},"ApplicationAuthorization":{"oneOf":[{"$ref":"#/components/schemas/ApiKeyAuthorization"},{"$ref":"#/components/schemas/UserSessionAuthorization"}]},"ApiKeyAuthorization":{"type":"object","required":["type","hash"],"properties":{"type":{"type":"string","description":"Authorization type identifier","enum":["api_key"]},"hash":{"type":"string","description":"An API key hash"}}},"UserSessionAuthorization":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"Authorization type identifier","enum":["user_session"]}}}}}}
```

## The CreateApplicationResponse object

```json
{"openapi":"3.1.0","info":{"title":"User Applications API","version":"1.0.0"},"components":{"schemas":{"CreateApplicationResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Operation success status"},"id":{"type":"integer","description":"Unique ID of the created application"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://navixy.com/docs/navixy-api/user-api/backend-api/resources/commons/user/applications/models.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.