For Admins
Vocareum GenAI Gateway allows you to efficiently add, distribute, budget, and manage your Generative Artificial Intelligence (GenAI) services. The platform provides a streamlined and secure way to handle your AI access credentials, ensuring that your keys are allocated appropriately and remain protected with optimal control and oversight.
Manage GenAI Resources for an Organization
Admin users can centrally manage all GenAI resources connected to your Vocareum organization through GenAI Gateway.
Navigate to GenAI Gateway
GenAI Gateway can only be accessed by Organization Administrators.
From the Vocareum Courses landing page, click the link labeled "Control Center," which is located above the Courses table.
Select GenAI from the sidebar menu of the Control Center.
In the GenAI section, you will find your Dashboard and GenAI Resources navigation menu.
Dashboard
The Dashboard page of the AI Gateway presents a comprehensive overview of your organization's usage and expenditure of GenAI resources. Additionally, the Dashboard provides detailed breakdowns of daily or monthly spend across various courses within your organization, allowing you to track and manage resource usage efficiently.
Services
You can add and manage API keys from your chosen service providers on the GenAI Services page. Vocareum currently supports the following services:
OpenAI
Azure
Llama
Claude
Claude Bedrock
Gemini
Nova
Custom GenAI APIs
To add a service, click the "Add Service" button, select the service type, and fill out the corresponding form.
All Service entries require an API key from your provider, a name to identify the Service within your Vocareum Organization, and an overall budget you would like applied to the key.
The forms for some service types, such as Azure and Custom GenAI APIs, also require an API URL endpoint and some details on the available models.
All Services for your Organization are listed in the API Services table below the form.
If the "Key" column contains a green checkbox, the API validation was successful for that entry and you can begin using the Service. If the "Key" column contains a red checkbox, an error occurred during validation.
The VOC Endpoint column lists the API endpoint you will use with all budgeted keys generated by Vocareum for that Service. When you send requests to the VOC Endpoint rather than directly to the service provider, Vocareum is able to enforce your chosen budgets and policies for the service.
Policies
On the GenAI Policies page, you can view and manage all Policies in your organization..
When you grant users access to GenAI resources through User Keys or Courses, you will specify a Policy. Policies apply restrictions to Services, such as limiting which models are available to users. You can also use a Policy to bundle access to models from multiple Services.
A Default Policy is automatically generated for each Service you add to GenAI Gateway. Default Policies grant access to all models available from a given Service.
You can add custom Policies by providing a Policy name and specifying which Services to include. Once that step is complete, you can add model restrictions to the Policy as needed.
Provision User Access to GenAI Resources
Once you have added a GenAI Service and set up a Policy, you can provision GenAI API keys to your users. There are 3 options for key distribution:
Groups: Provision each member in a group with their own GenAI API key.
Users: Grant an individual user a GenAI API key outside of a group or course.
Courses: Enable GenAI API key generation for a course. Users with course editing permissions can then activate GenAI for any assignment in that course. When an enrolled learner opens a GenAI-enabled assignment, the system automatically issues them their own API key for that assignment.
The following sections describe those options in more depth, common use cases for each, and include or link to setup guides.
Groups
The Group Control Center offers a streamlined solution for granting groups of users access to GenAI resources outside of a course.
This solution is ideal for cases where groups of users need access to budgeted, managed GenAI API keys, including:
Faculty or staff working on research or AI application development.
Faculty or other curriculum creators building learning applications with Vocareum Atlas.
Users creating custom AI agents using the Assistant Builder in Vocareum AI Studio.
Learners using AI Assistants in Vocareum AI Studio.
Please refer to this article for details on Using the Group Control Center for Resource Management.
Users
Courses and Groups are the most streamlined solution for granting groups of users access to GenAI resources. However, if you wish to distribute a budgeted, managed GenAI key to a single user, creating a custom User Key is a convenient alternative.
The most common use case for individual User Keys is granting access to Vocareum AI content creation tools, including Atlas and AI Studio. Users can only access these organization-level AI features if they have at least one Group or User Key (provisioned outside the context of a Vocareum Course).
Organization Admins can view and manage User Keys in the User Control Center.
Navigate to Users
From the Vocareum Courses landing page, click the link labeled "Control Center," which is located above the Courses table.
Select Users from the sidebar menu of the Control Center.
View User Keys
Organization Admins can review existing individual GenAI API keys by user on the GenAI User Keys page.
To review existing GenAI API keys for a user in your organization:
Navigate to the Users Control Center.
Click the "Lookup User" bar.
Select the user from the dropdown menu or type in the user's email address to search for them.
Review the user's active individual GenAI API keys.
(Optional) Turn on the "Show Only Deactivated" toggle to review any individual keys the user previously had that have since been deactivated by an Admin or have expired (keys deactivate automatically when their end date is reached).
Note:
Users will only appear in the Lookup User search if they have already been granted a GenAI API key through the User Control Center.
API keys provisioned through Groups or Courses will not appear in the Users Control Center.
Add New User
If a user does not yet have an individual user key in the User Control Center and you want to grant them one, you must add the user to the User Keys list before generating a key.
To add a new user, follow these steps:
Navigate to the Users Control Center.
If the User does not yet have any AI API keys outside of a Vocareum course, click the "Lookup User" bar, select "Add New User +"
Create a new user by adding their email address and an account name.
Select 'Enroll New User'
Note:
Users will only appear in the Lookup User search if they have already been granted a GenAI API key through the Users Control Center.
If you add a new user through the Users Control Center and they already have a Vocareum account associated with their email address, the existing account will be automatically associated with the new User entry.
If you add a new user through the Users Control Center and they do not already have a Vocareum account associated with their email address from a prior Group or Course enrollment, a new Vocareum account will be created for them.
Add a User Key
Once a user has been registered in the User Control Center, you can provision them with an individual key.
Select the user's name from the 'Lookup User+' bar .
Click the 'Generate User Key' button.
Add your Key Name, select the Policy to apply, the date of expiration for the key, and a budget amount.
Click 'Save'
The user will now have access to a GenAI Key, which they can use directly in code within a Vocareum lab or any other development environment with internet access. All users with individual or group GenAI API keys can also access Atlas and AI Studio in your organization's Control Center. As an Admin, you can track their key spend and control their allowed budget.
Courses
The Vocareum Notebook lab type offers a wide range of AI-enabled tools to support curriculum content creation, teaching, and learning. To use AI features within assignments, GenAI must first be enabled at the course level by an Admin.
To enable GenAI Resources for a Course:
Locate to the Course in your Courses Dashboard.
Click the Resources button in the Actions cell for your chosen Course.
In the Update Course modal that appears, scroll to the Enable Resources section.
Toggle on GenAI API Key Generation.
Select a GenAI Policy to apply to the course. This setting controls which models users can access within the course assignments.
Optional: You can set a Total Dollar Budget to apply an overall cap on spend to all users for all assignments in this course where GenAI is enabled. If this Total Dollar budget is not set, then students will be restricted to the budget set at the assignment part level while instructors will not have a specified budget limit.
Click the Update button in the Update Course modal to save your changes.
GenAI is now enabled for your course. For more details on enabling and using GenAI in assignments, refer to GenAI in Vocareum Labs.