# ClientApi

All URIs are relative to *http://localhost:3000*

| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**apiKeysGet**](ClientApi.md#apikeysget) | **GET** /api-keys | Get all API keys for the authenticated user |
| [**apiKeysIdDelete**](ClientApi.md#apikeysiddelete) | **DELETE** /api-keys/{id} | Delete an API key |
| [**apiKeysPost**](ClientApi.md#apikeyspost) | **POST** /api-keys | Create a new API key |
| [**attachMCPServer**](ClientApi.md#attachmcpserver) | **POST** /applications/{applicationId}/mcp-servers | Attach MCP server to application |
| [**createAccount**](ClientApi.md#createaccount) | **POST** /accounts | Creates a new account |
| [**createApplication**](ClientApi.md#createapplication) | **POST** /applications | Create a new application |
| [**createMCPServer**](ClientApi.md#createmcpserver) | **POST** /mcp-servers | Create a new MCP server |
| [**createRole**](ClientApi.md#createrole) | **POST** /applications/{applicationId}/roles | Create a new role |
| [**deleteApplication**](ClientApi.md#deleteapplication) | **DELETE** /applications/{applicationId} | Delete an application |
| [**deleteMCPServer**](ClientApi.md#deletemcpserver) | **DELETE** /mcp-servers/{mcpServerId} | Delete an MCP server |
| [**deleteRole**](ClientApi.md#deleterole) | **DELETE** /applications/{applicationId}/roles/{roleId} | Delete a role |
| [**detachMCPServer**](ClientApi.md#detachmcpserver) | **DELETE** /applications/{applicationId}/mcp-servers/{mcpServerId} | Detach MCP server from application |
| [**getApplicationByID**](ClientApi.md#getapplicationbyid) | **GET** /applications/{applicationId} | Get an application by applicationId |
| [**getApplications**](ClientApi.md#getapplications) | **GET** /applications | Get all applications for the account |
| [**getAvailableMCPServersByApplication**](ClientApi.md#getavailablemcpserversbyapplication) | **GET** /applications/{applicationId}/available-mcp-servers | List available MCP servers for an application |
| [**getMCPServerStatus**](ClientApi.md#getmcpserverstatus) | **GET** /mcp-servers/{mcpServerId}/status | Get MCP server generation status |
| [**getMCPServers**](ClientApi.md#getmcpservers) | **GET** /mcp-servers | List MCP servers for account |
| [**getMCPServersByApplication**](ClientApi.md#getmcpserversbyapplication) | **GET** /applications/{applicationId}/mcp-servers | List MCP servers for an application |
| [**getRolesByApplicationId**](ClientApi.md#getrolesbyapplicationid) | **GET** /applications/{applicationId}/roles | Get all roles for a specific application |
| [**updateApplication**](ClientApi.md#updateapplication) | **PATCH** /applications/{applicationId} | Update an application |
| [**updateMCPServer**](ClientApi.md#updatemcpserver) | **PATCH** /mcp-servers/{mcpServerId} | Update an existing MCP server |
| [**updateRole**](ClientApi.md#updaterole) | **PATCH** /applications/{applicationId}/roles/{roleId} | Update a role |



## apiKeysGet

> GetAPIKeysResponseDTO apiKeysGet(page, pageSize)

Get all API keys for the authenticated user

Retrieve all API keys associated with the authenticated user\'s account with pagination.

### Example

```ts
import {
  Configuration,
  ClientApi,
} from '';
import type { ApiKeysGetRequest } from '';

async function example() {
  console.log("🚀 Testing  SDK...");
  const api = new ClientApi();

  const body = {
    // number | Page number for pagination(default: 1) (optional)
    page: 56,
    // number | Limit number of items per page (default: 10) (optional)
    pageSize: 56,
  } satisfies ApiKeysGetRequest;

  try {
    const data = await api.apiKeysGet(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **page** | `number` | Page number for pagination(default: 1) | [Optional] [Defaults to `1`] |
| **pageSize** | `number` | Limit number of items per page (default: 10) | [Optional] [Defaults to `10`] |

### Return type

[**GetAPIKeysResponseDTO**](GetAPIKeysResponseDTO.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Returns a paginated list of API keys |  -  |
| **401** | Unauthorized |  -  |
| **500** | Internal server error: Failed to retrieve API keys |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)


## apiKeysIdDelete

> apiKeysIdDelete(id)

Delete an API key

Delete a specific API key belonging to the authenticated user.

### Example

```ts
import {
  Configuration,
  ClientApi,
} from '';
import type { ApiKeysIdDeleteRequest } from '';

async function example() {
  console.log("🚀 Testing  SDK...");
  const api = new ClientApi();

  const body = {
    // string | API Key ID
    id: id_example,
  } satisfies ApiKeysIdDeleteRequest;

  try {
    const data = await api.apiKeysIdDelete(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **id** | `string` | API Key ID | [Defaults to `undefined`] |

### Return type

`void` (Empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **204** | API key deleted successfully |  -  |
| **400** | Invalid key ID format |  -  |
| **401** | Unauthorized |  -  |
| **404** | API key not found |  -  |
| **500** | Internal server error: Failed to delete API key |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)


## apiKeysPost

> CreateAPIKeyResponseDTO apiKeysPost(createAPIKeyRequestDTO)

Create a new API key

Create a new API key for accessing the RAG service.

### Example

```ts
import {
  Configuration,
  ClientApi,
} from '';
import type { ApiKeysPostRequest } from '';

async function example() {
  console.log("🚀 Testing  SDK...");
  const api = new ClientApi();

  const body = {
    // CreateAPIKeyRequestDTO | Create API Key request
    createAPIKeyRequestDTO: ...,
  } satisfies ApiKeysPostRequest;

  try {
    const data = await api.apiKeysPost(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **createAPIKeyRequestDTO** | [CreateAPIKeyRequestDTO](CreateAPIKeyRequestDTO.md) | Create API Key request | |

### Return type

[**CreateAPIKeyResponseDTO**](CreateAPIKeyResponseDTO.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: `application/json`
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **201** | Create an API key and returns the created key |  -  |
| **400** | Invalid request format |  -  |
| **401** | Unauthorized |  -  |
| **500** | Server Error: Failed to create API key |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)


## attachMCPServer

> attachMCPServer(applicationId, applicationMCPServerDTO)

Attach MCP server to application

Attach an existing MCP server to the specified application within the authenticated account

### Example

```ts
import {
  Configuration,
  ClientApi,
} from '';
import type { AttachMCPServerRequest } from '';

async function example() {
  console.log("🚀 Testing  SDK...");
  const api = new ClientApi();

  const body = {
    // string | Application ID
    applicationId: applicationId_example,
    // ApplicationMCPServerDTO | MCP Server to attach
    applicationMCPServerDTO: ...,
  } satisfies AttachMCPServerRequest;

  try {
    const data = await api.attachMCPServer(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **applicationId** | `string` | Application ID | [Defaults to `undefined`] |
| **applicationMCPServerDTO** | [ApplicationMCPServerDTO](ApplicationMCPServerDTO.md) | MCP Server to attach | |

### Return type

`void` (Empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: `application/json`
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **204** | MCP server attached successfully |  -  |
| **400** | Bad Request |  -  |
| **401** | Unauthorized |  -  |
| **500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)


## createAccount

> AccountDTO createAccount(createAccountDTO)

Creates a new account

Create an account

### Example

```ts
import {
  Configuration,
  ClientApi,
} from '';
import type { CreateAccountRequest } from '';

async function example() {
  console.log("🚀 Testing  SDK...");
  const api = new ClientApi();

  const body = {
    // CreateAccountDTO | Account creation data
    createAccountDTO: ...,
  } satisfies CreateAccountRequest;

  try {
    const data = await api.createAccount(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **createAccountDTO** | [CreateAccountDTO](CreateAccountDTO.md) | Account creation data | |

### Return type

[**AccountDTO**](AccountDTO.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: `application/json`
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **201** | Create an account and returns the created account |  -  |
| **400** | Return an error if there is a missing or invalid field |  -  |
| **401** | Return an error if the user is not authenticated |  -  |
| **403** | Return an error if the user does not have the required permissions |  -  |
| **500** | Return an error if the server finds an error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)


## createApplication

> ApplicationDTO createApplication(createApplicationDTO)

Create a new application

Create a new application for the authenticated account

### Example

```ts
import {
  Configuration,
  ClientApi,
} from '';
import type { CreateApplicationRequest } from '';

async function example() {
  console.log("🚀 Testing  SDK...");
  const api = new ClientApi();

  const body = {
    // CreateApplicationDTO | Application creation data
    createApplicationDTO: ...,
  } satisfies CreateApplicationRequest;

  try {
    const data = await api.createApplication(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **createApplicationDTO** | [CreateApplicationDTO](CreateApplicationDTO.md) | Application creation data | |

### Return type

[**ApplicationDTO**](ApplicationDTO.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: `application/json`
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **201** | Create a application and returns the created application |  -  |
| **400** | Return an error if there is a missing or invalid field |  -  |
| **401** | Return an error if the user is not authenticated |  -  |
| **403** | Return an error if the user does not have the required permissions |  -  |
| **500** | Return an error if the server founds an error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)


## createMCPServer

> MCPServerDTO createMCPServer(createMCPServerDTO)

Create a new MCP server

Create a new MCP server for the authenticated account

### Example

```ts
import {
  Configuration,
  ClientApi,
} from '';
import type { CreateMCPServerRequest } from '';

async function example() {
  console.log("🚀 Testing  SDK...");
  const api = new ClientApi();

  const body = {
    // CreateMCPServerDTO | MCP server creation data
    createMCPServerDTO: ...,
  } satisfies CreateMCPServerRequest;

  try {
    const data = await api.createMCPServer(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **createMCPServerDTO** | [CreateMCPServerDTO](CreateMCPServerDTO.md) | MCP server creation data | |

### Return type

[**MCPServerDTO**](MCPServerDTO.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: `application/json`
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **201** | Created MCP server |  -  |
| **400** | Bad Request |  -  |
| **401** | Unauthorized |  -  |
| **500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)


## createRole

> RoleDTO createRole(applicationId, createRoleDTO)

Create a new role

Create a new role for a specific application with empty permissions by default

### Example

```ts
import {
  Configuration,
  ClientApi,
} from '';
import type { CreateRoleRequest } from '';

async function example() {
  console.log("🚀 Testing  SDK...");
  const api = new ClientApi();

  const body = {
    // string | Application ID
    applicationId: applicationId_example,
    // CreateRoleDTO | Role creation data
    createRoleDTO: ...,
  } satisfies CreateRoleRequest;

  try {
    const data = await api.createRole(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **applicationId** | `string` | Application ID | [Defaults to `undefined`] |
| **createRoleDTO** | [CreateRoleDTO](CreateRoleDTO.md) | Role creation data | |

### Return type

[**RoleDTO**](RoleDTO.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: `application/json`
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **201** | Created role |  -  |
| **400** | Return an error if there is a missing or invalid field |  -  |
| **500** | Return an error if the server finds an error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)


## deleteApplication

> deleteApplication(applicationId)

Delete an application

Delete an application belonging to the authenticated account

### Example

```ts
import {
  Configuration,
  ClientApi,
} from '';
import type { DeleteApplicationRequest } from '';

async function example() {
  console.log("🚀 Testing  SDK...");
  const api = new ClientApi();

  const body = {
    // string | Application ID
    applicationId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
  } satisfies DeleteApplicationRequest;

  try {
    const data = await api.deleteApplication(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **applicationId** | `string` | Application ID | [Defaults to `undefined`] |

### Return type

`void` (Empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **204** | Application deleted |  -  |
| **400** | Return an error if provided ID is not a valid UUID |  -  |
| **401** | Return an error if the user is not authenticated |  -  |
| **403** | Return an error if the user does not have the required permissions |  -  |
| **500** | Return an error if the server founds an error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)


## deleteMCPServer

> deleteMCPServer(mcpServerId)

Delete an MCP server

Delete an MCP server from the authenticated account

### Example

```ts
import {
  Configuration,
  ClientApi,
} from '';
import type { DeleteMCPServerRequest } from '';

async function example() {
  console.log("🚀 Testing  SDK...");
  const api = new ClientApi();

  const body = {
    // string | MCP Server ID
    mcpServerId: mcpServerId_example,
  } satisfies DeleteMCPServerRequest;

  try {
    const data = await api.deleteMCPServer(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **mcpServerId** | `string` | MCP Server ID | [Defaults to `undefined`] |

### Return type

`void` (Empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **204** | No content |  -  |
| **400** | Bad Request |  -  |
| **401** | Unauthorized |  -  |
| **500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)


## deleteRole

> deleteRole(applicationId, roleId)

Delete a role

Delete a specific role by ID

### Example

```ts
import {
  Configuration,
  ClientApi,
} from '';
import type { DeleteRoleRequest } from '';

async function example() {
  console.log("🚀 Testing  SDK...");
  const api = new ClientApi();

  const body = {
    // string | Application ID
    applicationId: applicationId_example,
    // string | Role ID
    roleId: roleId_example,
  } satisfies DeleteRoleRequest;

  try {
    const data = await api.deleteRole(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **applicationId** | `string` | Application ID | [Defaults to `undefined`] |
| **roleId** | `string` | Role ID | [Defaults to `undefined`] |

### Return type

`void` (Empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **204** | Role deleted successfully |  -  |
| **400** | Return an error if roleId is invalid |  -  |
| **404** | Return an error if role not found |  -  |
| **500** | Return an error if the server finds an error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)


## detachMCPServer

> detachMCPServer(applicationId, mcpServerId)

Detach MCP server from application

Detach an existing MCP server from the specified application within the authenticated account

### Example

```ts
import {
  Configuration,
  ClientApi,
} from '';
import type { DetachMCPServerRequest } from '';

async function example() {
  console.log("🚀 Testing  SDK...");
  const api = new ClientApi();

  const body = {
    // string | Application ID
    applicationId: applicationId_example,
    // string | MCP Server ID
    mcpServerId: mcpServerId_example,
  } satisfies DetachMCPServerRequest;

  try {
    const data = await api.detachMCPServer(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **applicationId** | `string` | Application ID | [Defaults to `undefined`] |
| **mcpServerId** | `string` | MCP Server ID | [Defaults to `undefined`] |

### Return type

`void` (Empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **204** | MCP server detached successfully |  -  |
| **400** | Bad Request |  -  |
| **401** | Unauthorized |  -  |
| **500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)


## getApplicationByID

> ApplicationDTO getApplicationByID(applicationId)

Get an application by applicationId

Get a specific application belonging to the authenticated account

### Example

```ts
import {
  Configuration,
  ClientApi,
} from '';
import type { GetApplicationByIDRequest } from '';

async function example() {
  console.log("🚀 Testing  SDK...");
  const api = new ClientApi();

  const body = {
    // string | Application ID
    applicationId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
  } satisfies GetApplicationByIDRequest;

  try {
    const data = await api.getApplicationByID(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **applicationId** | `string` | Application ID | [Defaults to `undefined`] |

### Return type

[**ApplicationDTO**](ApplicationDTO.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Return an application |  -  |
| **400** | Return an error if provided ID is not a valid UUID |  -  |
| **401** | Return an error if the user is not authenticated |  -  |
| **403** | Return an error if the user does not have the required permissions |  -  |
| **404** | Return an error if the application is not found |  -  |
| **500** | Return an error if the server founds an error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)


## getApplications

> PaginatedApplicationsDTO getApplications(page, pageSize)

Get all applications for the account

Get all applications belonging to the authenticated account

### Example

```ts
import {
  Configuration,
  ClientApi,
} from '';
import type { GetApplicationsRequest } from '';

async function example() {
  console.log("🚀 Testing  SDK...");
  const api = new ClientApi();

  const body = {
    // number | Page number for pagination (optional)
    page: 56,
    // number | Limit number of items per page (optional)
    pageSize: 56,
  } satisfies GetApplicationsRequest;

  try {
    const data = await api.getApplications(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **page** | `number` | Page number for pagination | [Optional] [Defaults to `1`] |
| **pageSize** | `number` | Limit number of items per page | [Optional] [Defaults to `10`] |

### Return type

[**PaginatedApplicationsDTO**](PaginatedApplicationsDTO.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Return a list of applications |  -  |
| **401** | Return an error if the user is not authenticated |  -  |
| **403** | Return an error if the user does not have the required permissions |  -  |
| **500** | Return an error if the server founds an error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)


## getAvailableMCPServersByApplication

> PaginatedMCPServerDTO getAvailableMCPServersByApplication(applicationId, page, pageSize)

List available MCP servers for an application

Get all MCP servers in the account that are NOT attached to a specific application

### Example

```ts
import {
  Configuration,
  ClientApi,
} from '';
import type { GetAvailableMCPServersByApplicationRequest } from '';

async function example() {
  console.log("🚀 Testing  SDK...");
  const api = new ClientApi();

  const body = {
    // string | Application ID
    applicationId: applicationId_example,
    // number | Page number (optional)
    page: 56,
    // number | Page size (optional)
    pageSize: 56,
  } satisfies GetAvailableMCPServersByApplicationRequest;

  try {
    const data = await api.getAvailableMCPServersByApplication(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **applicationId** | `string` | Application ID | [Defaults to `undefined`] |
| **page** | `number` | Page number | [Optional] [Defaults to `1`] |
| **pageSize** | `number` | Page size | [Optional] [Defaults to `10`] |

### Return type

[**PaginatedMCPServerDTO**](PaginatedMCPServerDTO.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | List of available MCP servers |  -  |
| **400** | Bad Request |  -  |
| **401** | Unauthorized |  -  |
| **404** | Not Found |  -  |
| **500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)


## getMCPServerStatus

> MCPServerStatusDTO getMCPServerStatus(mcpServerId)

Get MCP server generation status

Get the pipeline status of a generated MCP server

### Example

```ts
import {
  Configuration,
  ClientApi,
} from '';
import type { GetMCPServerStatusRequest } from '';

async function example() {
  console.log("🚀 Testing  SDK...");
  const api = new ClientApi();

  const body = {
    // string | MCP Server ID
    mcpServerId: mcpServerId_example,
  } satisfies GetMCPServerStatusRequest;

  try {
    const data = await api.getMCPServerStatus(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **mcpServerId** | `string` | MCP Server ID | [Defaults to `undefined`] |

### Return type

[**MCPServerStatusDTO**](MCPServerStatusDTO.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | MCP server with status |  -  |
| **400** | Bad Request |  -  |
| **401** | Unauthorized |  -  |
| **404** | Not Found |  -  |
| **500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)


## getMCPServers

> PaginatedMCPServerDTO getMCPServers(page, pageSize)

List MCP servers for account

Get all MCP servers attached to any application within the authenticated account

### Example

```ts
import {
  Configuration,
  ClientApi,
} from '';
import type { GetMCPServersRequest } from '';

async function example() {
  console.log("🚀 Testing  SDK...");
  const api = new ClientApi();

  const body = {
    // number | Page number (optional)
    page: 56,
    // number | Page size (optional)
    pageSize: 56,
  } satisfies GetMCPServersRequest;

  try {
    const data = await api.getMCPServers(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **page** | `number` | Page number | [Optional] [Defaults to `1`] |
| **pageSize** | `number` | Page size | [Optional] [Defaults to `10`] |

### Return type

[**PaginatedMCPServerDTO**](PaginatedMCPServerDTO.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | List of MCP servers |  -  |
| **401** | Unauthorized |  -  |
| **500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)


## getMCPServersByApplication

> PaginatedMCPServerDTO getMCPServersByApplication(applicationId, page, pageSize)

List MCP servers for an application

Get all MCP servers attached to a specific application

### Example

```ts
import {
  Configuration,
  ClientApi,
} from '';
import type { GetMCPServersByApplicationRequest } from '';

async function example() {
  console.log("🚀 Testing  SDK...");
  const api = new ClientApi();

  const body = {
    // string | Application ID
    applicationId: applicationId_example,
    // number | Page number (optional)
    page: 56,
    // number | Page size (optional)
    pageSize: 56,
  } satisfies GetMCPServersByApplicationRequest;

  try {
    const data = await api.getMCPServersByApplication(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **applicationId** | `string` | Application ID | [Defaults to `undefined`] |
| **page** | `number` | Page number | [Optional] [Defaults to `1`] |
| **pageSize** | `number` | Page size | [Optional] [Defaults to `10`] |

### Return type

[**PaginatedMCPServerDTO**](PaginatedMCPServerDTO.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | List of MCP servers |  -  |
| **400** | Bad Request |  -  |
| **401** | Unauthorized |  -  |
| **404** | Not Found |  -  |
| **500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)


## getRolesByApplicationId

> PaginatedRoleDTO getRolesByApplicationId(applicationId, page, pageSize)

Get all roles for a specific application

Retrieve all roles associated with a specific application

### Example

```ts
import {
  Configuration,
  ClientApi,
} from '';
import type { GetRolesByApplicationIdRequest } from '';

async function example() {
  console.log("🚀 Testing  SDK...");
  const api = new ClientApi();

  const body = {
    // string | Application ID
    applicationId: applicationId_example,
    // number | Page number (optional)
    page: 56,
    // number | Page size (optional)
    pageSize: 56,
  } satisfies GetRolesByApplicationIdRequest;

  try {
    const data = await api.getRolesByApplicationId(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **applicationId** | `string` | Application ID | [Defaults to `undefined`] |
| **page** | `number` | Page number | [Optional] [Defaults to `1`] |
| **pageSize** | `number` | Page size | [Optional] [Defaults to `10`] |

### Return type

[**PaginatedRoleDTO**](PaginatedRoleDTO.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | List of roles |  -  |
| **400** | Return an error if applicationId is missing or invalid |  -  |
| **500** | Return an error if the server finds an error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)


## updateApplication

> ApplicationDTO updateApplication(applicationId, updateApplicationDTO)

Update an application

Update an application belonging to the authenticated account

### Example

```ts
import {
  Configuration,
  ClientApi,
} from '';
import type { UpdateApplicationRequest } from '';

async function example() {
  console.log("🚀 Testing  SDK...");
  const api = new ClientApi();

  const body = {
    // string | Application ID
    applicationId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
    // UpdateApplicationDTO | Application update data
    updateApplicationDTO: ...,
  } satisfies UpdateApplicationRequest;

  try {
    const data = await api.updateApplication(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **applicationId** | `string` | Application ID | [Defaults to `undefined`] |
| **updateApplicationDTO** | [UpdateApplicationDTO](UpdateApplicationDTO.md) | Application update data | |

### Return type

[**ApplicationDTO**](ApplicationDTO.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: `application/json`
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Updates an application and return an updated application if the ID exists |  -  |
| **400** | Return an error if provided RagApiKey is not a valid |  -  |
| **401** | Return an error if the user is not authenticated |  -  |
| **403** | Return an error if the user does not have the required permissions |  -  |
| **404** | Return an error if the application is not found |  -  |
| **500** | Return an error if the server founds an error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)


## updateMCPServer

> MCPServerDTO updateMCPServer(mcpServerId, updateMCPServerDTO)

Update an existing MCP server

Update an existing MCP server for the authenticated account

### Example

```ts
import {
  Configuration,
  ClientApi,
} from '';
import type { UpdateMCPServerRequest } from '';

async function example() {
  console.log("🚀 Testing  SDK...");
  const api = new ClientApi();

  const body = {
    // string | MCP Server ID
    mcpServerId: mcpServerId_example,
    // UpdateMCPServerDTO | MCP server update data
    updateMCPServerDTO: ...,
  } satisfies UpdateMCPServerRequest;

  try {
    const data = await api.updateMCPServer(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **mcpServerId** | `string` | MCP Server ID | [Defaults to `undefined`] |
| **updateMCPServerDTO** | [UpdateMCPServerDTO](UpdateMCPServerDTO.md) | MCP server update data | |

### Return type

[**MCPServerDTO**](MCPServerDTO.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: `application/json`
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Updated MCP server |  -  |
| **400** | Bad Request |  -  |
| **401** | Unauthorized |  -  |
| **500** | Internal Server Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)


## updateRole

> RoleDTO updateRole(applicationId, roleId, updateRoleDTO)

Update a role

Update a role\'s name and/or permissions

### Example

```ts
import {
  Configuration,
  ClientApi,
} from '';
import type { UpdateRoleRequest } from '';

async function example() {
  console.log("🚀 Testing  SDK...");
  const api = new ClientApi();

  const body = {
    // string | Application ID
    applicationId: applicationId_example,
    // string | Role ID
    roleId: roleId_example,
    // UpdateRoleDTO | Role update data
    updateRoleDTO: ...,
  } satisfies UpdateRoleRequest;

  try {
    const data = await api.updateRole(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **applicationId** | `string` | Application ID | [Defaults to `undefined`] |
| **roleId** | `string` | Role ID | [Defaults to `undefined`] |
| **updateRoleDTO** | [UpdateRoleDTO](UpdateRoleDTO.md) | Role update data | |

### Return type

[**RoleDTO**](RoleDTO.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: `application/json`
- **Accept**: `application/json`


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Updated role |  -  |
| **400** | Return an error if there is a missing or invalid field |  -  |
| **404** | Return an error if role not found |  -  |
| **500** | Return an error if the server finds an error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)