How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
RunWhen

RunWhen run-sessions API

The run-sessions API from RunWhen — 20 operation(s) for run-sessions.

Documentation Provider Profile APIs.io OpenAPI GitHub

RunWhen run-sessions API is one of 51 APIs that RunWhen publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include run-sessions. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 27 operations across 20 paths, and defines 22 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, https://papi.beta.runwhen.com.

27 operations 20 paths 22 schemas 1 DELETE14 GET3 PATCH9 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://papi.beta.runwhen.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

RunWhen run-sessions API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth).

  • BearerAuth — JWT access token from /api/v3/token/ or Auth0 login

Paths & Operations 27

Across 20 paths, the API surfaces 27 operations — 1 DELETE, 14 GET, 3 PATCH, 9 POST. Each is listed below with its method, path, parameters, and response codes.

run-sessions 27
POST
/api/v1/run-sessions
Create a new run session
create_run_session_api_v1_run_sessions_post body → 201422
GET
/api/v1/run-sessions
List run sessions
list_run_sessions_api_v1_run_sessions_get 4 params → 200422
GET
/api/v1/run-sessions/{session_id}
Get a run session by ID
get_run_session_api_v1_run_sessions__session_id__get 1 param → 200422
PATCH
/api/v1/run-sessions/{session_id}
Update a run session
update_run_session_api_v1_run_sessions__session_id__patch 1 param body → 200422
DELETE
/api/v1/run-sessions/{session_id}
Delete a run session
delete_run_session_api_v1_run_sessions__session_id__delete 1 param → 204422
POST
/api/v1/run-sessions/{session_id}/deactivate
Deactivate a run session
deactivate_run_session_api_v1_run_sessions__session_id__deactivate_post 1 param body → 200422
POST
/api/v1/run-sessions/{session_id}/escalate
Escalate a run session
escalate_run_session_api_v1_run_sessions__session_id__escalate_post 1 param body → 200422
GET
/api/v1/workspaces/{workspace_name}/runsessions
List run sessions for a workspace
list_workspace_run_sessions_api_v1_workspaces__workspace_name__runsessions_get 10 params → 200422
POST
/api/v1/workspaces/{workspace_name}/runsessions
Create a run session with run requests
create_runsession_with_requests_api_v1_workspaces__workspace_name__runsessions_post 1 param body → 200201422
POST
/api/v1/workspaces/{workspace_name}/runsessions/search
Search Workspace Run Sessions
search_workspace_run_sessions_api_v1_workspaces__workspace_name__runsessions_search_post 1 param body → 200422
GET
/api/v1/workspaces/{workspace_name}/runsessions/search/sources
Get Search Sources
get_search_sources_api_v1_workspaces__workspace_name__runsessions_search_sources_get 1 param → 200422
GET
/api/v1/workspaces/{workspace_name}/runsessions/{runsession_id}/alerts
Get Runsession Alerts
get_runsession_alerts_api_v1_workspaces__workspace_name__runsessions__runsession_id__alerts_get 2 params → 200422
GET
/api/v1/workspaces/{workspace_name}/runsessions/{runsession_id}
Get a run session by ID within a workspace
get_workspace_run_session_api_v1_workspaces__workspace_name__runsessions__runsession_id__get 2 params → 200422
PATCH
/api/v1/workspaces/{workspace_name}/runsessions/{runsession_id}
Update a run session within a workspace
patch_workspace_run_session_api_v1_workspaces__workspace_name__runsessions__runsession_id__patch 2 params body → 200422
GET
/api/v1/workspaces/{workspace_name}/runsessions/{runsession_id}/summary
Get run session summary from Sobrain
get_workspace_run_session_summary_api_v1_workspaces__workspace_name__runsessions__runsession_id__summary_get 2 params → 200422
GET
/api/v1/workspaces/{workspace_name}/runsessions/{runsession_id}/activities
Get run session activity timeline
get_workspace_run_session_activities_api_v1_workspaces__workspace_name__runsessions__runsession_id__activities_get 2 params → 200422
POST
/api/v1/workspaces/{workspace_name}/runsessions/{runsession_id}/step
Process the next step in the RunSession workflow
step_runsession_api_v1_workspaces__workspace_name__runsessions__runsession_id__step_post 2 params → 200422
GET
/api/v3/workspaces/{workspace_name}/runsessions
List run sessions for a workspace
list_workspace_run_sessions_api_v3_workspaces__workspace_name__runsessions_get 10 params → 200422
POST
/api/v3/workspaces/{workspace_name}/runsessions
Create a run session with run requests
create_runsession_with_requests_api_v3_workspaces__workspace_name__runsessions_post 1 param body → 200201422
POST
/api/v3/workspaces/{workspace_name}/runsessions/search
Search Workspace Run Sessions
search_workspace_run_sessions_api_v3_workspaces__workspace_name__runsessions_search_post 1 param body → 200422
GET
/api/v3/workspaces/{workspace_name}/runsessions/search/sources
Get Search Sources
get_search_sources_api_v3_workspaces__workspace_name__runsessions_search_sources_get 1 param → 200422
GET
/api/v3/workspaces/{workspace_name}/runsessions/{runsession_id}/alerts
Get Runsession Alerts
get_runsession_alerts_api_v3_workspaces__workspace_name__runsessions__runsession_id__alerts_get 2 params → 200422
GET
/api/v3/workspaces/{workspace_name}/runsessions/{runsession_id}
Get a run session by ID within a workspace
get_workspace_run_session_api_v3_workspaces__workspace_name__runsessions__runsession_id__get 2 params → 200422
PATCH
/api/v3/workspaces/{workspace_name}/runsessions/{runsession_id}
Update a run session within a workspace
patch_workspace_run_session_api_v3_workspaces__workspace_name__runsessions__runsession_id__patch 2 params body → 200422
GET
/api/v3/workspaces/{workspace_name}/runsessions/{runsession_id}/summary
Get run session summary from Sobrain
get_workspace_run_session_summary_api_v3_workspaces__workspace_name__runsessions__runsession_id__summary_get 2 params → 200422
GET
/api/v3/workspaces/{workspace_name}/runsessions/{runsession_id}/activities
Get run session activity timeline
get_workspace_run_session_activities_api_v3_workspaces__workspace_name__runsessions__runsession_id__activities_get 2 params → 200422
POST
/api/v3/workspaces/{workspace_name}/runsessions/{runsession_id}/step
Process the next step in the RunSession workflow
step_runsession_api_v3_workspaces__workspace_name__runsessions__runsession_id__step_post 2 params → 200422

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are RunRequestInResponse (36 properties), RunSessionResponse (20 properties), PersonaResponse (19 properties), RunSessionSearchItem (19 properties). Each schema is shown below with its type and property counts.

DeactivateRequest
object
Schema for deactivating a run session.
1 property
RunSessionAlertsListResponse
object
Response for GET /runsessions/{rsid}/alerts.
2 properties 2 required
DedupeConfig
object
Configuration for RunSession deduplication.
3 properties
HTTPValidationError
object
1 property
RunSessionCreateWithRequests
object
Schema for creating a RunSession with RunRequests atomically. This is the new preferred API for RunSession creation that: - Supports atomic RunRequest creation…
14 properties 1 required
SourcesResponse
object
Response for available search sources.
1 property 1 required
RunRequestInSession
object
Single RunRequest within a RunSession creation.
10 properties 1 required
RunSessionCreate
object
Schema for creating a run session.
7 properties 1 required
StepResponse
object
Response for RunSession step endpoint.
3 properties 3 required
RunSessionSearchResponse
object
Paginated search response.
4 properties 2 required
RunSessionAlertResponse
object
Single alert in RS alert detail view.
8 properties 7 required
RunSessionUpdate
object
Schema for updating a run session (partial update).
6 properties
RunSessionSearchItem
object
Slim RunSession for list view — no nested runrequests.
19 properties 5 required
RunRequestInResponse
object
Schema for run request within a run session response.
36 properties 1 required
EscalateRequest
object
Schema for escalating a run session.
1 property
PersonaResponse
object
Persona response schema for API responses (legacy V1/V3 wire shape). Subclasses PersonaResponseV4 (flat V4 fields) and layers on: - Legacy wire keys: workspace…
19 properties 7 required
RunSessionResponse
object
Schema for run session response with all fields. Uses aliasgenerator=tocamel so JSON output uses camelCase keys matching the Django DRF convention the frontend…
20 properties 7 required
ValidationError
object
5 properties 3 required
RunSessionListResponse
object
Schema for paginated run session list response.
6 properties 4 required
RunSessionSearchRequest
object
Request body for POST /workspaces/{ws}/runsessions/search.
7 properties 2 required
SourceOption
object
A single source filter option.
3 properties 3 required
RunRequestIssue
object
Schema for issue occurrence within a run request.
15 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

runwhen-run-sessions-api-openapi.yml Raw ↑

Other APIs RunWhen publishes across the network.

RunWhen alert-query-proxy API
AE Profile APIs.io
RunWhen auth API
AE Profile APIs.io
RunWhen auth-providers API
AE Profile APIs.io
RunWhen auth0 API
AE Profile APIs.io
RunWhen author API
AE Profile APIs.io
RunWhen chat-config API
AE Profile APIs.io
RunWhen codebundles API
AE Profile APIs.io
RunWhen codecollections API
AE Profile APIs.io
RunWhen comments API
AE Profile APIs.io
RunWhen configuration API
AE Profile APIs.io
RunWhen explorer API
AE Profile APIs.io
RunWhen Graphql API
AE Profile APIs.io
#run-sessions
← Back to R APIs
API Details
ID
runwhen:runwhen-run-sessions-api
Base URL
https://papi.beta.runwhen.com
Docs
https://docs.runwhen.com/docs/use/api-reference
Provider
RunWhen
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=runwhen-run-sessions-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/runwhen-run-sessions-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of RunWhen run-sessions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.