Skip to main content

Core Concepts

This page clarifies the mental model behind Supervaize and how it relates to execution engines.

Mental model

  • Supervaize is the system of record for AI-driven work. It owns business-level entities, lifecycle, and visibility.
  • Supervaizer (or n8n or other engines) is an execution engine used to run workflows on behalf of Supervaize.

Agent registration flow

Supervaizer registers the agent and server with Supervaize; the user then supplies parameter values (secrets, env) in the Supervaize UI.

Mission setup

Job execution

User starts a job and supplies field values; Supervaize creates the job context and triggers the agent. The agent creates cases and steps; human-in-the-loop steps pause until the user responds in Supervaize.

Core Supervaize concepts

Supervaizer Controller

The Supervaizer Controller is the runtime that deploys and exposes your agent to Supervaize. It provides the API, authentication, and registration layer so Supervaize can discover and call your agent.

AspectDescription
RoleHosts the agent; exposes endpoints (e.g. job_start, job_stop, job_status) and optional A2A discovery
DeploymentDeployed by the developer; the agent is reachable at SUPERVAIZER_PUBLIC_URL (or equivalent)
RegistrationWhen the controller starts, it registers the agent and its server with Supervaize so the platform can route Jobs to it

Agent

An Agent is a discoverable, executable capability that performs work on behalf of Supervaize. The developer deploys it; it is reachable at SUPERVAIZER_PUBLIC_URL. When deployed with the Supervaizer Controller, the agent (and its server) register themselves with Supervaize so the platform can invoke the agent's methods.

AspectDescription
RoleRuns Jobs; assigned to Missions
IdentityHas a unique agent ID; registered with Supervaize (e.g. via the Supervaizer Controller)
ConfigurationParameters, secrets, and methods (e.g. job_start, job_stop, job_status) are managed in Supervaize
DeploymentDeployed by the developer; reachable at SUPERVAIZER_PUBLIC_URL; with the Controller, registers itself and its server to Supervaize

Mission

A Mission is an objective or project that groups work and assigns who does it.

AspectDescription
RoleOrganizes Jobs into a logical, goal-oriented workflow; defines objectives and success criteria
IdentityIdentified by mission_id; Jobs are created and run in the context of a Mission
AssignmentHas team members, stakeholders, and one or more Agents assigned; owns business context (e.g. rating criteria, context rules)

Job

A Job is created in Supervaize and represents a business-level unit of work.

AspectDescription
OwnershipOwned and lifecycle-managed by Supervaize
IdentityIdentified by job_id
ExecutionA Job may have one or more execution attempts over time

Case

A Case is the execution run of a workflow for a given Job.

AspectDescription
DefinitionOne Case = one concrete execution of an n8n workflow
Identitycase_id is equal to the n8n execution_id
Authorityn8n is the authority for Case execution; Supervaize mirrors Case status
RelationshipA Job may have multiple Cases (retry, re-run, alternative flow)

Step

A Step is a meaningful event or action within a Case. Steps are emitted by n8n as the workflow progresses and forwarded to Supervaize.

There are two types of Steps:

TypeDescription
Informational StepsProgress updates, execution milestones, intermediate results. Do not block execution.
Human-in-the-Loop StepsRequire a human or external decision. Pause the Case execution in n8n. Are resolved in Supervaize. Resume the Case when the decision is sent back to n8n.

Supervaize events

The Supervaizer Controller (and agents) communicate with Supervaize by sending events. Event types include:

CategoryEventConstant
ServerServer registrationserver.register
AgentAgent anomalyagent.anomaly
JobJob startagent.job.start
Job start confirmationagent.job.start.confirmation
Job endagent.job.end
Job resultagent.job.result
Job erroragent.job.error
Job timeoutagent.job.timeout
CaseCase startagent.case.start
Case endagent.case.end
Case resultagent.case.result
Case updateagent.case.update
Case erroragent.case.error

Payload details and example responses are available in the supervaizer repo: mock_api_responses.py.

Summary

  • Supervaizer Controller → runtime that deploys the agent, exposes its API, and registers the agent and server with Supervaize.
  • Agent → executable capability that runs Jobs; deployed by the developer (reachable at SUPERVAIZER_PUBLIC_URL); registered and configured in Supervaize.
  • Mission → objective/project that groups Jobs and assigns Agents and team.
  • Job → business unit of work (Supervaize); belongs to a Mission, run by an Agent.
  • Case → one workflow execution for that Job (1:1 with n8n execution; n8n is execution authority).
  • Step → event/action inside a Case (informational or human-in-the-loop).

For how to create Cases, send Step updates, and handle human input from your agent code, see Application flow control.