Documentation

Everything you need to run Ankole

Deploy Ankole, learn the runtime model, and operate a private deployment instance that you control.

Start with the introduction

01Getting started

IntroductionWhat Ankole is, how autonomous labor differs from a copilot, and the parts in a private deployment instance.
Quick startDeploy Ankole, set up enterprise identity and models, connect an IM channel, and complete a real Agent conversation.

02User guide

Environment variablesUse the Console to configure the environment variables that command-line tools, MCP servers, and Background Agent Jobs need.
AgentsCreate an Agent in the Console, then configure its role, durable behavior, models, capabilities, and environment variables.
Signal routing rulesConnect a chat application to an Agent and select how it handles group messages and memory.
Background Agent JobsDelegate long work to a resumable background Job while the current conversation remains available.
SchedulesUse Cron for recurring work or Checkback for a one-time delayed follow-up.
Image generationSelect an image model for an Agent and generate or edit images in chat.
Webhook delegationsLet an Agent or deterministic script wait for a low-volume external event without polling.
Long-term memoryLearn how Ankole turns conversations, tasks, and external sources into evolving memory, and how to inspect and correct Agent knowledge and Skill experience.
File managementUpload reference material, download Agent artifacts, and manage durable Agent files in the Console.
Agent LibraryEnable Agent Plugins, Skills, and Control Plane Plugins globally or for one Agent.
Web toolsConfigure web search and page reading for an Agent, and know when to use a browser instead.
ChatGPT subscription providerConnect ChatGPT subscriptions to AIGateway with device login and a shared credential pool.
Let an Agent read imagesConfigure image understanding for an Agent and verify screenshots, photos, and charts from chat.
AppConfigureManage Ankole AppConfigure runtime settings in the Console and reference the built-in keys.
Principals and permission groupsSync people and the organization directory, then assign access with directory, static, or computed groups.
WorkersCheck Agent Computer Worker state, capacity, and heartbeat in the Console, and resolve common failures.
Read logsGet Ankole logs from Docker Compose or Kubernetes, then use event names and context fields to locate a failure.

Everything you need to run Ankole

01Getting started

02User guide

03Developer guide

04Reference

05Guides