TypeScript SDKFeature Clients

Logs Client

The logs client is a client for interacting with Hatchet's logs API.

Methods

list()

Lists the logs for a given task run.

Parameters

ParameterTypeDescription
taskRunIdstringThe ID of the task run to list logs for.
opts?ListLogsOptsThe options filter for the list operation.

Returns

Promise<V1LogLineList>

A promise that resolves to the list of logs.

Type Aliases

ListLogsOpts

type ListLogsOpts = object;

The options for the list logs operation.

Properties

PropertyTypeDescription
attempt?numberFilter logs by attempt number.
levels?V1LogLineLevel[]Filter logs by log level.
limit?numberThe maximum number of log lines to return.
orderByDirection?V1LogLineOrderByDirectionThe direction to order the logs by.
search?stringFilter logs by a search string.
since?DateReturn only logs after this date.
until?DateReturn only logs before this date.

Last updated on September 1, 2026

On this page