v1

latestOpenAPI 3.1.02026-07-17193883.6 KB
agent

Agent Stream Log

Invoke the runnable stream_log the output.

This endpoint allows to stream the output of the runnable, including the output of all intermediate steps.

The endpoint uses a server sent event stream to stream the output.

https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events

Important: Set the "text/event-stream" media type for request headers if not using an existing SDK.

This endpoint uses two different types of events:

  • data - for streaming the output of the runnable

    { "event": "data", "data": { ... } }

  • error - for signaling an error in the stream, also ends the stream.

{ "event": "error", "data": { "status_code": 500, "message": "Internal Server Error" } }

  • end - for signaling the end of the stream.

    This helps the client to know when to stop listening for events and know that the streaming has ended successfully.

    { "event": "end", }

post/agent/stream_log

Query parameters

config_hashstring

Request body

configAgentLangGraphConfig
include_namesstring[] nullable

If specified, filter to runnables with matching names

include_typesstring[] nullable

If specified, filter to runnables with matching types

include_tagsstring[] nullable

If specified, filter to runnables with matching tags

exclude_namesstring[] nullable

If specified, exclude runnables with matching names

exclude_typesstring[] nullable

If specified, exclude runnables with matching types

exclude_tagsstring[] nullable

If specified, exclude runnables with matching tags

kwargsobject

Response

Successful Response

{"stackTrail":"paths:/agent/stream_log:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}