API Reference

API Reference#

Reference for gptme’s Python API, generated from docstrings. It is most useful when writing plugins, tools, or providers, or when embedding gptme in another program. To drive gptme from scripts, Automation is usually simpler.

  • Core — messages, code blocks, and conversation logs

  • LLMs and Models — LLM providers, model metadata, and model resolution

  • Tools — ToolSpec and tool loading

  • Config — user, project, and conversation configuration

  • Plugins — the GptmePlugin interface

  • Commands — slash-command registration

  • Profiles — agent profiles

  • Memory — the cross-harness memory store

  • Prompts — system prompt construction

  • Server — the gptme-server package

Hooks and context compression providers are documented alongside their guides: see API Reference and Context Compression.