Get full step output from instance

workflows.instances.step(, ) -> InstanceStepResponse

GET/accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/step

Retrieves the full, untruncated output for a specific step on a workflow instance. Returns a flat status-shaped JSON body with step status (‘running’ | ‘waiting’ | ‘complete’ | ‘errored’), error (nullable), and output (the step value, or null while running/waiting/errored). When the step returned a ReadableStream from step.do, the response is served as ‘application/octet-stream’ with the raw bytes as the body instead of JSON. A status='running' response with non-null error indicates the step is currently retrying after a prior attempt failed.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Workers Tail ReadWorkers Scripts WriteWorkers Scripts Read

ParametersExpand Collapse

account_id: str

workflow_name: str

maxLength64

minLength1

instance_id: str

maxLength100

minLength1

name: str

Exact step name from the instance logs response, including the generated counter suffix.

minLength1

type: Literal["step", "waitForEvent"]

Step type to disambiguate step.do and waitForEvent entries that share the same name.

One of the following:

"step"

"waitForEvent"

attempt: Optional[int]

Specific attempt number to retrieve output or error for.

exclusiveMinimum

minimum0

ReturnsExpand Collapse

class InstanceStepResponse: …

error: Optional[Error]

Error details when status=‘errored’; null otherwise.

message: str

name: str

status: Literal["queued", "running", "paused", 6 more]

One of the following:

"queued"

"running"

"paused"

"errored"

"terminated"

"complete"

"waitingForPause"

"waiting"

"rollingBack"

output: Optional[object]

Full step output or waitForEvent payload without truncation. Sensitive outputs are returned as ‘[REDACTED]’. Populated when status=‘complete’. May be a ReadableStream when the step returned one from step.do; stream outputs are served as application/octet-stream rather than JSON.

Get full step output from instance

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
response = client.workflows.instances.step(
    instance_id="x",
    account_id="account_id",
    workflow_name="x",
    name="x",
    type="step",
)
print(response.error)

{
  "errors": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "result": {
    "error": {
      "message": "message",
      "name": "name"
    },
    "status": "queued",
    "output": {}
  },
  "success": true,
  "result_info": {
    "count": 0,
    "per_page": 0,
    "total_count": 0,
    "cursor": "cursor",
    "page": 0,
    "total_pages": 0
  }
}

Returns Examples

{
  "errors": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 0,
      "message": "message"
    }
  ],
  "result": {
    "error": {
      "message": "message",
      "name": "name"
    },
    "status": "queued",
    "output": {}
  },
  "success": true,
  "result_info": {
    "count": 0,
    "per_page": 0,
    "total_count": 0,
    "cursor": "cursor",
    "page": 0,
    "total_pages": 0
  }
}