ol.llx.agent :: Outskirts Labs Docs

create-initial-state

clj

platforms: clj

(create-initial-state schema-registry schema-config opts)

source

cljs

platforms: cljs

(create-initial-state schema-registry schema-config opts)

source

default-convert-to-llm

clj

platforms: clj

(default-convert-to-llm messages)

Converts agent messages to LLM-compatible messages by keeping only maps whose :role is one of :user, :assistant, or :tool-result.

source

cljs

platforms: cljs

(default-convert-to-llm messages)

Converts agent messages to LLM-compatible messages by keeping only maps whose :role is one of :user, :assistant, or :tool-result.

source

create-agent

clj

platforms: clj

(create-agent)
(create-agent opts)

Creates an agent runtime handle.

Required options:
- `:tools`             vector of tools

`opts` may include:
- `:convert-to-llm`    `(fn [messages])`; defaults to filtering
                       messages to roles `:user`, `:assistant`,
                       `:tool-result`
- `:transform-context` optional context transform hook
- `:stream-fn`         optional stream hook; resolved at callsite
- `:schema-registry`   user-owned extra Malli schemas
- `:custom-message-schemas` user-owned custom message dispatch map
- `:session-id`, `:get-api-key`, `:thinking-budgets`, `:max-retry-delay-ms`
- `:system-prompt`, `:model`, `:thinking-level`
- `:steering-mode`, `:follow-up-mode`
- `:abort-signal`

For state rehydration, use rehydrate-agent.

source

cljs

platforms: cljs

(create-agent)
(create-agent opts)

Creates an agent runtime handle.

Required options:
- `:tools`             vector of tools

`opts` may include:
- `:convert-to-llm`    `(fn [messages])`; defaults to filtering
                       messages to roles `:user`, `:assistant`,
                       `:tool-result`
- `:transform-context` optional context transform hook
- `:stream-fn`         optional stream hook; resolved at callsite
- `:schema-registry`   user-owned extra Malli schemas
- `:custom-message-schemas` user-owned custom message dispatch map
- `:session-id`, `:get-api-key`, `:thinking-budgets`, `:max-retry-delay-ms`
- `:system-prompt`, `:model`, `:thinking-level`
- `:steering-mode`, `:follow-up-mode`
- `:abort-signal`

For state rehydration, use rehydrate-agent.

source

rehydrate-agent

clj

platforms: clj

(rehydrate-agent state opts)

Creates an agent runtime from a previously persisted state snapshot.

 `state` must satisfy `:ol.llx.agent.loop/state`.
 `opts` carries runtime dependencies and may include:
 - `:convert-to-llm` (optional; see <<create-agent,`create-agent`>>)
 - `:transform-context` (optional; see <<create-agent,`create-agent`>>)
 - `:stream-fn` (optional; see <<create-agent,`create-agent`>>)
 - `:session-id`, `:get-api-key`, `:thinking-budgets`, `:max-retry-delay-ms`
- `:tools`
- `:abort-signal`.

source

cljs

platforms: cljs

(rehydrate-agent state opts)

Creates an agent runtime from a previously persisted state snapshot.

 `state` must satisfy `:ol.llx.agent.loop/state`.
 `opts` carries runtime dependencies and may include:
 - `:convert-to-llm` (optional; see <<create-agent,`create-agent`>>)
 - `:transform-context` (optional; see <<create-agent,`create-agent`>>)
 - `:stream-fn` (optional; see <<create-agent,`create-agent`>>)
 - `:session-id`, `:get-api-key`, `:thinking-budgets`, `:max-retry-delay-ms`
- `:tools`
- `:abort-signal`.

source

state

clj

platforms: clj

(state agent)

Returns the current agent state snapshot.

source

cljs

platforms: cljs

(state agent)

Returns the current agent state snapshot.

source

clj

platforms: clj

(subscribe agent)
(subscribe agent ch)

Subscribes a channel to the agent event stream.

(subscribe agent) creates and returns a buffered channel.
(subscribe agent ch) taps the provided channel and returns it.

source

cljs

platforms: cljs

(subscribe agent)
(subscribe agent ch)

Subscribes a channel to the agent event stream.

(subscribe agent) creates and returns a buffered channel.
(subscribe agent ch) taps the provided channel and returns it.

source

unsubscribe

clj

platforms: clj

(unsubscribe agent ch)

Unsubscribes a channel from the agent event stream and closes it.

source

cljs

platforms: cljs

(unsubscribe agent ch)

Unsubscribes a channel from the agent event stream and closes it.

source

prompt

clj

platforms: clj

(prompt agent messages)

Submits a prompt command to the agent runtime.

source

cljs

platforms: cljs

(prompt agent messages)

Submits a prompt command to the agent runtime.

source

continue

clj

platforms: clj

(continue agent)

Submits a continue command to the agent runtime.

source

cljs

platforms: cljs

(continue agent)

Submits a continue command to the agent runtime.

source

abort

clj

platforms: clj

(abort agent)

Submits an abort command to the agent runtime.

source

cljs

platforms: cljs

(abort agent)

Submits an abort command to the agent runtime.

source

steer

clj

platforms: clj

(steer agent messages)

Queues steering messages.

source

cljs

platforms: cljs

(steer agent messages)

Queues steering messages.

source

follow-up

clj

platforms: clj

(follow-up agent messages)

Queues follow-up messages.

source

cljs

platforms: cljs

(follow-up agent messages)

Queues follow-up messages.

source

wait-for-idle

clj

platforms: clj

(wait-for-idle agent)
(wait-for-idle agent max-polls)

Waits until the agent reaches :ol.llx.agent.loop/idle or :ol.llx.agent.loop/closed.

Resolves `true` when idle/closed, or `false` after the polling budget is
exhausted.

source

cljs

platforms: cljs

(wait-for-idle agent)
(wait-for-idle agent max-polls)

Waits until the agent reaches :ol.llx.agent.loop/idle or :ol.llx.agent.loop/closed.

Resolves `true` when idle/closed, or `false` after the polling budget is
exhausted.

source

set-system-prompt

clj

platforms: clj

(set-system-prompt agent system-prompt)

source

cljs

platforms: cljs

(set-system-prompt agent system-prompt)

source

set-model

clj

platforms: clj

(set-model agent model)

source

cljs

platforms: cljs

(set-model agent model)

source

set-thinking-level

clj

platforms: clj

(set-thinking-level agent thinking-level)

source

cljs

platforms: cljs

(set-thinking-level agent thinking-level)

source

set-tools

clj

platforms: clj

(set-tools agent tools)

source

cljs

platforms: cljs

(set-tools agent tools)

source

set-schema-config

clj

platforms: clj

(set-schema-config agent schema-config-update)

Replaces the agent’s user-owned schema configuration.

schema-config-update may include :schema-registry and/or :custom-message-schemas. nil for either field preserves the current user-owned value.

This setter is accepted in any phase. It affects future validation and future tool execution only; already queued messages and already running tool executions keep using the registry they started with.

source

cljs

platforms: cljs

(set-schema-config agent schema-config-update)

Replaces the agent’s user-owned schema configuration.

schema-config-update may include :schema-registry and/or :custom-message-schemas. nil for either field preserves the current user-owned value.

This setter is accepted in any phase. It affects future validation and future tool execution only; already queued messages and already running tool executions keep using the registry they started with.

source