API
Description
The API feature lets you generate secure keys for an agent and use them to call Agentic OSâs REST endpoints. With an API key, you can integrate Agentic OS into other systemsâLMS dashboards, custom analytics pipelines, or thirdâparty appsâwhile controlling access and expiration dates for security.
Target Audience
Administrator
Features
Scoped API Keys
Generate unique keys per agent, limiting access only to that agentâs data and functionality.
Custom Expiration Dates
Set a âuseâbyâ date (e.g., 30âŻdays) to minimize risk if a key is misplaced.
OneâTime Display
Keys are shown only once; you must copy and store them securely.
BuiltâIn Authorization Flow
Use the key to authorize calls in Agentic OSâs API platform (Swagger / Postman collection).
Seamless System Integration
Connect Agentic OS with learningâmanagement systems, CRMs, grading tools, and more.
How to Use (step by step)
Create an API Key
- Click the agentâs name in the header
- Select the API tab
- Choose CreateâŻNew
- Enter a descriptive name (e.g., âLMSâintegrationâAugâŻ2025â)
- Set an expiration dateâtypically one month ahead
- Click Submit
- Copy the API key that appears (it will not be shown again).
- Store it in a secure vault or environment variable
Authorize in the API Platform
- Open Agentic OSâs interactive API documentation
- Click Authorize
- Paste your copied API key and confirm
- Close the authorization dialog
Call an Endpoint
- Select any available endpoint (e.g.,
/chat,/datasets,/grades) - Review its required parameters
- Enter test values and click Execute (or use cURL / code snippets)
- Examine the JSON response to confirm success
Rotate or Revoke Keys (Optional)
- Return to the API tab to deactivate or delete keys when no longer needed
- Create new keys for different integrations to maintain granular control
Pedagogical Use Cases
LMS Grade Sync
Pull Agentic OS quiz results via API and push them into your institutionâs gradebook automatically.
Custom Analytics Dashboards
Fetch conversation counts, tool usage stats, or user progress metrics for realâtime reporting.
SingleâSignâOn (SSO) Extensions
Use the API to validate user sessions and embed Agentic OS directly inside campus portals.
Automated Enrollment
Script the creation of new agents or the assignment of users to agents each semester.
Content Management Pipelines
Upload datasets or update system prompts programmatically to keep agents in sync with new course materials.
With an API key in hand, you can seamlessly integrate Agentic OSâs capabilities into your existing systemsâextending its reach while maintaining strict security and control.