Codex.Thread (Codex SDK v0.6.0)

Copy Markdown View Source

Represents a Codex conversation thread and exposes turn execution APIs.

Summary

Types

t()
user_input()
user_input_block()

Functions

rate_limits(thread)

Returns the most recent account rate limit snapshot for this thread, if any.

run(thread, input, opts \\ %{})

Executes a blocking multi-turn run using the agent runner.

run_auto(thread, input, opts \\ [])

Executes an auto-run loop, retrying while a continuation token is present.

run_streamed(thread, input, opts \\ %{})

Executes a run and returns a stream of events for progressive consumption.

Types

t()

@type t() :: %Codex.Thread{
  codex_opts: Codex.Options.t(),
  continuation_token: String.t() | nil,
  labels: map(),
  metadata: map(),
  pending_tool_failures: [map()],
  pending_tool_outputs: [map()],
  rate_limits: Codex.Protocol.RateLimit.Snapshot.t() | map() | nil,
  resume: :last | nil,
  thread_id: String.t() | nil,
  thread_opts: Codex.Thread.Options.t(),
  transport: :exec | {:app_server, pid()},
  transport_ref: reference() | nil,
  usage: map()
}

user_input()

@type user_input() :: String.t() | [user_input_block()]

user_input_block()

@type user_input_block() :: map()

Functions

rate_limits(thread)

@spec rate_limits(t()) :: Codex.Protocol.RateLimit.Snapshot.t() | map() | nil

Returns the most recent account rate limit snapshot for this thread, if any.

run(thread, input, opts \\ %{})

@spec run(t(), user_input(), map() | keyword()) ::
  {:ok, Codex.Turn.Result.t()} | {:error, term()}

Executes a blocking multi-turn run using the agent runner.

run_auto(thread, input, opts \\ [])

@spec run_auto(t(), String.t(), keyword()) ::
  {:ok, Codex.Turn.Result.t()} | {:error, term()}

Executes an auto-run loop, retrying while a continuation token is present.

Options:

  • :max_attempts – maximum number of attempts (default: 3)
  • :backoff – unary function invoked with current attempt (default: exponential sleep)
  • :turn_opts – per-turn options forwarded to each attempt

run_streamed(thread, input, opts \\ %{})

@spec run_streamed(t(), user_input(), map() | keyword()) ::
  {:ok, Codex.RunResultStreaming.t()} | {:error, term()}

Executes a run and returns a stream of events for progressive consumption.

The stream is lazy; events will not be produced until enumerated.