WORKSTATION AGENT
Workstation Agent — APIs & SDK / Next Steps
12 of 12Use the secure local Agent API and TypeScript SDK to discover resources, manage connectors, execute commands and stream events.
TypeScript SDKSecure Local APIEvent-DrivenOffline AwareEnterprise Ready
Agent local API overview
| Category | Purpose | Base path | Method |
|---|---|---|---|
| Agent Discovery | Find Agent on workstation | /agent/discovery | GET |
| Connection | Open/close secure session | /agent/session | POST / DELETE |
| Pairing & Auth | Pairing code, auth and status | /agent/pairing | POST |
| Resources | Enumerate local resources | /resources | GET |
| Connectors | Manage connectors | /connectors | GET / POST / PUT / DELETE |
| Permissions | Request/manage permissions | /permissions | POST / GET |
| Commands | Execute connector commands | /commands | POST |
| Events | Stream events and results | /events/stream | GET (SSE) |
| Health & Status | Health, metrics, status | /status | GET |
| Diagnostics | Logs, support bundle | /diagnostics | POST |
| Offline Events | Queued events & sync | /offline/events | GET |
| Configuration | Agent configuration | /config | GET / PUT |
All endpoints require an active session token unless otherwise noted.
TypeScript SDK example
Connect & List ConnectorsRun CommandListen to Events
typescriptCopy
import { WorkstationAgent } from '@mediloop/agent-sdk';
const agent = new WorkstationAgent({
autodiscover: true,
requiredScopes: ['connectors:read','resources:read']
});
await agent.connect();
const connectors = await agent.connectors.list();
agent.events.on('connector:event', event => {
console.log(event);
});End-to-end flow
1
Mediloop Web App
Request
2
Workstation SDK
API call
3
Secure Agent Channel
mTLS + encryption
4
Connector Runtime
Execute
5
Local Device / System
Response
Key capabilities
Secure local communication with mTLS and session tokens
Discover and use local resources safely
Run connectors with isolated runtimes
Fine-grained permission & access control
Offline operation with queued events
Real-time event streaming
Health monitoring and diagnostics
Enterprise-ready and auditable
Error model
jsonCopy
{
"error":{
"code":"PERMISSION_DENIED",
"message":"Microphone access not granted",
"retryable":false
}
}UNAUTHORIZEDPERMISSION_DENIEDNOT_FOUNDCONFLICTRATE_LIMITEDINTERNAL_ERROR
Rate limits & quotas
Per token100 req/min
Concurrent20 requests
Burst200 req/min
Event stream1 stream/session
Payload size10 MB
Offline queue10,000 events
Next steps
Explore Connector SDK
Browse connector guides
Test in Sandbox
Deploy to Staging
Go Live
Monitor & Improve
Related guides & references
Connector SDK Reference
Clinical Devices Connectors
Dictation & Speech Connectors
Laboratory Connectors
Imaging Connectors
Healthcare Systems Connectors
You're all set
You have completed the Workstation Agent documentation. Build, integrate and deliver better local-device experiences with Mediloop.