AgentsCreate creates a new AI agent
AgentsCreate creates a new AI agent
agents/createRequest Body
application/jsonRequiredcreatedBystring
descriptionstring
disableRunRevealSystemPromptboolean
displayNamestring
enabledboolean
idstring
mcpServersarray<string>
modelstring
namestring
nextRunTimeobject
notesstring
notificationNamesarray<string>
notificationTemplatestring
parametersobject
promptstring
providerstring
riskScoreinteger
schedulestring
settingsarray<integer>
silencedUntilobject
skipPermissionsboolean
toolsarray<string>
workspaceIDstring
Success
AgentsDelete deletes an AI agent
AgentsDelete deletes an AI agent
agents/deleteQuery Parameters
idstring
Success
AgentsFacets returns the disjunctive filter-menu aggregates (status, provider counts) for the workspace agents list, given the current filter context.
AgentsFacets returns the disjunctive filter-menu aggregates (status, provider counts) for the workspace agents list, given the current filter context.
agents/facetsSuccess
AgentsGet gets a specific AI agent by ID
AgentsGet gets a specific AI agent by ID
agents/getQuery Parameters
idstring
Success
AgentsList lists AI agents for a workspace with server-side search, status / provider filtering, sort, and keyset pagination via the shared list engine.
AgentsList lists AI agents for a workspace with server-side search, status / provider filtering, sort, and keyset pagination via the shared list engine.
agents/listSuccess
AgentOneShot operation
agents/one-shotRequest Body
application/jsonRequiredadditionalContextarray<string>
basePromptstring
maxIterationsinteger
modelstring
parametersobject
providerstring
timeoutSecondsinteger
toolsarray<string>
userPromptstring
Success
AgentResourcesList returns the built-in reference documents agents can load with AgentResourcesLoad. These mirror MCP resources/list entries.
AgentResourcesList returns the built-in reference documents agents can load with AgentResourcesLoad. These mirror MCP resources/list entries.
agents/resources/listSuccess
AgentResourcesLoad returns the body of a built-in reference document. Use this from in-app agents instead of MCP resources/read.
AgentResourcesLoad returns the body of a built-in reference document. Use this from in-app agents instead of MCP resources/read.
agents/resources/loadQuery Parameters
uristring
Success
AgentsRunNow triggers an immediate execution of an agent by queuing an async task. This reuses the same async worker pipeline as scheduled runs.
AgentsRunNow triggers an immediate execution of an agent by queuing an async task. This reuses the same async worker pipeline as scheduled runs.
agents/run-nowSuccess
Success
AgentSkillsList is the UI/CRUD list endpoint. It returns the rich summary shape (metadata, no body) used to render a skills management table, with server-side search, visibility filtering, and keyset pagination through the shared list engine.
AgentSkillsList is the UI/CRUD list endpoint. It returns the rich summary shape (metadata, no body) used to render a skills management table, with server-side search, visibility filtering, and keyset pagination through the shared list engine.
This handler is intentionally NOT registered as an agent tool — agents should call AgentSkillsAgentList for the slim, visible-only view.
agents/skills/agent/listSuccess
AgentSkillsCreate inserts a new skill. WorkspaceID and CreatedBy are pulled from the request context and overwritten on the request — clients don't get to set them.
AgentSkillsCreate inserts a new skill. WorkspaceID and CreatedBy are pulled from the request context and overwritten on the request — clients don't get to set them.
agents/skills/createRequest Body
application/jsonRequiredbodystring
createdBystring
createdFromstring
descriptionstring
displayNamestring
idstring
namestring
visibleboolean
workspaceIDstring
Success
AgentSkillsDelete removes a skill by id.
AgentSkillsDelete removes a skill by id.
agents/skills/deleteQuery Parameters
idstring
Success
AgentSkillsFacets returns the filter-menu aggregates (visibility counts) for the agent-skills list, given the current filter context.
AgentSkillsFacets returns the filter-menu aggregates (visibility counts) for the agent-skills list, given the current filter context.
agents/skills/facetsSuccess
AgentSkillsGet returns the full skill (metadata + raw body) for the CRUD UI by id. Unlike Load, this does NOT filter on visible — the management UI needs to see hidden skills so they can be edited or un-hidden. When RenderBody is set, RenderedBody carries the handlebars-expanded output agents would receive from Load.
AgentSkillsGet returns the full skill (metadata + raw body) for the CRUD UI by id. Unlike Load, this does NOT filter on visible — the management UI needs to see hidden skills so they can be edited or un-hidden. When RenderBody is set, RenderedBody carries the handlebars-expanded output agents would receive from Load.
agents/skills/getSuccess
AgentSkillsSummaryList operation
agents/skills/listSuccess
AgentSkillsLoad returns the rendered skill body the agent should execute. The skill is selected by workspace-unique name. Loading is gated by the skill's visible flag so hidden skills stay genuinely off-limits even if the agent has stashed a name from elsewhere.
AgentSkillsLoad returns the rendered skill body the agent should execute. The skill is selected by workspace-unique name. Loading is gated by the skill's visible flag so hidden skills stay genuinely off-limits even if the agent has stashed a name from elsewhere.
The response only carries the body today, but lives in a struct so we can add future fields (resolved resources, expanded macros, parameter substitutions) without breaking existing callers.
agents/skills/loadQuery Parameters
namestring
Success
AgentSkillsSetVisible flips the visible flag on a skill identified by the "id" query parameter. Lives in its own endpoint (rather than reusing Update) so the UI's "hide from agents" toggle is a focused, audit-friendly call distinct from a full skill edit.
AgentSkillsSetVisible flips the visible flag on a skill identified by the "id" query parameter. Lives in its own endpoint (rather than reusing Update) so the UI's "hide from agents" toggle is a focused, audit-friendly call distinct from a full skill edit.
agents/skills/set-visibleSuccess
AgentSkillsUpdate applies a partial edit to a skill. Nil fields on the request leave the existing value alone, so the UI can PATCH just what changed.
AgentSkillsUpdate applies a partial edit to a skill. Nil fields on the request leave the existing value alone, so the UI can PATCH just what changed.
The skill ID is read from req.ID first (used by agent/MCP tool callers that send JSON bodies) and falls back to the ?id= query parameter (the existing UI client). At least one of the two must be set.
agents/skills/updateRequest Body
application/jsonRequiredbodystring
descriptionstring
displayNamestring
idstring
visibleboolean
Success
AgentSuggestFromChat operation
agents/suggest-from-chatSuccess
AgentTasksCancel operation
agents/tasks/cancelSuccess
Success
AgentTasksList operation
agents/tasks/listSuccess
AgentTemplatesList returns the curated agent definitions RunReveal installs when provisioning a workspace, so a client can offer the same set instead of its own.
AgentTemplatesList returns the curated agent definitions RunReveal installs when provisioning a workspace, so a client can offer the same set instead of its own.
Provider and model are omitted: the caller stamps whichever provider the workspace has configured.
agents/templatesSuccess
CrowdstrikeReport operation
agents/tools/get-crowdstrike-reportSuccess
VirustotalReport operation
agents/tools/get-virustotal-reportSuccess
HttpRequest operation
agents/tools/make-http-requestSuccess
AgentsUpdate updates an existing AI agent
AgentsUpdate updates an existing AI agent
agents/updateRequest Body
application/jsonRequireddescriptionstring
disableRunRevealSystemPromptboolean
displayNamestring
enabledboolean
idstring
mcpServersarray<string>
modelstring
nextRunTimeobject
notesstring
notificationNamesarray<string>
notificationTemplatestring
parametersobject
promptstring
providerstring
riskScoreinteger
schedulestring
settingsarray<integer>
skipPermissionsboolean
toolsarray<string>
Success