Getting Started

Build your first AI agent in minutes

1 Add Dependencies

mix.exs
defp deps do
  [
    {:jido, "~> 2.0"},
    {:jido_ai, "~> 2.0"}
  ]
end

2 Fetch Dependencies

terminal
$ mix deps.get

3 Define Your Weather Agent

lib/my_app/weather_agent.ex
defmodule MyApp.WeatherAgent do
  use Jido.AI.Agent,
    name: "weather_agent",
    description: "Weather Q&A agent",
    tools: [
      Jido.Tools.Weather,
      Jido.Tools.Weather.ByLocation,
      Jido.Tools.Weather.Forecast,
      Jido.Tools.Weather.CurrentConditions,
      Jido.Tools.Weather.Geocode
    ],
    system_prompt: ~S|You are a weather planning assistant.
    Use weather tools to answer with practical advice.|
end

4 Run It in IEx

iex -S mix
iex> {:ok, pid} = Jido.AgentServer.start(agent: MyApp.WeatherAgent)

iex> {:ok, request} = MyApp.WeatherAgent.ask(pid, "What's the weather in Tokyo?")
iex> {:ok, answer} = MyApp.WeatherAgent.await(request)

iex> {:ok, answer} = MyApp.WeatherAgent.ask_sync(pid, "Should I bring an umbrella?")
READ THE DOCS →