Skip to main content

Faraday research agent

Project description

Faraday Agent

PyPI version License: Apache 2.0

Accelerating science with agentic AI for research and drug design

Faraday is an AI scientist that carries out research workflows end to end:

Install

pip install faradayai

Credentials

Set a model API key before running. Faraday supports OpenAI, OpenRouter, and Azure OpenAI.

OpenAI (default)

export OPENAI_API_KEY=...

OpenRouter

export OPENROUTER_API_KEY=...
# faraday.yaml
llm:
  provider: openrouter
  model: openai/gpt-5
  api_key_env: OPENROUTER_API_KEY

Azure OpenAI

# faraday.yaml
llm:
  provider: azure
  model: gpt-5
  api_key: OPENAI_API_KEY
  base_url: AZURE_OPENAI_BASE_URL
  api_version: preview

Run faraday --check-tools to verify keys and tool availability after setup.


Quickstart

Run a one-shot task:

faraday "Summarize structure–activity relationships across KRAS inhibitors, focusing on motifs that improve binding affinity and selectivity"

Interactive mode:

faraday

With a config file:

faraday --config faraday.example.yaml "Your task here"

Results are written to ./run_outputs/ by default:

run_outputs/
  run_{timestamp}_{chat_id}_{query_id}/
    agent_outputs/       # files, plots, and generated artifacts
    run_artifacts/
      events.jsonl       # timestamped stream of every agent event
      metadata.json      # run parameters (model, steps, config)
      result.json        # final answer and run summary
      trajectory.json    # full trajectory for replay

Useful flags: --model, --max-steps, --debug, --check-tools, --app-mode, --sandbox-backend, --batch-file, --use-docker. See faraday --help for the full list.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

faradayai-0.1.4.tar.gz (159.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

faradayai-0.1.4-py3-none-any.whl (185.9 kB view details)

Uploaded Python 3

File details

Details for the file faradayai-0.1.4.tar.gz.

File metadata

  • Download URL: faradayai-0.1.4.tar.gz
  • Upload date:
  • Size: 159.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.8

File hashes

Hashes for faradayai-0.1.4.tar.gz
Algorithm Hash digest
SHA256 8a164f00219f056d0baf129131da20e00c375c6de3268b327cd825aa018b65c5
MD5 e714a2fd1c8c171b77f80b78c3a6738c
BLAKE2b-256 5660a648c685ae1207045aaf640a6975af6d81ae7c28acc6577dc61f3a3aa38f

See more details on using hashes here.

File details

Details for the file faradayai-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: faradayai-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 185.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.8

File hashes

Hashes for faradayai-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 9e35d8cb959345759e949fa341b914b1e620e63fd3d9a24a53fb5ff59248f020
MD5 d6d7ab59a1b12d8044fa186159e7ba6d
BLAKE2b-256 0112cc312177ec9dc14f49c858241369894a272241906dc78a03b4cfbed0938d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page