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

RunWhen comments API

The comments API from RunWhen — 5 operation(s) for comments.

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

Tagged areas include Comments. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 5 paths, and defines 8 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.

6 operations 5 paths 8 schemas 3 GET1 PATCH2 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 comments 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 6

Across 5 paths, the API surfaces 6 operations — 3 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

comments 6
GET
/api/v3/workspaces/{workspace_short_name}/runsessions/{runsession_id}/comments
List comments for a run session
list_runsession_comments_api_v3_workspaces__workspace_short_name__runsessions__runsession_id__comments_get 2 params → 200422
GET
/api/v3/workspaces/{workspace_short_name}/issues/{issue_id}/comments
List comments for an issue
list_issue_comments_api_v3_workspaces__workspace_short_name__issues__issue_id__comments_get 2 params → 200422
POST
/api/v3/workspaces/{workspace_short_name}/issues/{issue_id}/comments
Create a comment on an issue
create_issue_comment_api_v3_workspaces__workspace_short_name__issues__issue_id__comments_post 2 params body → 201422
GET
/api/v3/workspaces/{workspace_short_name}/runsessions/{runsession_id}/issueoccurrences/{issue_id}/comments
List comments for an issue occurrence (alias)
list_issue_occurrence_comments_api_v3_workspaces__workspace_short_name__runsessions__runsession_id__issueoccurrences__issue_id__comments_get 3 params → 200422
POST
/api/v3/workspaces/{workspace_short_name}/issues/{issue_id}/comments/{comment_id}/replies
Reply to a comment
create_issue_comment_reply_api_v3_workspaces__workspace_short_name__issues__issue_id__comments__comment_id__replies_post 3 params body → 201422
PATCH
/api/v3/workspaces/{workspace_short_name}/issues/{issue_id}/comments/{comment_id}
Update a comment
update_issue_comment_api_v3_workspaces__workspace_short_name__issues__issue_id__comments__comment_id__patch 3 params body → 200422

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are CommentResponse (10 properties), CommentAuthorResponse (7 properties), ValidationError (5 properties), CommentReplyCreate (3 properties). Each schema is shown below with its type and property counts.

CommentResponse
object
Comment response schema for API responses. Uses camelCase aliases for frontend compatibility. Supports nested replies for threaded comments.
10 properties 4 required
CommentCreate
object
Schema for creating a top-level comment.
2 properties 1 required
HTTPValidationError
object
1 property
CommentUpdate
object
Schema for updating an existing comment.
1 property 1 required
CommentAuthorResponse
object
Author information for comment responses. Uses camelCase aliases for frontend compatibility.
7 properties 6 required
CommentAction
string
Actions that can be taken on a comment thread.
CommentReplyCreate
object
Schema for creating a reply to an existing comment.
3 properties 1 required
ValidationError
object
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

runwhen-comments-api-openapi.yml Raw ↑

Other APIs RunWhen publishes across the network.

RunWhen alert-query-proxy API
RunWhen auth API
RunWhen auth-providers API
RunWhen auth0 API
RunWhen author API
RunWhen chat-config API
RunWhen codebundles API
RunWhen codecollections API
RunWhen configuration API
RunWhen explorer API
RunWhen Graphql API
RunWhen health API
Where this information came from

This is an independent, third-party profile of RunWhen comments 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.