Platform Documentation
Breadcrumbs

Task Search & Activities API

Task Search provides vector-based semantic search for finding relevant troubleshooting tasks and codebundles. Activities track user and system actions across the platform.


Search Tasks

Perform a semantic search for troubleshooting tasks within a workspace. This uses vector embeddings (OpenAI + Qdrant) to find the most relevant codebundles and actions based on a natural language query.



Method

POST

Path

/api/v3/workspaces/{workspace_name}/task-search

Auth

Bearer token required

Path Parameters

Parameter

Type

Description

workspace_name

string

The unique name of the workspace

Request Body

JSON
{
  "query": "pods crashing in production namespace"
}

Field

Type

Required

Description

query

string

Yes

Natural language search query describing the problem or task

Response 200 OK

Returns a ranked list of matching tasks with confidence scores, codebundle references, and suggested actions.

JSON
{
  "results": [
    {
      "taskTitle": "Check Kubernetes Pod Health",
      "confidence": 0.92,
      "codeBundle": {
        "repoUrl": "https://github.com/runwhen-contrib/rw-cli-codecollection",
        "ref": "main",
        "pathToRobot": "codebundles/k8s-pod-health/runbook.robot"
      },
      "slxName": "check-pod-health"
    }
  ]
}

Activities

List Workspace Activities

Retrieve the activity feed for a workspace.



Method

GET

Path

/api/v3/workspaces/{workspace_name}/activities/

Auth

Bearer token required

Path Parameters

Parameter

Type

Description

workspace_name

string

The unique name of the workspace

Response 200 OK

Returns a list of activity events. Each event includes:

JSON
{
  "results": [
    {
      "id": 456,
      "verb": "RUNSESSION_STARTED",
      "actorName": "jdoe",
      "targetName": "RunSession #123",
      "workspace": "my-workspace",
      "timestamp": "2026-02-28T10:00:00Z"
    }
  ]
}

Activity Verbs

Verb

Description

RUNSESSION_STARTED

A new run session was created

RUNSESSION_UPDATED

A run session status changed

WORKSPACE_UPLOADED

A workspace config was uploaded via Git

WORKSPACE_CHANGE_COMMITTED

Workspace changes were committed to the repo

SLI_ALERT_CREATED

An SLI threshold violation was detected

SLI_ALERTS_STARTED

An SLI alert batch began processing

ALERT_CREATED

An external alert was received

ALERTS_STARTED

Alert processing batch began

CODECOLLECTION_NEW_VERSIONS_AVAILABLE

New codebundle versions were detected

CODECOLLECTION_WARNING_IMAGE_CHANGE

A codebundle image change warning was raised


Get Workspace Activity Count

Retrieve the total count of activities for a workspace.



Method

GET

Path

/api/v3/workspaces/{workspace_name}/activities/count

Auth

Bearer token required

Path Parameters

Parameter

Type

Description

workspace_name

string

The unique name of the workspace

Response 200 OK

Returns the total activity count for the workspace.