For the complete documentation index, see llms.txt. This page is also available as Markdown.

Logs

Get Step Logs

get

Get log entries for a step.

Args: step_id: ID of the step for which to get the logs. source: The source of the logs to get. logs_id: The ID of the logs to get.

Returns: List of log entries.

Raises: ValueError: If both source and logs_id are provided. KeyError: If no logs are available for this step.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
step_idstring · uuidRequired
Query parameters
sourcestring · nullableOptional
logs_idstring · uuid · nullableOptional
Responses
200

Successful Response

application/json

A structured log entry with parsed information.

This is used in two distinct ways: 1. If we are using the artifact log store, we save the entries as JSON-serialized LogEntry's in the artifact store. 2. When queried, the server returns logs as a list of LogEntry's.

messagestringRequired

The log message content

namestring · nullableOptional

The name of the logger

levelinteger · enum · nullableOptional

The log level

Possible values:
timestampstring · date-time · nullableOptional

When the log was created

modulestring · nullableOptional

The module that generated this log entry

filenamestring · nullableOptional

The name of the file that generated this log entry

linenointeger · nullableOptional

The fileno that generated this log entry

chunk_indexintegerOptional

The index of the chunk in the log entry

Default: 0
total_chunksintegerOptional

The total number of chunks in the log entry

Default: 1
idstring · uuidOptional

The unique identifier of the log entry

get/api/v1/steps/{step_id}/logs
GET /api/v1/steps/{step_id}/logs HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
  {
    "message": "text",
    "name": "text",
    "level": 0,
    "timestamp": "2026-01-01T00:00:00.000Z",
    "module": "text",
    "filename": "text",
    "lineno": 1,
    "chunk_index": 0,
    "total_chunks": 1,
    "id": "123e4567-e89b-12d3-a456-426614174000"
  }
]
ZenML Scarf

Last updated

Was this helpful?