# `PromptRunner`
[🔗](https://github.com/nshkrdotcom/prompt_runner_sdk/blob/v0.6.1/lib/prompt_runner.ex#L1)

Public API for building plans and executing prompt runs.

# `plan`

```elixir
@spec plan(
  term(),
  keyword()
) :: {:ok, PromptRunner.Plan.t()} | {:error, term()}
```

# `run`

```elixir
@spec run(
  term(),
  keyword()
) :: {:ok, PromptRunner.Run.t()} | {:error, term()}
```

# `run_prompt`

```elixir
@spec run_prompt(
  String.t(),
  keyword()
) :: {:ok, PromptRunner.Run.t()} | {:error, term()}
```

# `scaffold`

```elixir
@spec scaffold(
  term(),
  keyword()
) :: {:ok, map()} | {:error, term()}
```

# `validate`

```elixir
@spec validate(
  term(),
  keyword()
) :: :ok | {:error, term()}
```

---

*Consult [api-reference.md](api-reference.md) for complete listing*