Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Render Workflow Tasks (Beta) API

Run and manage tasks as part of [Render Workflows](https://render.com/docs/workflows). Workflows are in public beta.

Render Workflow Tasks (Beta) API is one of 26 APIs that Render publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Workflow Tasks (Beta). The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, a JSON-LD context, and 3 JSON Schemas.

This API exposes 7 operations across 5 paths, and defines 4 schemas. It is described by OpenAPI 3.0.2, at version 1.0.0.

Requests are made against a single base URL, https://api.render.com/v1.

7 operations 5 paths 4 schemas 1 DELETE5 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
1.0.0
Base URL
https://api.render.com/v1
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

Render Workflow Tasks (Beta) API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

Paths & Operations 7

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

Workflow Tasks (Beta) 7

Run and manage tasks as part of [Render Workflows](https://render.com/docs/workflows). Workflows are in public beta.

GET
/tasks
List tasks
listTasks 6 params → 200401403404429500503
GET
/tasks/{taskId}
Retrieve task
getTask 1 param → 200401403404429500503
GET
/task-runs
List task runs
listTaskRuns 7 params → 200401403404429500503
POST
/task-runs
Run task
createTask body → 202400401403404429500503
GET
/task-runs/events
Stream realtime events (SSE)
streamTaskRunsEvents 2 params → 200400401403404429500503
GET
/task-runs/{taskRunId}
Retrieve task run
getTaskRun 1 param → 200401403404429500503
DELETE
/task-runs/{taskRunId}
Cancel task run
cancelTaskRun 1 param → 204401403404429500503

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are error (2 properties), taskRunWithCursor (2 properties), taskWithCursor (2 properties). Each schema is shown below with its type and property counts.

cursor
string
taskWithCursor
object
2 properties 2 required
taskRunWithCursor
object
2 properties 2 required
error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

render-workflow-tasks-beta-api-openapi.yml Raw ↑

Other APIs Render publishes across the network.

Render Audit Logs API
Render Blueprints API
Render Custom Domains API
Render Deploys API
Render Disks API
Render Environment Groups API
Render Events API
Render Key Value API
Render Logs API
Render Maintenance API
Render Metrics API
Render Notification Settings API