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

The author API from RunWhen — 8 operation(s) for author.

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

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

This API exposes 10 operations across 8 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.

10 operations 8 paths 8 schemas 6 GET2 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 author 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 10

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

author 10
POST
/api/v1/workspaces/{workspace_name}/author/run
Create an author run
create_run_api_v1_workspaces__workspace_name__author_run_post 1 param body → 202422
GET
/api/v1/workspaces/{workspace_name}/author/run/{run_id}
Get stored command for a run (public, for runner/explorer)
get_run_api_v1_workspaces__workspace_name__author_run__run_id__get 2 params → 200422
GET
/api/v1/workspaces/{workspace_name}/author/run/{run_id}/status
Get run status (owner only)
get_run_status_api_v1_workspaces__workspace_name__author_run__run_id__status_get 2 params → 200422
PATCH
/api/v1/workspaces/{workspace_name}/author/run/{run_id}/status
Update run status (runner callback)
update_run_status_api_v1_workspaces__workspace_name__author_run__run_id__status_patch 2 params body → 200422
GET
/api/v1/workspaces/{workspace_name}/author/run/{run_id}/output
Get signed URLs for run output artifacts (owner only)
get_run_output_api_v1_workspaces__workspace_name__author_run__run_id__output_get 2 params → 200422
POST
/api/v3/workspaces/{workspace_name}/author/run
Create an author run
create_run_api_v3_workspaces__workspace_name__author_run_post 1 param body → 202422
GET
/api/v3/workspaces/{workspace_name}/author/run/{run_id}
Get stored command for a run (public, for runner/explorer)
get_run_api_v3_workspaces__workspace_name__author_run__run_id__get 2 params → 200422
GET
/api/v3/workspaces/{workspace_name}/author/run/{run_id}/status
Get run status (owner only)
get_run_status_api_v3_workspaces__workspace_name__author_run__run_id__status_get 2 params → 200422
PATCH
/api/v3/workspaces/{workspace_name}/author/run/{run_id}/status
Update run status (runner callback)
update_run_status_api_v3_workspaces__workspace_name__author_run__run_id__status_patch 2 params body → 200422
GET
/api/v3/workspaces/{workspace_name}/author/run/{run_id}/output
Get signed URLs for run output artifacts (owner only)
get_run_output_api_v3_workspaces__workspace_name__author_run__run_id__output_get 2 params → 200422

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are AuthorRunCreate (6 properties), AuthorRunOutputArtifact (5 properties), ValidationError (5 properties), AuthorRunStatusUpdate (4 properties). Each schema is shown below with its type and property counts.

AuthorRunOutputArtifact
object
Single artifact entry inside the output response.
5 properties 5 required
AuthorRunCreate
object
Payload for POST /author/run.
6 properties 2 required
AuthorRunOutputResponse
object
Response for GET /author/run/{runid}/output.
3 properties 3 required
AuthorRunStatusUpdate
object
Payload for PATCH /author/run/{runid}/status (runner callback). The runner posts back the RunRequest response shape; we derive SUCCEEDED / FAILED from whether…
4 properties
HTTPValidationError
object
1 property
AuthorRunCreateResponse
object
Response for POST /author/run.
2 properties 1 required
AuthorRunStatusResponse
object
Response for GET|PATCH /author/run/{runid}/status.
2 properties 2 required
ValidationError
object
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

runwhen-author-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 chat-config 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 author 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.