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 chat-config API

The chat-config API from RunWhen — 11 operation(s) for chat-config.

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

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

This API exposes 17 operations across 11 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.

17 operations 11 paths 8 schemas 2 DELETE8 GET5 POST2 PUT

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 chat-config 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 17

Across 11 paths, the API surfaces 17 operations — 2 DELETE, 8 GET, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

chat-config 17
GET
/api/v3/workspaces/{workspace_name}/chat-config/rules
Ws List Rules
ws_list_rules_api_v3_workspaces__workspace_name__chat_config_rules_get 6 params → 200422
POST
/api/v3/workspaces/{workspace_name}/chat-config/rules
Ws Create Rule
ws_create_rule_api_v3_workspaces__workspace_name__chat_config_rules_post 1 param body → 201422
GET
/api/v3/workspaces/{workspace_name}/chat-config/rules/{rule_id}
Ws Get Rule
ws_get_rule_api_v3_workspaces__workspace_name__chat_config_rules__rule_id__get 2 params → 200422
PUT
/api/v3/workspaces/{workspace_name}/chat-config/rules/{rule_id}
Ws Update Rule
ws_update_rule_api_v3_workspaces__workspace_name__chat_config_rules__rule_id__put 2 params body → 200422
DELETE
/api/v3/workspaces/{workspace_name}/chat-config/rules/{rule_id}
Ws Delete Rule
ws_delete_rule_api_v3_workspaces__workspace_name__chat_config_rules__rule_id__delete 2 params → 204422
GET
/api/v3/workspaces/{workspace_name}/chat-config/commands
Ws List Commands
ws_list_commands_api_v3_workspaces__workspace_name__chat_config_commands_get 6 params → 200422
POST
/api/v3/workspaces/{workspace_name}/chat-config/commands
Ws Create Command
ws_create_command_api_v3_workspaces__workspace_name__chat_config_commands_post 1 param body → 201422
GET
/api/v3/workspaces/{workspace_name}/chat-config/commands/{command_id}
Ws Get Command
ws_get_command_api_v3_workspaces__workspace_name__chat_config_commands__command_id__get 2 params → 200422
PUT
/api/v3/workspaces/{workspace_name}/chat-config/commands/{command_id}
Ws Update Command
ws_update_command_api_v3_workspaces__workspace_name__chat_config_commands__command_id__put 2 params body → 200422
DELETE
/api/v3/workspaces/{workspace_name}/chat-config/commands/{command_id}
Ws Delete Command
ws_delete_command_api_v3_workspaces__workspace_name__chat_config_commands__command_id__delete 2 params → 204422
GET
/api/v3/workspaces/{workspace_name}/chat-config/commands/{command_id}/executions
Ws List Command Executions
ws_list_command_executions_api_v3_workspaces__workspace_name__chat_config_commands__command_id__executions_get 3 params → 200422
POST
/api/v3/workspaces/{workspace_name}/chat-config/dry-run
Ws Dry Run Command
ws_dry_run_command_api_v3_workspaces__workspace_name__chat_config_dry_run_post 1 param body → 202422
GET
/api/v3/workspaces/{workspace_name}/chat-config/dry-run/{exec_id}
Ws Get Dry Run Status
ws_get_dry_run_status_api_v3_workspaces__workspace_name__chat_config_dry_run__exec_id__get 4 params → 200422
POST
/api/v3/workspaces/{workspace_name}/chat-config/commands/{command_id}/run-now
Ws Run Command Now
ws_run_command_now_api_v3_workspaces__workspace_name__chat_config_commands__command_id__run_now_post 2 params → 202422
POST
/api/v3/workspaces/{workspace_name}/chat-config/commands/{command_id}/preview-artifact-deliveries
Ws Preview Artifact Deliveries
ws_preview_artifact_deliveries_api_v3_workspaces__workspace_name__chat_config_commands__command_id__preview_artifact_deliveries_post 2 params body → 200422
GET
/api/v3/workspaces/{workspace_name}/chat-config/sink-suggestions/slack
Ws Slack Sink Suggestions
ws_slack_sink_suggestions_api_v3_workspaces__workspace_name__chat_config_sink_suggestions_slack_get 1 param → 200422
GET
/api/v3/workspaces/{workspace_name}/chat-config/resolved
Ws Resolved Config
ws_resolved_config_api_v3_workspaces__workspace_name__chat_config_resolved_get 1 param → 200422

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are CommandUpdate (14 properties), CommandCreate (13 properties), DryRunRequest (7 properties), ValidationError (5 properties). Each schema is shown below with its type and property counts.

RuleUpdate
object
Update a chat rule.
5 properties
DryRunRequest
object
Form-state dry-run for the schedule-config dialog. runasuser is required (RW-931 follow-up) — the dry-run session runs AS this user so chat-export and audit sh…
7 properties 2 required
HTTPValidationError
object
1 property
PreviewArtifactDeliveriesRequest
object
Render a saved execution's artifact through its command's sinks in dispatcher dry-run mode — no email is sent, no slack message posted. Returns per-sink render…
3 properties
CommandCreate
object
Create a chat command. commandcontent is the prompt that gets shipped to agentfarm and runs the agent — empty / whitespace-only would mean the agent runs again…
13 properties 3 required
RuleCreate
object
Create a chat rule.
5 properties 3 required
CommandUpdate
object
Update a chat command. Partial-update semantics: omitting a field leaves it unchanged. An explicit empty / whitespace-only commandcontent is the save- then-bla…
14 properties
ValidationError
object
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

runwhen-chat-config-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 codebundles API
RunWhen codecollections API
RunWhen comments 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 chat-config 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.