Workflows SDK for Python

Usage and symbol reference

The Render SDK for Python provides support for:

Defining tasks and flows in your workflow service
Running functions as steps inside a flow
Chaining additional task runs from within a task function
Triggering and managing runs from Python code outside the workflow

Install

From your Python project directory:

If you already have the SDK installed, make sure you're using version 1.7.0 or later:

After installing, make sure to add render>=1.7.0 as a dependency in your application's requirements.txt, pyproject.toml, or equivalent.

Workflow setup

The following symbols pertain to setting up your workflow service. For usage guidance, see Defining Tasks and Defining Flows.

The `Workflows` class

Handles defining and registering workflow tasks and flows. Initialize this in each file where you define tasks or flows.

Constructor

`Workflows(*, default_retry=None, default_timeout=None, default_plan=None)`

Initializes a new Workflows object. All parameters are optional.

Parameter Description

`default_retry`

A Retry object defining default retry behavior for all tasks registered directly on this Workflows object. See Retry settings.

This setting does not apply to flows.

Individual tasks can override this. If neither the workflow nor the task specifies retry settings, Render applies default retry behavior.

`default_timeout`

The default timeout for each execution attempt (in seconds) for all tasks and flows registered directly on this Workflows object.

Individual definitions can override this with timeout_seconds.

`default_plan`

The default compute plan to use for all tasks and flows registered directly on this Workflows object.

Individual definitions can override this with plan.

One of the following:

CPU	RAM	Plan ID
Up to 1 CPU	Up to 4 GB	`flex`
2	4 GB	`2c-4g`
2	8 GB	`2c-8g`
4	8 GB	`4c-8g`
4	16 GB	`4c-16g`
8	32 GB	`8c-32g`

The default value is flex.

Providing starter or standard is equivalent to providing flex.

`Workflows.from_workflows(*apps, default_retry=None, default_timeout=None, default_plan=None)`

Initializes a new Workflows object that incorporates tasks and flows from one or more other Workflows objects.

Use this in your workflow's entry point file if you import task definitions or flow definitions from other files:

If you set any defaults with this method (such as default_timeout), those defaults apply only to definitions registered directly on this Workflows object (not to definitions registered on the imported objects). default_retry applies only to tasks.

Parameter	Description
`*apps`	Required. One or more `Workflows` objects to incorporate into this object. Task and flow names share a namespace. If two objects define a task or flow with the same name, this raises a `ValueError`.
`default_retry`	The default retry configuration for new tasks registered on this workflow. Same as the `Workflows` constructor parameter.
`default_timeout`	The default timeout for new tasks and flows registered on this workflow. Same as the `Workflows` constructor parameter.
`default_plan`	The default compute plan for new tasks and flows registered on this workflow. Same as the `Workflows` constructor parameter.

The `app.start()` method

`Workflows.start()`

The app.start() method serves as the entry point for your workflow during both task and flow registration and run execution. Your workflow definition must call this method as part of startup:

This method has no parameters.

Defining tasks

The following symbols pertain to creating and registering tasks in your workflow service. For usage guidance, see Defining Tasks.

The `@app.task` decorator

`@app.task(*, name=None, retry=None, timeout_seconds=None, plan=None)`

You apply the @app.task decorator to a Python function to register it as a workflow task. For details, see Defining Tasks.

On success: Returns a task definition that you can pass to ctx.run() to chain a run of the task.

Basic usage:

With all configuration options:

Parameter Description

Decorator parameters

`name`

A custom name for the task.

This affects the task's slug, which you use to reference the task when triggering runs.

Use a name that is unique across all tasks and flows in the workflow.

If omitted, defaults to the name of the decorated function.

`retry`

A Retry object defining retry behavior for the task. See all supported settings below.

If omitted, uses the workflow's default_retry setting. If neither is provided, Render applies default retry behavior.

`timeout_seconds`

The timeout for each execution attempt, in seconds.

Must be between 30 seconds (30) and 24 hours (86400), inclusive.

If omitted, uses the workflow's default_timeout setting. If neither is provided, the default is 2 hours.

`plan`

The compute plan to use for the task's runs.

One of the following:

CPU	RAM	Plan ID
Up to 1 CPU	Up to 4 GB	`flex`
2	4 GB	`2c-4g`
2	8 GB	`2c-8g`
4	8 GB	`4c-8g`
4	16 GB	`4c-16g`
8	32 GB	`8c-32g`

If omitted, uses the workflow's default_plan setting. If neither is provided, the default is flex.

Providing starter or standard is equivalent to providing flex.

Retry settings

`max_retries`

Required if you provide retry. The maximum number of retries to attempt for a given run of the task. The total number of attempts is up to max_retries + 1 (the initial attempt plus all retries).

`wait_duration_ms`

Required if you provide retry. The base delay before attempting the first retry, in milliseconds.

`backoff_scaling`

The exponential backoff factor. After each retry, the previous delay is multiplied by this factor.

For example, a factor of 1.5 increases the delay by 50% after each retry.

If you provide a Retry object but omit this field, the default value is 1.5.
If neither the task nor the workflow provides a Retry object, the default value is 2.

The `TaskContext` object

Every task function must accept a TaskContext object as its first positional argument. Render automatically provides this object to each run (you do not provide it as an input).

Use run() for run chaining. Read metadata to get the current run's IDs.

`async` `TaskContext.run(task, *args, **kwargs)`

Chains a run of the specified task on a separate instance.

On success: Returns the chained run's return value.

Raises: TaskRunError, ValueError

Parameter Description

Parameter	Description
`task`	Required. The `@app.task`-decorated function to run, such as `calculate_square` in the example above.
`*args`	All input arguments to pass to the task run, as positional arguments: You cannot provide both positional and named task arguments in the same call (this raises a `ValueError`).
`**kwargs`	All input arguments to pass to the task run, as named arguments: You cannot provide both positional and named task arguments in the same call (this raises a `ValueError`).

`task`

Required. The @app.task-decorated function to run, such as calculate_square in the example above.

`*args`

All input arguments to pass to the task run, as positional arguments:

You cannot provide both positional and named task arguments in the same call (this raises a ValueError).

`**kwargs`

All input arguments to pass to the task run, as named arguments:

You cannot provide both positional and named task arguments in the same call (this raises a ValueError).

`TaskContext.metadata`

An object containing identifiers for the current task run and its execution chain.

Added in SDK v1.2.0.

Property Description

Property	Description
`task_run_id`	The ID of this task run.
`root_task_run_id`	The ID of the root-level task run for this run's execution chain. If this run is the root-level run, this value is the same as `task_run_id`.
`parent_task_run_id`	The ID of the task run that chained this run. This value is `None` for a root-level run.

`task_run_id`

The ID of this task run.

`root_task_run_id`

The ID of the root-level task run for this run's execution chain.

If this run is the root-level run, this value is the same as task_run_id.

`parent_task_run_id`

The ID of the task run that chained this run.

This value is None for a root-level run.

Defining flows

The following symbols pertain to creating and registering flows in your workflow service. For usage guidance, see Defining Flows.

The `@app.flow` decorator

`@app.flow(*, name=None, timeout_seconds=None, plan=None)`

You apply the @app.flow decorator to a Python function to register it as a flow. For details, see Defining Flows.

On success: Returns a flow definition.

Basic usage:

With all configuration options:

Parameter Description

Decorator parameters

`name`

A custom name for the flow.

This affects the flow's slug, which you use to reference the flow when triggering runs.

Use a name that is unique across all tasks and flows in the workflow.

If omitted, defaults to the name of the decorated function.

`timeout_seconds`

The timeout for each execution attempt, in seconds.

Must be between 30 seconds (30) and 24 hours (86400), inclusive.

If omitted, uses the workflow's default_timeout setting. If neither is provided, the default is 2 hours.

`plan`

The compute plan to use for the flow's runs.

One of the following:

CPU	RAM	Plan ID
Up to 1 CPU	Up to 4 GB	`flex`
2	4 GB	`2c-4g`
2	8 GB	`2c-8g`
4	8 GB	`4c-8g`
4	16 GB	`4c-16g`
8	32 GB	`8c-32g`

If omitted, uses the workflow's default_plan setting. If neither is provided, the default is flex.

Providing starter or standard is equivalent to providing flex.

The `FlowContext` object

Every flow function receives a FlowContext as its first positional argument. Render provides this object automatically.

For usage guidance, see Configuring step behavior.

`FlowContext.step(name, fn, /, *args, retry=None)`

Runs a plain function as a step inside the flow's process.

On success: Returns the function's return value.

Raises: TerminalFlowError, DeterminismError, FlowBadRequestError, FlowLimitError, ExecutionError, TypeError, ValueError

Parameter	Description
Function parameters
`name`	Required. The step's name. This value is not required to match the name of the function you provide as `fn`.
`fn`	Required. The function to execute as a step. The function must be synchronous. The function's arguments and return value must be JSON-serializable. You must pass a plain function. You cannot pass a definition returned by `@app.task` or `@app.flow`.
`*args`	Required if the function takes arguments. The positional argument values to pass to `fn`. For functions that take zero arguments, omit these arguments. You cannot pass the function's arguments by keyword.
`retry`	A `Retry` object defining retry behavior for the step. See all supported settings below. If a step's return value fails JSON serialization, the step fails without retrying. If all attempts fail, `ctx.step()` raises `TerminalFlowError`. The entire flow run fails even if this error is caught. If you omit this field, the step is attempted once.
Retry settings
`max_retries`	Required if you provide `retry`. The maximum number of retries to attempt for a given step. The total number of attempts is up to `max_retries + 1` (the initial attempt plus all retries).
`wait_duration_ms`	Required if you provide `retry`. The base delay before attempting the first retry, in milliseconds.
`backoff_scaling`	The exponential backoff factor. After each retry, the previous delay is multiplied by this factor. For example, a factor of `1.5` increases the delay by 50% after each retry. The default value is `1.5`.

`FlowContext.metadata`

An object containing the current flow run's ID.

Property	Description
`flow_run_id`	The ID of this flow run. Has the format `frn-abc123...`.

Triggering runs

The following symbols pertain to triggering and managing task and flow runs from code outside your workflow. For full usage guidance, see Triggering Runs.

When the Render API omits an optional field on a returned object, the corresponding Python property contains UNSET, imported from render.public_api.types. This is distinct from None, which represents a JSON null value.

Initialize the client (sync or async)

Use Render for synchronous execution contexts (such as a default Flask or Django app), or RenderAsync for asynchronous contexts (such as FastAPI route handlers). Both clients support all methods under Task methods and Flow methods.

With RenderAsync, you await method calls and use async for to consume event streams. The examples below assume you are already in an asynchronous execution context when using this client.

`Render(*, token=None)`

Initializes a synchronous Render SDK client.

Parameter Description

Parameter	Description
`token`	The API key to use for authentication. If omitted, the client automatically detects and uses the value of the `RENDER_API_KEY` environment variable.

`token`

The API key to use for authentication.

If omitted, the client automatically detects and uses the value of the RENDER_API_KEY environment variable.

`RenderAsync(*, token=None)`

Initializes an asynchronous Render SDK client.

Parameter Description

Parameter	Description
`token`	The API key to use for authentication. If omitted, the client automatically detects and uses the value of the `RENDER_API_KEY` environment variable.

`token`

The API key to use for authentication.

If omitted, the client automatically detects and uses the value of the RENDER_API_KEY environment variable.

Task methods

These methods are available on the workflows attribute of either client. Unless indicated otherwise, parameter descriptions and returned types apply to both clients.

`start_task(task_slug, input_data, *, idempotency_key=None)`

Kicks off a run of the registered task with the specified identifier, passing the specified arguments.

To instead start a task and wait for it to finish, use workflows.run_task.

On success: Returns a TaskRun with the sync client, or an AwaitableTaskRun with the async client. Both provide the run's ID and initial status immediately. You can await an AwaitableTaskRun to wait for completion and obtain TaskRunDetails.

Raises: ClientError, RateLimitError, ServerError, TimeoutError

Parameter Description

Parameter	Description
`task_slug`	Required. The slug indicating the task to run, available from your task's page in the Render Dashboard: Always has the format `{workflow-slug}/{task-name}` (e.g., `my-workflow/calculate_square`).
`input_data`	Required. A list or dictionary containing the task's input arguments. If you provide a list, elements are positional based on the task's function signature. If you provide a dictionary, each key maps to a parameter name in the task's function signature. For a task that takes zero arguments, provide an empty list, `[]`.
`idempotency_key`	An optional string used to prevent duplicate task runs. Added in SDK v1.2.0. For details, see Idempotency keys.

`task_slug`

Required. The slug indicating the task to run, available from your task's page in the Render Dashboard:

Task slug in the Render Dashboard

Always has the format {workflow-slug}/{task-name} (e.g., my-workflow/calculate_square).

`input_data`

Required. A list or dictionary containing the task's input arguments.

If you provide a list, elements are positional based on the task's function signature.
If you provide a dictionary, each key maps to a parameter name in the task's function signature.

For a task that takes zero arguments, provide an empty list, [].

`idempotency_key`

An optional string used to prevent duplicate task runs.

Added in SDK v1.2.0.

For details, see Idempotency keys.

`run_task(task_slug, input_data, *, idempotency_key=None)`

Starts the registered task with the specified identifier, waits for it to finish, and returns its details.

To instead start a run without waiting for completion, use workflows.start_task.

On success: Returns a TaskRunDetails object.

Raises: ClientError, RateLimitError, ServerError, TimeoutError, TaskRunError, RenderError

Parameter Description

Parameter	Description
`task_slug`	Required. The slug indicating the task to run, available from your task's page in the Render Dashboard: Always has the format `{workflow-slug}/{task-name}` (e.g., `my-workflow/calculate_square`).
`input_data`	Required. A list or dictionary containing the task's input arguments. If you provide a list, elements are positional based on the task's function signature. If you provide a dictionary, each key maps to a parameter name in the task's function signature. For a task that takes zero arguments, provide an empty list, `[]`.
`idempotency_key`	An optional string used to prevent duplicate task runs. Added in SDK v1.2.0. For details, see Idempotency keys.

`task_slug`

Required. The slug indicating the task to run, available from your task's page in the Render Dashboard:

Task slug in the Render Dashboard

Always has the format {workflow-slug}/{task-name} (e.g., my-workflow/calculate_square).

`input_data`

Required. A list or dictionary containing the task's input arguments.

If you provide a list, elements are positional based on the task's function signature.
If you provide a dictionary, each key maps to a parameter name in the task's function signature.

For a task that takes zero arguments, provide an empty list, [].

`idempotency_key`

An optional string used to prevent duplicate task runs.

Added in SDK v1.2.0.

For details, see Idempotency keys.

`list_task_runs(params=None)`

Lists task runs that match optional filters specified in a ListTaskRunsParams object.

On success: Returns a list of TaskRunWithCursor objects.

Raises: ClientError, RateLimitError, ServerError, TimeoutError

The optional params object supports the following fields:

Parameter	Description
`limit`	An integer specifying the maximum number of task runs to return.
`cursor`	A cursor string for pagination. Use this to retrieve the next page of results.
`owner_id`	A list of workspace IDs to filter results by. Only task runs from these workspaces will be returned.

`get_task_run(task_run_id)`

Retrieves the details of the task run with the specified ID.

On success: Returns a TaskRunDetails object, regardless of whether the run is still in progress or has finished. A failed status does not itself raise TaskRunError.

Raises: ClientError, RateLimitError, ServerError, TimeoutError

Parameter Description

Parameter	Description
`task_run_id`	Required. The ID of the task run to retrieve. Has the format `trn-abc123...`

`task_run_id`

Required. The ID of the task run to retrieve.

Has the format trn-abc123...

`cancel_task_run(task_run_id)`

Cancels the root-level task run with the specified ID, along with all of its chained runs. Raises ClientError if the root-level run is not found.

Runs that have already finished are left unchanged.

On success: Returns None.

Raises: ClientError, RateLimitError, ServerError, TimeoutError

Parameter Description

Parameter	Description
`task_run_id`	Required. The ID of the root-level task run to cancel. Has the format `trn-abc123...`

`task_run_id`

Required. The ID of the root-level task run to cancel.

Has the format trn-abc123...

`task_run_events(task_run_ids)`

Streams terminal-status events for one or more task runs via Server-Sent Events (SSE).

On success: Returns an iterator of TaskRunDetails objects: a regular iterator with Render, or an async iterator with RenderAsync. Each event describes a run that has reached a terminal status: completed, failed, or canceled. A failed run is yielded as an event (it does not raise TaskRunError).

The stream finishes when the server closes the connection after all requested runs have finished. You can also stop consuming events by breaking out of the loop.

Raises: ClientError, RateLimitError, ServerError, TimeoutError

Parameter Description

Parameter	Description
`task_run_ids`	Required. A list of task run IDs to stream events for. Each ID has the format `trn-abc123...`

`task_run_ids`

Required. A list of task run IDs to stream events for.

Each ID has the format trn-abc123...

Flow methods

These methods are available on the workflows attribute of either client. Unless indicated otherwise, parameter descriptions and returned types apply to both clients.

`start_flow(flow_slug, input_data, *, idempotency_key=None)`

Kicks off a run of the registered flow with the specified identifier, passing the specified arguments.

To instead run a flow and wait for it to complete, use workflows.run_flow.

On success: Returns a FlowRun object representing the started run.

Raises: ClientError, RateLimitError, ServerError, TimeoutError

Parameter Description

Parameter	Description
`flow_slug`	Required. The slug indicating the flow to run, available from your flow's page in the Render Dashboard. Always has the format `{workflow-slug}/{flow-name}` (e.g., `my-workflow/format_message`).
`input_data`	Required. A list or dictionary containing the flow's input arguments. If you provide a list, elements are positional based on the flow's function signature. If you provide a dictionary, each key maps to a parameter name in the flow's function signature. For a flow that takes zero arguments, provide an empty list, `[]`.
`idempotency_key`	An optional string used to prevent duplicate flow runs. For details, see Idempotency keys.

`flow_slug`

Required. The slug indicating the flow to run, available from your flow's page in the Render Dashboard.

Always has the format {workflow-slug}/{flow-name} (e.g., my-workflow/format_message).

`input_data`

Required. A list or dictionary containing the flow's input arguments.

If you provide a list, elements are positional based on the flow's function signature.
If you provide a dictionary, each key maps to a parameter name in the flow's function signature.

For a flow that takes zero arguments, provide an empty list, [].

`idempotency_key`

An optional string used to prevent duplicate flow runs.

For details, see Idempotency keys.

`run_flow(flow_slug, input_data, *, idempotency_key=None)`

Starts the registered flow with the specified identifier, waits for it to complete, and returns the result.

To instead kick off a run without waiting for it to complete, use workflows.start_flow.

On success: Returns a FlowRunDetails object for the finished flow run.

Raises: ClientError, RateLimitError, ServerError, TimeoutError, FlowRunError

Parameter Description

Parameter	Description
`flow_slug`	Required. The slug indicating the flow to run, available from your flow's page in the Render Dashboard. Has the format `{workflow-slug}/{flow-name}` (e.g., `my-workflow/format_message`).
`input_data`	Required. A list or dictionary containing the flow's input arguments. If you provide a list, elements are positional based on the flow's function signature. If you provide a dictionary, each key maps to a parameter name in the flow's function signature. For a flow that takes zero arguments, provide an empty list, `[]`.
`idempotency_key`	An optional string used to prevent duplicate flow runs. For details, see Idempotency keys.

`flow_slug`

Required. The slug indicating the flow to run, available from your flow's page in the Render Dashboard.

Has the format {workflow-slug}/{flow-name} (e.g., my-workflow/format_message).

`input_data`

Required. A list or dictionary containing the flow's input arguments.

If you provide a list, elements are positional based on the flow's function signature.
If you provide a dictionary, each key maps to a parameter name in the flow's function signature.

For a flow that takes zero arguments, provide an empty list, [].

`idempotency_key`

An optional string used to prevent duplicate flow runs.

For details, see Idempotency keys.

`list_flow_runs(params=None)`

Lists flow runs that match optional filters specified in a ListFlowRunsParams object.

On success: Returns a list of FlowRunWithCursor objects.

Raises: ClientError, RateLimitError, ServerError, TimeoutError

The optional params object supports the following fields:

Parameter	Description
`limit`	An integer specifying the maximum number of flow runs to return.
`cursor`	A cursor string for pagination. Use this to retrieve the next page of results.
`flow_slug`	A list of flow slugs to filter results by. Only flow runs for these flows are returned.
`flow_id`	A list of flow definition IDs to filter results by.
`status`	A list of flow run status values to filter results by. Accepts `FlowRunStatus` enum values or strings.
`owner_id`	A list of workspace IDs to filter results by. Only flow runs from these workspaces will be returned.
`workflow_version_id`	A list of workflow version IDs to filter results by.
`workflow_id`	A list of workflow IDs to filter results by.

`get_flow_run(flow_run_id)`

Retrieves the details of the flow run with the specified ID.

On success: Returns a FlowRunDetails object, regardless of whether the run is still in progress or has finished. A failed status does not itself raise an execution error.

Raises: ClientError, RateLimitError, ServerError, TimeoutError

Parameter Description

Parameter	Description
`flow_run_id`	Required. The ID of the flow run to retrieve. Has the format `frn-abc123...`

`flow_run_id`

Required. The ID of the flow run to retrieve.

Has the format frn-abc123...

`cancel_flow_run(flow_run_id)`

Cancels the flow run with the specified ID.

On success: Returns None.

Raises: ClientError, RateLimitError, ServerError, TimeoutError

Parameter Description

Parameter	Description
`flow_run_id`	Required. The ID of the flow run to cancel. Has the format `frn-abc123...`

`flow_run_id`

Required. The ID of the flow run to cancel.

Has the format frn-abc123...

Task types

`AwaitableTaskRun`

Represents a started task run returned by the async workflows.start_task method.

You can await this object to wait for completion and obtain a TaskRunDetails object:

Member Description

Member	Description
`id`	The task run's ID, available immediately. Has the format `trn-abc123...`.
`status`	The initial status of the task run, as a string. This value is usually `pending`. See Run status.
`is_terminal_status()`	Returns whether the initial `status` is terminal (one of `completed`, `failed`, or `canceled`).

`id`

The task run's ID, available immediately. Has the format trn-abc123....

`status`

The initial status of the task run, as a string. This value is usually pending.

See Run status.

`is_terminal_status()`

Returns whether the initial status is terminal (one of completed, failed, or canceled).

`TaskAttempt`

Represents one execution attempt of a particular task run. Returned in a TaskRun object's attempts list.

Each run's initial attempt has "attempt number" 0. If an attempt fails and the run retries, each retry creates a new attempt with an incremented number.

Property Description

Property	Description
`task_run_id`	The ID of the task run this attempt belongs to.
`attempt`	The zero-based "attempt number": `0` for the initial attempt, `1` for the first retry, and so on.
`status`	The current status of this attempt, as a `TaskRunStatus` enum value. See Run status.

`task_run_id`

The ID of the task run this attempt belongs to.

`attempt`

The zero-based "attempt number": 0 for the initial attempt, 1 for the first retry, and so on.

`status`

The current status of this attempt, as a TaskRunStatus enum value.

See Run status.

`TaskAttemptDetails`

Provides the full details of an individual attempt. Returned in the TaskRunDetails object's attempts list.

Includes all of the same properties as a TaskAttempt object, plus:

Property	Description
`error`	The error message if the attempt failed. Otherwise, this value is the empty string.
`results`	A list containing the attempt's return value, if it completed successfully. Otherwise, `None`.

`TaskRun`

Summarizes the state of a task run. Obtained in any of the following ways:

From the sync workflows.start_task method
The task_run property of a TaskRunWithCursor returned by workflows.list_task_runs

To obtain full details, including results, pass the run's ID to workflows.get_task_run.

Property	Description
`id`	The ID of the task run. Has the format `trn-abc123...`.
`task_id`	The ID of the run's associated task. Has the format `tsk-abc123...`.
`status`	The current status of the task run, as a `TaskRunStatus` enum value. See Run status.
`started_at`	The `datetime` when the task run was first created and queued for execution.
`completed_at`	The `datetime` when the task run finished (successfully or otherwise). This value is `UNSET` until the run reaches a terminal status.
`parent_task_run_id`	The ID of this run's parent run, if this run was chained. For a root-level run, this value is the empty string.
`parent_task_attempt`	The zero-based attempt number of the parent task run that chained this run. `0` indicates the parent's initial attempt, `1` its first retry, and so on. This value is `UNSET` for a root-level run.
`root_task_run_id`	The ID of the root task run in this run's execution chain. For a root-level run, this value matches `id`.
`retries`	The number of times the task run has retried so far. For a newly started run, this is `0`.
`attempts`	A list of `TaskAttempt` objects representing each execution attempt so far, including retries.

`TaskRunDetails`

Provides the full details of a task run. Obtained in any of the following ways:

Awaiting an AwaitableTaskRun returned by the async workflows.start_task method
Calling workflows.run_task
Calling workflows.get_task_run
Iterating over workflows.task_run_events

Includes all of the same properties as a TaskRun object, plus:

Property	Description
`results`	A list containing the task's return value(s). This value is `None` unless `status` is `completed`.
`input_`	The argument values that were passed to the task run, in one of the following formats: A list with values matching the positional arguments of the task's function signature An object with keys matching the named arguments of the task's function signature The format matches whichever format the task input was originally provided in. If this value is an object, you can call its `to_dict()` method to obtain a raw dictionary. Note the trailing underscore (`_`) in this property name.
`error`	The error message if the task run failed. Otherwise, `UNSET`.
`attempts`	A list of `TaskAttemptDetails` objects representing each individual execution attempt for this run.

`TaskRunWithCursor`

Represents an item returned by workflows.list_task_runs. It pairs a task run with its pagination cursor.

Property	Description
`task_run`	The `TaskRun` returned in this item.
`cursor`	The cursor associated with this item. Pass it as `ListTaskRunsParams(cursor=...)` to retrieve the next page of results.

Flow types

`FlowRun`

Summarizes the state of a flow run. Obtained in any of the following ways:

From the workflows.start_flow method (sync or async)
The flow_run property of a FlowRunWithCursor returned by workflows.list_flow_runs

To obtain full details, including results, pass the run's ID to workflows.get_flow_run.

Property	Description
`id`	The ID of the flow run. Has the format `frn-abc123...`.
`flow_id`	The ID of the run's associated flow. Has the format `flw-abc123...`.
`status`	The current status of the flow run, as a `FlowRunStatus` enum value.
`started_at`	The `datetime` when the flow run was first created and queued for execution.
`completed_at`	The `datetime` when the flow run finished (successfully or otherwise). This value is `UNSET` until the run reaches a terminal status.

`FlowRunDetails`

Provides the full details of a flow run. Obtained by calling workflows.get_flow_run.

Includes all of the same properties as a FlowRun object, plus:

Property	Description
`results`	A list containing the flow's return value(s). This value is an empty list unless `status` is `succeeded`.
`input_`	The argument values that were passed to the flow run, in one of the following formats: A list with values matching the positional arguments of the flow's function signature An object with keys matching the named arguments of the flow's function signature The format matches whichever format the flow input was originally provided in. If this value is an object, you can call its `to_dict()` method to obtain a raw dictionary. Note the trailing underscore (`_`) in this property name.
`error`	The error message if the flow run failed. Otherwise, `UNSET`.
`error_details`	Details for a determinism or limit error. See fields below. Otherwise, `UNSET`.
`attempts`	A list of objects representing each individual execution attempt for this run. See all supported fields below.
`attempts` fields
`attempt`	The zero-based "attempt number": `0` for the initial attempt, `1` for the first recovery attempt, and so on.
`status`	The current status of this attempt, as a `FlowRunStatus` enum value.
`started_at`	The `datetime` when the attempt started executing.
`completed_at`	The `datetime` when the attempt finished (successfully or otherwise). This value is `UNSET` until the attempt reaches a terminal status.
`error`	The error message if the attempt failed. Otherwise, `UNSET`.
`error_details` fields
`code`	The error code: `flow_determinism_error`, `flow_step_limit_exceeded`, `flow_payload_too_large`, or `flow_history_too_large`. Read the enum's `.value` property to obtain the string.
`message`	A description of the failure.
`seq`	The zero-based sequence number of the step that caused the determinism error.
`flow_attempt`	The zero-based "attempt number" associated with the determinism error.
`kind`	For determinism errors: `input_hash` (name or input changed), `type`, or `unknown_type`. Read the enum's `.value` property to obtain the string.
`expected, actual`	Descriptions of the recorded and attempted calls for a determinism error.
`limit, value`	The applicable limit and the value that exceeded it.

`FlowRunStatus`

The status of a flow run or flow attempt, as an enum value. Import it from render.client.types and read its .value property to obtain the status string.

A successful flow run has status succeeded (task runs use completed). The terminal statuses are succeeded, failed, and canceled.

Value	Description
`pending`	The run has been queued but has not yet started executing.
`running`	The run is currently executing.
`succeeded`	The run finished successfully.
`failed`	The run failed.
`canceled`	The run was canceled.

`FlowRunWithCursor`

Represents an item returned by workflows.list_flow_runs. It pairs a flow run with its pagination cursor.

Property	Description
`flow_run`	The `FlowRun` returned in this item.
`cursor`	The cursor associated with this item. Pass it as `ListFlowRunsParams(cursor=...)` to retrieve the next page of results.

Run status

For flow runs and attempts, see FlowRunStatus. The table below describes task runs and attempts.

The status property on TaskRun, TaskRunDetails, TaskAttempt, and TaskAttemptDetails is a TaskRunStatus enum value. Read its .value property to obtain the status string. The status property on AwaitableTaskRun is already a string.

For example, to check a returned run's status:

The exact meaning of each status differs for a task attempt and a task run, as shown:

Value	Task attempt	Task run
`pending`	The attempt has been queued but has not yet started executing.	The run's current attempt is `pending`.
`running`	The attempt is currently executing.	The run's current attempt is `running`.
`paused`	The attempt is waiting for the result of a chained run.	The run's current attempt is `paused`.
`completed`	The attempt finished successfully.	The run finished successfully.
`failed`	The attempt finished with an error.	All of the run's attempts have finished with an error and no retries remain.
`canceled`	The run was canceled before this attempt finished.	The run was canceled before it finished.

Error types

The Render SDK defines the custom error types below. In certain cases, the SDK also raises standard Python errors, such as ValueError and TypeError.

Client and task errors

`RenderError(Exception)`

The base class for custom Render SDK errors.

`ClientError(RenderError)`

Raised when a request to the Render API returns a 400-level error code.

Common causes include:

Invalid API key
Invalid task or flow identifier
Invalid task or flow arguments
Invalid action (for example, starting a run on a suspended workflow service)

`RateLimitError(ClientError)`

Raised when a request to the Render API returns a 429 (rate limit exceeded) error code.

`ServerError(RenderError)`

Raised when a request to the Render API returns a 500-level error code, and for network connection failures.

`TimeoutError(RenderError)`

Raised when a request to the Render API times out. This custom SDK definition is distinct from Python's built-in TimeoutError.

`ExecutionError(RenderError)`

The base class for errors from a failed task run or flow step.

`TaskRunError(ExecutionError)`

Raised in the following cases:

A chained run fails.
A run fails while awaiting an AwaitableTaskRun.
A run fails while calling workflows.run_task.

`FlowRunError(RenderError)`

Raised when a flow run fails or is canceled while calling workflows.run_flow.

Flow execution errors

These errors are raised during flow execution, such as during a call to ctx.step().

Import these errors from render.client.errors.

`TerminalFlowError(ExecutionError)`

Raised when a step fails after exhausting its retries. The flow run fails even if flow code catches the error.

For retry guidance, see Retry settings.

`DeterminismError(TerminalFlowError)`

Raised when a step call does not match the recorded history during replay. This fails the flow run even if flow code catches the error.

When available, the details object contains the following:

Property	Description
`step_key.seq`	The zero-based sequence number of the step that caused the determinism error.
`workflow_attempt`	The zero-based "attempt number" associated with the recorded step.
`kind`	How the replay differs from the recorded history. Read the enum's `.value` property to obtain the string: `input_hash`: The step's name or inputs changed. `type`: The type of step changed. `unknown_type`: The recorded step type is not recognized by the SDK.
`expected`	A description of the call recorded in the step history.
`actual`	A description of the call made during replay.

`FlowBadRequestError(TerminalFlowError)`

Raised when a step operation is rejected by the workflow system. The code property contains its error code, or None if no code was supplied.

The flow run fails even if flow code catches the error.

`FlowLimitError(FlowBadRequestError)`

Raised when a step operation exceeds a workflow limit. The flow run fails even if flow code catches the error.

The code identifies the limit, such as flow_payload_too_large. The limit and value properties contain the applicable limit and the value that exceeded it, or None if not supplied by the runtime.

Install

Workflow setup

The Workflows class

Constructor

Workflows(*, default_retry=None, default_timeout=None, default_plan=None)

default_retry

default_timeout

default_plan

Workflows.from_workflows(*apps, default_retry=None, default_timeout=None, default_plan=None)

*apps

default_retry

default_timeout

default_plan

The app.start() method

Workflows.start()

Defining tasks

The @app.task decorator

@app.task(*, name=None, retry=None, timeout_seconds=None, plan=None)

name

retry

timeout_seconds

plan

max_retries

wait_duration_ms

backoff_scaling

The TaskContext object

async TaskContext.run(task, *args, **kwargs)

task

*args

**kwargs

TaskContext.metadata

task_run_id

root_task_run_id

parent_task_run_id

Defining flows

The @app.flow decorator

@app.flow(*, name=None, timeout_seconds=None, plan=None)

name

timeout_seconds

plan

The FlowContext object

FlowContext.step(name, fn, /, *args, retry=None)

name

fn

*args

retry

max_retries

wait_duration_ms

backoff_scaling

FlowContext.metadata

flow_run_id

Triggering runs

Initialize the client (sync or async)

Render(*, token=None)

token

RenderAsync(*, token=None)

token

Task methods

start_task(task_slug, input_data, *, idempotency_key=None)

task_slug

input_data

idempotency_key

run_task(task_slug, input_data, *, idempotency_key=None)

task_slug

input_data

idempotency_key

list_task_runs(params=None)

limit

cursor

owner_id

get_task_run(task_run_id)

task_run_id

cancel_task_run(task_run_id)

task_run_id

task_run_events(task_run_ids)

task_run_ids

Flow methods

start_flow(flow_slug, input_data, *, idempotency_key=None)

flow_slug

input_data

The `Workflows` class

`Workflows(*, default_retry=None, default_timeout=None, default_plan=None)`

`default_retry`

`default_timeout`

`default_plan`

`Workflows.from_workflows(*apps, default_retry=None, default_timeout=None, default_plan=None)`

`*apps`

`default_retry`

`default_timeout`

`default_plan`

The `app.start()` method

`Workflows.start()`

The `@app.task` decorator

`@app.task(*, name=None, retry=None, timeout_seconds=None, plan=None)`

`name`

`retry`

`timeout_seconds`

`plan`

`max_retries`

`wait_duration_ms`

`backoff_scaling`

The `TaskContext` object

`async` `TaskContext.run(task, *args, **kwargs)`

`task`

`*args`

`**kwargs`

`TaskContext.metadata`

`task_run_id`

`root_task_run_id`

`parent_task_run_id`

The `@app.flow` decorator

`@app.flow(*, name=None, timeout_seconds=None, plan=None)`

`name`

`timeout_seconds`

`plan`

The `FlowContext` object

`FlowContext.step(name, fn, /, *args, retry=None)`

`name`

`fn`

`*args`

`retry`

`max_retries`

`wait_duration_ms`

`backoff_scaling`

`FlowContext.metadata`

`flow_run_id`

`Render(*, token=None)`

`token`

`RenderAsync(*, token=None)`

`token`

`start_task(task_slug, input_data, *, idempotency_key=None)`

`task_slug`

`input_data`

`idempotency_key`

`run_task(task_slug, input_data, *, idempotency_key=None)`

`task_slug`

`input_data`

`idempotency_key`

`list_task_runs(params=None)`

`limit`

`cursor`

`owner_id`

`get_task_run(task_run_id)`

`task_run_id`

`cancel_task_run(task_run_id)`

`task_run_id`

`task_run_events(task_run_ids)`

`task_run_ids`

`start_flow(flow_slug, input_data, *, idempotency_key=None)`

`flow_slug`

`input_data`

`idempotency_key`

`run_flow(flow_slug, input_data, *, idempotency_key=None)`

`flow_slug`

`input_data`

`idempotency_key`

`list_flow_runs(params=None)`

`limit`

`cursor`

`flow_slug`