Jump to docs section
Documentation
Deployment notes, control surfaces, and implementation detail
API reference
The Agents API exposes the control surfaces you actually need in operations.
Use the API to inspect employee state, trigger runs, review history, and layer Nodebase into your own systems or dashboards.
Style
Operational API
Focus
Control and observability
Typical use
Dashboards and orchestration
Common operations
List employees
Enumerate available employees and their runtime state for a tenant or workspace.
Trigger a run
Kick off a task with explicit input and business context when a system event occurs.
Inspect history
Read event and conversation history for audit, debugging, or reporting surfaces.
Example request shape
Multimodal run request
POST /v1/agents/{agent_id}/run
{
"input": "Guest uploaded an ID document.",
"attachments": [{ "type": "image", "url": "https://..." }],
"context": {
"booking_reference": "NB-4107",
"require_kyc": true
},
"mode": "policy_enforced"
}Implementation notes
- Treat the API as a control surface, not as a replacement for good workflow configuration.
- Use event history to build support tooling and audit trails rather than scraping UI behavior.
- Always model approval-sensitive actions explicitly in your consuming system.
Use the API when you need your own controls around employee execution.
If you are wiring channels, scheduling, or payments directly, read the integrations guide next.