RunReveal

AgentsCreate creates a new AI agent

AgentsCreate creates a new AI agent

POST
/agents/create

Request Body

application/jsonRequired

createdBystring

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

curl -X POST "https://api.runreveal.com/agents/create" \
  -H "Content-Type: application/json" \
  -d '{
    "createdBy": "string",
    "description": "string",
    "disableRunRevealSystemPrompt": true,
    "displayName": "string",
    "enabled": true,
    "id": "string",
    "mcpServers": [
      "string"
    ],
    "model": "string",
    "name": "string",
    "nextRunTime": {},
    "notes": "string",
    "notificationNames": [
      "string"
    ],
    "notificationTemplate": "string",
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "prompt": "string",
    "provider": "string",
    "riskScore": 0,
    "schedule": "string",
    "settings": [
      0
    ],
    "silencedUntil": {},
    "skipPermissions": true,
    "tools": [
      "string"
    ],
    "workspaceID": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "createdAt": {},
    "createdBy": "string",
    "description": "string",
    "disableRunRevealSystemPrompt": true,
    "displayName": "string",
    "enabled": true,
    "id": "string",
    "mcpServers": [
      "string"
    ],
    "model": "string",
    "name": "string",
    "nextRunTime": {},
    "notes": "string",
    "notificationNames": [
      "string"
    ],
    "notificationTemplate": "string",
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "previousRunTime": {},
    "prompt": "string",
    "provider": "string",
    "riskScore": 0,
    "roleID": "string",
    "schedule": "string",
    "settings": [
      0
    ],
    "silencedUntil": {},
    "skipPermissions": true,
    "tools": [
      "string"
    ],
    "updatedAt": {},
    "workspaceID": "string"
  },
  "success": true
}

AgentsDelete deletes an AI agent

AgentsDelete deletes an AI agent

DELETE
/agents/delete
curl -X DELETE "https://api.runreveal.com/agents/delete?id=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": "string",
  "success": true
}

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.

GET
/agents/facets
curl -X GET "https://api.runreveal.com/agents/facets"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "buckets": {
      "property1": [
        {
          "count": 0,
          "label": "string",
          "value": "string"
        }
      ],
      "property2": [
        {
          "count": 0,
          "label": "string",
          "value": "string"
        }
      ]
    }
  },
  "success": true
}

AgentsGet gets a specific AI agent by ID

AgentsGet gets a specific AI agent by ID

GET
/agents/get
curl -X GET "https://api.runreveal.com/agents/get?id=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "createdAt": {},
    "createdBy": "string",
    "description": "string",
    "disableRunRevealSystemPrompt": true,
    "displayName": "string",
    "enabled": true,
    "id": "string",
    "mcpServers": [
      "string"
    ],
    "model": "string",
    "name": "string",
    "nextRunTime": {},
    "notes": "string",
    "notificationNames": [
      "string"
    ],
    "notificationTemplate": "string",
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "previousRunTime": {},
    "prompt": "string",
    "provider": "string",
    "riskScore": 0,
    "roleID": "string",
    "schedule": "string",
    "settings": [
      0
    ],
    "silencedUntil": {},
    "skipPermissions": true,
    "tools": [
      "string"
    ],
    "updatedAt": {},
    "workspaceID": "string"
  },
  "success": true
}

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.

GET
/agents/list
curl -X GET "https://api.runreveal.com/agents/list"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": [
    {
      "createdAt": {},
      "createdBy": "string",
      "description": "string",
      "disableRunRevealSystemPrompt": true,
      "displayName": "string",
      "enabled": true,
      "id": "string",
      "mcpServers": [
        "string"
      ],
      "model": "string",
      "name": "string",
      "nextRunTime": {},
      "notes": "string",
      "notificationNames": [
        "string"
      ],
      "notificationTemplate": "string",
      "parameters": {
        "property1": "string",
        "property2": "string"
      },
      "previousRunTime": {},
      "prompt": "string",
      "provider": "string",
      "riskScore": 0,
      "roleID": "string",
      "schedule": "string",
      "settings": [
        0
      ],
      "silencedUntil": {},
      "skipPermissions": true,
      "tools": [
        "string"
      ],
      "updatedAt": {},
      "workspaceID": "string"
    }
  ],
  "success": true
}

AgentOneShot operation

POST
/agents/one-shot

Request Body

application/jsonRequired

additionalContextarray<string>

basePromptstring

maxIterationsinteger

modelstring

parametersobject

providerstring

timeoutSecondsinteger

toolsarray<string>

userPromptstring

curl -X POST "https://api.runreveal.com/agents/one-shot" \
  -H "Content-Type: application/json" \
  -d '{
    "additionalContext": [
      "string"
    ],
    "basePrompt": "string",
    "maxIterations": 0,
    "model": "string",
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "provider": "string",
    "timeoutSeconds": 0,
    "tools": [
      "string"
    ],
    "userPrompt": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "completed": true,
    "error": "string",
    "finalResponse": "string",
    "summary": "string",
    "toolCalls": [
      {
        "arguments": [
          0
        ],
        "durationMs": 0,
        "error": "string",
        "result": [
          0
        ],
        "toolName": "string"
      }
    ]
  },
  "success": true
}

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.

GET
/agents/resources/list
curl -X GET "https://api.runreveal.com/agents/resources/list"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "resources": [
      {
        "description": "string",
        "name": "string",
        "uri": "string"
      }
    ]
  },
  "success": true
}

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.

GET
/agents/resources/load
curl -X GET "https://api.runreveal.com/agents/resources/load?uri=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "body": "string",
    "uri": "string"
  },
  "success": true
}

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.

POST
/agents/run-now

Request Body

application/jsonRequired

idstring

curl -X POST "https://api.runreveal.com/agents/run-now" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "chatID": "string",
    "taskID": "string"
  },
  "success": true
}

AgentsSilence silences an AI agent

AgentsSilence silences an AI agent

PUT
/agents/silence

Request Body

application/jsonRequired

idstring

silencedUntilobject

curl -X PUT "https://api.runreveal.com/agents/silence" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string",
    "silencedUntil": {}
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": "string",
  "success": true
}

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.

GET
/agents/skills/agent/list

Query Parameters

cursorstring

limitstring

curl -X GET "https://api.runreveal.com/agents/skills/agent/list?cursor=string&limit=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": [
    {
      "description": "string",
      "name": "string"
    }
  ],
  "success": true
}

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.

POST
/agents/skills/create

Request Body

application/jsonRequired

bodystring

createdBystring

createdFromstring

descriptionstring

displayNamestring

idstring

namestring

visibleboolean

workspaceIDstring

curl -X POST "https://api.runreveal.com/agents/skills/create" \
  -H "Content-Type: application/json" \
  -d '{
    "body": "string",
    "createdBy": "string",
    "createdFrom": "string",
    "description": "string",
    "displayName": "string",
    "id": "string",
    "name": "string",
    "visible": true,
    "workspaceID": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "body": "string",
    "createdAt": {},
    "createdBy": "string",
    "createdFrom": "string",
    "description": "string",
    "displayName": "string",
    "id": "string",
    "name": "string",
    "renderedBody": "string",
    "updatedAt": {},
    "visible": true,
    "workspaceID": "string"
  },
  "success": true
}

AgentSkillsDelete removes a skill by id.

AgentSkillsDelete removes a skill by id.

DELETE
/agents/skills/delete
curl -X DELETE "https://api.runreveal.com/agents/skills/delete?id=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {},
  "success": true
}

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.

GET
/agents/skills/facets

Query Parameters

cursorstring

limitstring

searchstring

showHiddenboolean

curl -X GET "https://api.runreveal.com/agents/skills/facets?cursor=string&limit=string&search=string&showHidden=true"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "buckets": {
      "property1": [
        {
          "count": 0,
          "label": "string",
          "value": "string"
        }
      ],
      "property2": [
        {
          "count": 0,
          "label": "string",
          "value": "string"
        }
      ]
    }
  },
  "success": true
}

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.

GET
/agents/skills/get

Query Parameters

idstring

renderBodyboolean

curl -X GET "https://api.runreveal.com/agents/skills/get?id=string&renderBody=true"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "body": "string",
    "createdAt": {},
    "createdBy": "string",
    "createdFrom": "string",
    "description": "string",
    "displayName": "string",
    "id": "string",
    "name": "string",
    "renderedBody": "string",
    "updatedAt": {},
    "visible": true,
    "workspaceID": "string"
  },
  "success": true
}

AgentSkillsSummaryList operation

GET
/agents/skills/list

Query Parameters

cursorstring

limitstring

searchstring

showHiddenboolean

curl -X GET "https://api.runreveal.com/agents/skills/list?cursor=string&limit=string&search=string&showHidden=true"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": [
    {
      "createdAt": {},
      "createdBy": "string",
      "createdFrom": "string",
      "description": "string",
      "displayName": "string",
      "id": "string",
      "name": "string",
      "updatedAt": {},
      "visible": true,
      "workspaceID": "string"
    }
  ],
  "success": true
}

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.

GET
/agents/skills/load
curl -X GET "https://api.runreveal.com/agents/skills/load?name=string"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "body": "string",
    "name": "string"
  },
  "success": true
}

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.

PUT
/agents/skills/set-visible

Request Body

application/jsonRequired

visibleboolean

curl -X PUT "https://api.runreveal.com/agents/skills/set-visible" \
  -H "Content-Type: application/json" \
  -d '{
    "visible": true
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "body": "string",
    "createdAt": {},
    "createdBy": "string",
    "createdFrom": "string",
    "description": "string",
    "displayName": "string",
    "id": "string",
    "name": "string",
    "renderedBody": "string",
    "updatedAt": {},
    "visible": true,
    "workspaceID": "string"
  },
  "success": true
}

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.

PUT
/agents/skills/update

Request Body

application/jsonRequired

bodystring

descriptionstring

displayNamestring

idstring

visibleboolean

curl -X PUT "https://api.runreveal.com/agents/skills/update" \
  -H "Content-Type: application/json" \
  -d '{
    "body": "string",
    "description": "string",
    "displayName": "string",
    "id": "string",
    "visible": true
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "body": "string",
    "createdAt": {},
    "createdBy": "string",
    "createdFrom": "string",
    "description": "string",
    "displayName": "string",
    "id": "string",
    "name": "string",
    "renderedBody": "string",
    "updatedAt": {},
    "visible": true,
    "workspaceID": "string"
  },
  "success": true
}

AgentSuggestFromChat operation

POST
/agents/suggest-from-chat

Request Body

application/jsonRequired

chatIDstring

modelstring

providerstring

curl -X POST "https://api.runreveal.com/agents/suggest-from-chat" \
  -H "Content-Type: application/json" \
  -d '{
    "chatID": "string",
    "model": "string",
    "provider": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "prompt": "string",
    "schedule": "string",
    "title": "string"
  },
  "success": true
}

AgentTasksCancel operation

POST
/agents/tasks/cancel

Request Body

application/jsonRequired

taskIDsarray<string>

curl -X POST "https://api.runreveal.com/agents/tasks/cancel" \
  -H "Content-Type: application/json" \
  -d '{
    "taskIDs": [
      "string"
    ]
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "cancelledCount": 0
  },
  "success": true
}

AgentTasksCancelAll operation

POST
/agents/tasks/cancel-all

Request Body

application/jsonRequired
curl -X POST "https://api.runreveal.com/agents/tasks/cancel-all" \
  -H "Content-Type: application/json" \
  -d '{}'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "cancelledCount": 0
  },
  "success": true
}

AgentTasksList operation

GET
/agents/tasks/list
curl -X GET "https://api.runreveal.com/agents/tasks/list"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "next": "string",
    "prev": "string",
    "statusCounts": {
      "property1": 0,
      "property2": 0
    },
    "values": [
      {
        "agentConfigID": "string",
        "agentName": "string",
        "createdAt": {},
        "detectionName": "string",
        "id": "string",
        "investigationID": "string",
        "status": "string",
        "visibleAfter": {}
      }
    ]
  },
  "success": true
}

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.

GET
/agents/templates
curl -X GET "https://api.runreveal.com/agents/templates"

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "templates": [
      {
        "description": "string",
        "displayName": "string",
        "name": "string",
        "notificationNames": [
          "string"
        ],
        "prompt": "string",
        "riskScore": 0,
        "schedule": "string",
        "skipPermissions": true,
        "tools": [
          "string"
        ]
      }
    ]
  },
  "success": true
}

CrowdstrikeReport operation

POST
/agents/tools/get-crowdstrike-report

Request Body

application/jsonRequired

indicatorstring

curl -X POST "https://api.runreveal.com/agents/tools/get-crowdstrike-report" \
  -H "Content-Type: application/json" \
  -d '{
    "indicator": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "errorMessage": "string",
    "indicator": "string",
    "indicatorType": "string",
    "report": "string",
    "success": true
  },
  "success": true
}

VirustotalReport operation

POST
/agents/tools/get-virustotal-report

Request Body

application/jsonRequired

indicatorstring

curl -X POST "https://api.runreveal.com/agents/tools/get-virustotal-report" \
  -H "Content-Type: application/json" \
  -d '{
    "indicator": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "errorMessage": "string",
    "indicator": "string",
    "indicatorType": "string",
    "report": "string",
    "success": true
  },
  "success": true
}

HttpRequest operation

POST
/agents/tools/make-http-request

Request Body

application/jsonRequired

bodyobject

headersobject

methodstring

urlstring

curl -X POST "https://api.runreveal.com/agents/tools/make-http-request" \
  -H "Content-Type: application/json" \
  -d '{
    "body": {
      "property1": {},
      "property2": {}
    },
    "headers": {
      "property1": "string",
      "property2": "string"
    },
    "method": "string",
    "url": "string"
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "body": "string",
    "headers": {
      "property1": "string",
      "property2": "string"
    },
    "httpStatus": 0,
    "success": true
  },
  "success": true
}

AgentsUpdate updates an existing AI agent

AgentsUpdate updates an existing AI agent

PUT
/agents/update

Request Body

application/jsonRequired

descriptionstring

disableRunRevealSystemPromptboolean

displayNamestring

enabledboolean

idstring

mcpServersarray<string>

modelstring

nextRunTimeobject

notesstring

notificationNamesarray<string>

notificationTemplatestring

parametersobject

promptstring

providerstring

riskScoreinteger

schedulestring

settingsarray<integer>

skipPermissionsboolean

toolsarray<string>

curl -X PUT "https://api.runreveal.com/agents/update" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "string",
    "disableRunRevealSystemPrompt": true,
    "displayName": "string",
    "enabled": true,
    "id": "string",
    "mcpServers": [
      "string"
    ],
    "model": "string",
    "nextRunTime": {},
    "notes": "string",
    "notificationNames": [
      "string"
    ],
    "notificationTemplate": "string",
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "prompt": "string",
    "provider": "string",
    "riskScore": 0,
    "schedule": "string",
    "settings": [
      0
    ],
    "skipPermissions": true,
    "tools": [
      "string"
    ]
  }'

Success

{
  "error": "string",
  "errorCode": "string",
  "result": {
    "createdAt": {},
    "createdBy": "string",
    "description": "string",
    "disableRunRevealSystemPrompt": true,
    "displayName": "string",
    "enabled": true,
    "id": "string",
    "mcpServers": [
      "string"
    ],
    "model": "string",
    "name": "string",
    "nextRunTime": {},
    "notes": "string",
    "notificationNames": [
      "string"
    ],
    "notificationTemplate": "string",
    "parameters": {
      "property1": "string",
      "property2": "string"
    },
    "previousRunTime": {},
    "prompt": "string",
    "provider": "string",
    "riskScore": 0,
    "roleID": "string",
    "schedule": "string",
    "settings": [
      0
    ],
    "silencedUntil": {},
    "skipPermissions": true,
    "tools": [
      "string"
    ],
    "updatedAt": {},
    "workspaceID": "string"
  },
  "success": true
}