​
Working with Gateways

Gateways are a fundamental component of Kosmoy Studio, providing a secure and controlled way to expose models, routers, and guardrails to your AI applications (Assistants and Coded Apps). They act as an intermediary, enforcing your defined access rules and ensuring that your applications interact with the Kosmoy platform in a governed manner.

​
Creating a Gateway

  1. Navigate to Gateways: From the Kosmoy Studio home page, click on the “Gateways” menu in the left-hand navigation bar.
  2. Add a New Gateway: Click the ”+ ADD” button located in the upper right corner of the Gateways section.
  3. Configure Gateway:
    • Models: Select the models you want to make available through this Gateway.
    • Routers: Select the routers you want to make available through this Gateway.
    • Guardrails: Select the guardrails you want to apply to this Gateway. These guardrails will be enforced for all traffic flowing through the Gateway.
  4. Click “Next”: Proceed to the next step.
  5. Name and Describe the Gateway: Give your Gateway a unique name and an optional description.
  6. Click “Review”: Review the Gateway configuration.
  7. Click “Create”: Create the Gateway.

​
Gateway Cards

The Gateways section displays each created Gateway as a card. Each card shows:
  • Gateway Icon: An icon depicting a router.
  • Gateway Name: The name you assigned to the Gateway.
  • Description: The description you provided for the Gateway.
  • Edit Icon (Pencil): Click this icon to update the Gateway’s name, description, or configuration (only if the Gateway is not in use).
  • Delete Icon (Trash Bin): Click this icon to remove the Gateway (only if the Gateway is not in use).

​
Gateway Usage Restrictions

You cannot edit or delete a Gateway if it is currently referenced by other entities within Kosmoy Studio. This includes being used in:
  • Assistants
  • Coded Apps
  • Any other Kosmoy Studio component that references Gateways.
Before attempting to edit or delete a Gateway, ensure it is not actively used in any of these areas. You may need to modify or remove the Gateway from those components first.

​
Updating a Gateway

You can update the configuration of a registered Gateway, including its name, description, associated models, routers, and guardrails, provided it is not currently referenced by any Assistant or Coded App.
  1. Navigate to Gateways: From the Kosmoy Studio home page, click on the “Gateways” icon in the left-hand navigation bar.
  2. Locate the Gateway Card: Find the card for the Gateway you want to update.
  3. Click the Edit (Pencil) Icon: This will open the update dialog.
  4. Modify Gateway Parameters: Update the Gateway’s configuration as needed. You can change its name, description, add or remove models, routers, and guardrails.
  5. Click “Save”: Save the changes.
If you attempt to edit a Gateway that is currently in use, a warning banner will be displayed at the top of the screen, preventing the modification.

​
Removing a Gateway

You can remove a registered Gateway if it’s no longer needed. However, you cannot delete a Gateway that is currently referenced by any Assistant or Coded App.
  1. Navigate to Gateways: From the Kosmoy Studio home page, click on the “Gateways” icon in the left-hand navigation bar.
  2. Locate the Gateway Card: Find the card for the Gateway you want to remove.
  3. Click the Delete (Trash Bin) Icon: This will trigger a confirmation prompt.
If you attempt to delete a Gateway that is currently in use, a modal will appear, preventing the deletion and explaining that the Gateway is in use.
  1. Confirm Deletion: Confirm that you want to delete the Gateway.
Warning: Deleting a Gateway is a permanent action and cannot be undone. Ensure that the Gateway is not being referenced by any Assistant or Coded App before proceeding.

​
Using Gateways

Gateways are essential for connecting your Assistants and Coded Apps to the models, routers, and guardrails you’ve configured in Kosmoy Studio.
  • When creating an Assistant or Coded App, you will be prompted to select a Gateway. This defines which resources the Assistant or Coded App can access.
This section provides a thorough overview of creating, managing, and utilizing Gateways within Kosmoy Studio.