RErender
Workflow Tasks

Run task

Changed on

Kicks off a run of the workflow task with the provided ID, passing the provided input data.

post/task-runs

Request

  • Base URL
    https://api.render.com/v1
  • Auth
    HTTP bearer

Request body

taskstring required

A task slug in the format workflow-slug/task-name. An optional version can be appended (workflow-slug/task-name:version). If no version is provided, the latest version is used. Cannot be blank.

idempotencyKeystring

A client-generated key that makes starting a task run safe to retry. Repeating a request with the same key within 24 hours returns the task run that the first request started instead of starting another one; the repeated request's input is ignored. Keys are scoped to a workflow. Omit the key to always start a new run.

Example request

{
  "task": "my-workflow-slug/my-task, my-workflow-slug/my-task:SHA123",
  "idempotencyKey": "6b2f1f7a-6a0e-4f6f-9d1a-2b1d0d5f6c11"
}

Response

Task run created

idstring required
taskIdstring required
statusStatus required(unresolved $ref)
startedAtstring date-time
completedAtstring date-time
parentTaskRunIdstring required
parentTaskAttemptinteger

The 0-indexed attempt of the parent task run that spawned this task run. Omitted for root task runs and for task runs created before this field was introduced.

rootTaskRunIdstring required
retriesinteger required

Changes

  • 6ac5d3d47362Revision changes
    • breaking

      added the pattern \S to the request property

    • info

      api tag Workflow Tasks added

    • info

      api tag Workflow Tasks (Beta) removed

    • info

      added the new optional request property

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property // to the response with the status