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-requests API

The run-requests API from RunWhen — 18 operation(s) for run-requests.

Documentation Provider Profile APIs.io OpenAPI GitHub

RunWhen run-requests 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-requests. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 24 operations across 18 paths, and defines 13 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.

24 operations 18 paths 13 schemas 2 DELETE16 GET2 PATCH4 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-requests 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 24

Across 18 paths, the API surfaces 24 operations — 2 DELETE, 16 GET, 2 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

run-requests 24
POST
/api/v1/workspaces/{workspace_name}/slxs/{slx_short_name}/runbook/runs
Create a new RunRequest
create_run_request_api_v1_workspaces__workspace_name__slxs__slx_short_name__runbook_runs_post 2 params body → 201422
GET
/api/v1/workspaces/{workspace_name}/slxs/{slx_short_name}/runbook/runs
List RunRequests for an SLX
list_run_requests_api_v1_workspaces__workspace_name__slxs__slx_short_name__runbook_runs_get 4 params → 200422
GET
/api/v1/workspaces/{workspace_name}/slxs/{slx_short_name}/runbook/runs/{run_request_id}
Get a RunRequest by ID
get_run_request_api_v1_workspaces__workspace_name__slxs__slx_short_name__runbook_runs__run_request_id__get 3 params → 200422
PATCH
/api/v1/workspaces/{workspace_name}/slxs/{slx_short_name}/runbook/runs/{run_request_id}
Record a run response
record_run_response_api_v1_workspaces__workspace_name__slxs__slx_short_name__runbook_runs__run_request_id__patch 3 params body → 200422
DELETE
/api/v1/workspaces/{workspace_name}/slxs/{slx_short_name}/runbook/runs/{run_request_id}
Delete a RunRequest
delete_run_request_api_v1_workspaces__workspace_name__slxs__slx_short_name__runbook_runs__run_request_id__delete 3 params → 204422
POST
/api/v1/workspaces/{workspace_name}/slxs/{slx_short_name}/runbook/runs/{run_request_id}/start
Start a staged RunRequest
start_run_request_api_v1_workspaces__workspace_name__slxs__slx_short_name__runbook_runs__run_request_id__start_post 3 params → 200422
GET
/api/v1/workspaces/{workspace_name}/slxs/{slx_short_name}/runbook/runs/{run_request_id}/report
Get the report for a RunRequest
get_run_request_report_api_v1_workspaces__workspace_name__slxs__slx_short_name__runbook_runs__run_request_id__report_get 4 params → 200422
GET
/api/v1/workspaces/{workspace_name}/slxs/{slx_short_name}/runbook/runs/{run_request_id}/issues
Get issues from a RunRequest
get_run_request_issues_api_v1_workspaces__workspace_name__slxs__slx_short_name__runbook_runs__run_request_id__issues_get 3 params → 200422
GET
/api/v1/workspaces/{workspace_name}/slxs/{slx_short_name}/runbook/runs/{run_request_id}/output
Get parsed output from a RunRequest
get_run_request_output_api_v1_workspaces__workspace_name__slxs__slx_short_name__runbook_runs__run_request_id__output_get 3 params → 200422
GET
/api/v1/workspaces/{workspace_name}/slxs/{slx_short_name}/runbook/runs/{run_request_id}/runner-status
Get runner status for a RunRequest
get_run_request_runner_status_api_v1_workspaces__workspace_name__slxs__slx_short_name__runbook_runs__run_request_id__runner_status_get 3 params → 200422
GET
/api/v1/workspaces/{workspace_name}/slxs/{slx_short_name}/runbook/runs/staged
List staged RunRequests
list_staged_run_requests_api_v1_workspaces__workspace_name__slxs__slx_short_name__runbook_runs_staged_get 3 params → 200422
GET
/api/v1/workspaces/{workspace_name}/run-requests/{run_request_id}/log
Get the robot log for a RunRequest (SLX-agnostic)
get_run_request_log_api_v1_workspaces__workspace_name__run_requests__run_request_id__log_get 2 params → 200422
POST
/api/v3/workspaces/{workspace_name}/slxs/{slx_short_name}/runbook/runs
Create a new RunRequest
create_run_request_api_v3_workspaces__workspace_name__slxs__slx_short_name__runbook_runs_post 2 params body → 201422
GET
/api/v3/workspaces/{workspace_name}/slxs/{slx_short_name}/runbook/runs
List RunRequests for an SLX
list_run_requests_api_v3_workspaces__workspace_name__slxs__slx_short_name__runbook_runs_get 4 params → 200422
GET
/api/v3/workspaces/{workspace_name}/slxs/{slx_short_name}/runbook/runs/{run_request_id}
Get a RunRequest by ID
get_run_request_api_v3_workspaces__workspace_name__slxs__slx_short_name__runbook_runs__run_request_id__get 3 params → 200422
PATCH
/api/v3/workspaces/{workspace_name}/slxs/{slx_short_name}/runbook/runs/{run_request_id}
Record a run response
record_run_response_api_v3_workspaces__workspace_name__slxs__slx_short_name__runbook_runs__run_request_id__patch 3 params body → 200422
DELETE
/api/v3/workspaces/{workspace_name}/slxs/{slx_short_name}/runbook/runs/{run_request_id}
Delete a RunRequest
delete_run_request_api_v3_workspaces__workspace_name__slxs__slx_short_name__runbook_runs__run_request_id__delete 3 params → 204422
POST
/api/v3/workspaces/{workspace_name}/slxs/{slx_short_name}/runbook/runs/{run_request_id}/start
Start a staged RunRequest
start_run_request_api_v3_workspaces__workspace_name__slxs__slx_short_name__runbook_runs__run_request_id__start_post 3 params → 200422
GET
/api/v3/workspaces/{workspace_name}/slxs/{slx_short_name}/runbook/runs/{run_request_id}/report
Get the report for a RunRequest
get_run_request_report_api_v3_workspaces__workspace_name__slxs__slx_short_name__runbook_runs__run_request_id__report_get 4 params → 200422
GET
/api/v3/workspaces/{workspace_name}/slxs/{slx_short_name}/runbook/runs/{run_request_id}/issues
Get issues from a RunRequest
get_run_request_issues_api_v3_workspaces__workspace_name__slxs__slx_short_name__runbook_runs__run_request_id__issues_get 3 params → 200422
GET
/api/v3/workspaces/{workspace_name}/slxs/{slx_short_name}/runbook/runs/{run_request_id}/output
Get parsed output from a RunRequest
get_run_request_output_api_v3_workspaces__workspace_name__slxs__slx_short_name__runbook_runs__run_request_id__output_get 3 params → 200422
GET
/api/v3/workspaces/{workspace_name}/slxs/{slx_short_name}/runbook/runs/{run_request_id}/runner-status
Get runner status for a RunRequest
get_run_request_runner_status_api_v3_workspaces__workspace_name__slxs__slx_short_name__runbook_runs__run_request_id__runner_status_get 3 params → 200422
GET
/api/v3/workspaces/{workspace_name}/slxs/{slx_short_name}/runbook/runs/staged
List staged RunRequests
list_staged_run_requests_api_v3_workspaces__workspace_name__slxs__slx_short_name__runbook_runs_staged_get 3 params → 200422
GET
/api/v3/workspaces/{workspace_name}/run-requests/{run_request_id}/log
Get the robot log for a RunRequest (SLX-agnostic)
get_run_request_log_api_v3_workspaces__workspace_name__run_requests__run_request_id__log_get 2 params → 200422

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are RunRequestResponse (31 properties), RunRequestCreate (11 properties), RunRequestRecordResponse (9 properties), RunRequestListResponse (6 properties). Each schema is shown below with its type and property counts.

IssueReference
object
Reference to an issue from a RunRequest.
4 properties 2 required
RunRequestCreate
object
Schema for creating a new RunRequest.
11 properties
RunnerStatusResponse
object
Response for runner status query.
3 properties 2 required
RunRequestListResponse
object
Paginated list response for RunRequest endpoints.
6 properties 4 required
HTTPValidationError
object
1 property
RunRequestIssuesResponse
object
Response for issues endpoint.
2 properties 2 required
RunRequestRecordResponse
object
Schema for recording a run response (runner callback).
9 properties
OutputResponse
object
Response for output endpoint.
2 properties 2 required
OutputProcessingStatusEnum
string
Processing status for RunRequest output.
StartRunRequestResponse
object
Response for starting a staged RunRequest.
4 properties 3 required
RunRequestResponse
object
Full RunRequest response schema for API responses.
31 properties 5 required
ProcessingStatusResponse
object
Schema for RunRequest output processing status.
4 properties 1 required
ValidationError
object
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

runwhen-run-requests-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-requests
← Back to R APIs
API Details
ID
runwhen:runwhen-run-requests-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-requests-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/runwhen-run-requests-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-requests 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.