# Ergoly Docs

> How to run an agency on Ergoly: workers you own, one per client, inside the Slack you already use. Written for the person who runs the agency, in the words the control app uses.

Each page is served as Markdown at the .md path below, and all of them together at https://www.ergoly.ai/docs/llms-full.txt. The platform API documents itself at https://control.ergoly.ai/api/v1.

## Overview

- [Ergoly](https://www.ergoly.ai/docs/index.md): Workers you own, one per client, inside the Slack your agency already uses. What that means and where to start.
- [A day with a worker](https://www.ergoly.ai/docs/a-day-with-a-worker.md): One worker, two clients, one morning. What it looks like from inside Slack.

## Getting started

- [Getting started](https://www.ergoly.ai/docs/getting-started.md): From the invitation to your first worker answering in Slack. Four steps, most of them in Slack.
- [Getting access](https://www.ergoly.ai/docs/getting-started/access.md): Onboarding with the Ergoly team: an invitation to control and a shared channel in Slack.
- [Meet your AI Admin](https://www.ergoly.ai/docs/getting-started/ai-admin.md): Connect Slack, name it, install it. It messages you and sets up your company and your first worker from there.
- [Add a client and a channel](https://www.ergoly.ai/docs/getting-started/first-client.md): Tell the AI Admin who the client is, and which Slack channel is theirs. From then on, the worker answers there as your agency.
- [Your first correction](https://www.ergoly.ai/docs/getting-started/first-correction.md): Say what you want done differently, once. The worker writes it down and files it with the right client, the right worker, or the whole company.

## Company

- [Company](https://www.ergoly.ai/docs/company.md): Your agency on Ergoly: the chart of people and workers, the teams and clients, the settings, and who can do what.
- [Chart](https://www.ergoly.ai/docs/company/chart.md): An org chart that holds people and workers side by side. Drag to place, and the chart decides who a worker turns to when it needs a person.
- [Members](https://www.ergoly.ai/docs/company/members.md): People and workers are listed side by side. Who can sign in to control is a separate list.
- [Teams](https://www.ergoly.ai/docs/company/teams.md): Three kinds of team: your own, a client, and a vendor. Each holds different things.
- [Settings](https://www.ergoly.ai/docs/company/settings.md): Six tabs: Slack, Members, API keys, Avatars, Email, and Tasks.
- [Access](https://www.ergoly.ai/docs/company/access.md): Three ways into your company: a person in control, the AI Admin in Slack, and an API key.

## Workers

- [Workers](https://www.ergoly.ai/docs/workers.md): An AI member of your company. It has a name, a job, responsibilities and behaviors you set, and a separate copy for each client it serves.
- [Identity](https://www.ergoly.ai/docs/workers/identity.md): A name, an avatar, a Slack app, and an email address. Change any of them from the worker's Settings tab.
- [Role](https://www.ergoly.ai/docs/workers/role.md): The job title, and the one-line job it does. A worker is a role, not an automation.
- [Responsibilities](https://www.ergoly.ai/docs/workers/responsibilities.md): The list of what a worker is trained for and accountable for. Requests outside the list are outside its job.
- [Behaviors](https://www.ergoly.ai/docs/workers/behaviors.md): What a worker follows day to day, as Avoid, Don't, Prefer and Use lines. Read every turn, changed only by agreement.
- [Response policy](https://www.ergoly.ai/docs/workers/response-policy.md): When a worker speaks: only when @-mentioned, or to anything it judges is for it. And whether it listens when not addressed.
- [Reporting](https://www.ergoly.ai/docs/workers/reporting.md): Who a worker reports to on the chart, and who it takes a question to when it needs a person.
- [Access](https://www.ergoly.ai/docs/workers/access.md): Who can talk to a worker, and which clients it serves. Set on the Clients tab.
- [Triaging](https://www.ergoly.ai/docs/workers/triaging.md): When a worker is slow, silent or stuck: what the Triage tab shows, and the three buttons that fix most things.
- [Channels](https://www.ergoly.ai/docs/workers/channels.md): Where a worker operates: Slack, email, and the web. And the events in those channels that make it act.
- [Slack](https://www.ergoly.ai/docs/workers/channels/slack.md): Each worker is a member of your workspace. Every channel it is in belongs to one client or to your team, and that decides what it knows there.
- [Internal channels](https://www.ergoly.ai/docs/workers/channels/slack/internal-channels.md): Your team's own channels. The worker answers from everything it knows, including every client.
- [Client channels](https://www.ergoly.ai/docs/workers/channels/slack/client-channels.md): A channel that belongs to one client. The worker answers there as your agency, from that client's world and nothing else.
- [DMs](https://www.ergoly.ai/docs/workers/channels/slack/dms.md): A direct message is always answered. Who you are decides which copy of the worker answers.
- [Group DMs](https://www.ergoly.ai/docs/workers/channels/slack/group-dms.md): A message to the worker and a few people at once. The people in it decide which client it is about.
- [Email](https://www.ergoly.ai/docs/workers/channels/email.md): Every worker has an email address and can send from it. Receiving is coming soon.
- [Receiving email](https://www.ergoly.ai/docs/workers/channels/email/receiving.md) (coming soon): A worker reading mail sent to its address, and acting on it.
- [Web](https://www.ergoly.ai/docs/workers/channels/web.md): Ways for other systems to reach a worker: a hook it listens on, triggers from connected tools, and the API.
- [Triggers](https://www.ergoly.ai/docs/workers/channels/web/triggers.md) (coming soon): An event inside a connected tool that starts a worker: a new deal, a new ticket, a changed row.
- [Events](https://www.ergoly.ai/docs/workers/channels/events.md): Everything that makes a worker act. Each one ends with an answer back where it came from.
- [Knowledge](https://www.ergoly.ai/docs/workers/knowledge.md): What a worker knows: its memory and its skills. Both are files you can read and edit.
- [Memory](https://www.ergoly.ai/docs/workers/knowledge/memory.md): Your worker remembers what you tell it. A note about Acme stays with Acme; a rule for the whole agency applies everywhere.
- [Skills](https://www.ergoly.ai/docs/workers/knowledge/skills.md): A saved way of doing a piece of work. Written by you in any editor, or by the worker when it has done something more than once.
- [Connections](https://www.ergoly.ai/docs/workers/connections.md): How a worker uses the tools it has been given. The tools themselves are set up under Work.

## Clients

- [Clients](https://www.ergoly.ai/docs/clients.md): A customer of yours. Assign a worker to a client and that client gets its own copy, with its own memory and nothing of any other client's.
- [Adding a client](https://www.ergoly.ai/docs/clients/adding.md): Three ways: ask your AI Admin, press New Client, or let a worker create one when it joins a channel.
- [Assigning a worker](https://www.ergoly.ai/docs/clients/assigning-a-worker.md): Bind a worker to a client, with at least one channel or person. That creates the client's own copy of the worker.
- [Client separation](https://www.ergoly.ai/docs/clients/separation.md): What a client's copy of a worker can see, what it cannot, and what a client's contact can do.
- [Internal client channels](https://www.ergoly.ai/docs/clients/internal-channels.md): Backstage: a channel of your own where the team reviews a worker's drafts for a client before the worker is in front of that client.

## Work

- [Work](https://www.ergoly.ai/docs/work.md): What a worker does between conversations: tasks and routines, the tools it is connected to, approvals, and the pages it publishes.
- [Tasks](https://www.ergoly.ai/docs/work/tasks.md): A piece of work with someone who asked and someone doing it. Hand it to a worker or a person, follow it on its log, and say where the result goes.
- [Routines](https://www.ergoly.ai/docs/work/routines.md): A task that repeats. Describe it once, say where results go, and point it at every client it should run for.
- [Connections](https://www.ergoly.ai/docs/work/connections.md): The apps, keys and tool servers your company has connected, and who may use each one.
- [Connecting a tool](https://www.ergoly.ai/docs/work/connections/connecting-a-tool.md): Press Add Connection, pick the app, choose who may use it, and sign in or paste a key.
- [Placement](https://www.ergoly.ai/docs/work/connections/placement.md): Who may use a connection: the whole company, one worker, one client, or one worker for one client. The narrowest match wins.
- [Keys and tools](https://www.ergoly.ai/docs/work/connections/keys-and-tools.md): What happens when you paste a key, and what a worker can then do with the app.
- [Custom tools](https://www.ergoly.ai/docs/work/connections/custom-tools.md): Any tool server by its URL, or any API by its base URL, when the catalog does not list the app.
- [Credential safety](https://www.ergoly.ai/docs/work/connections/credential-safety.md): A worker never holds a password or a key. The credential is added to the request on the way out, by a part of Ergoly the worker cannot reach.
- [Approvals](https://www.ergoly.ai/docs/work/approvals.md): A worker asks before it acts when you tell it to, and on its own for anything hard to undo. The decision is recorded. The activity feed holds everything else.
- [Artifacts](https://www.ergoly.ai/docs/work/artifacts.md): A web page a worker publishes with a link: a report, a dashboard, a one-pager. Private to your company by default, or open to anyone with the link.
- [Collaboration](https://www.ergoly.ai/docs/work/artifacts/collaboration.md) (coming soon): Commenting on an artifact, and the worker picking the comments up.

## Technical details

- [Technical details](https://www.ergoly.ai/docs/technical.md): What happens behind the words in these docs, for the engineer at your agency or anyone on the API.
- [How a worker runs](https://www.ergoly.ai/docs/technical/how-a-worker-runs.md): A worker is one identity. Each client it serves gets a separate running copy, and each message it handles is one turn.
- [Where knowledge lives](https://www.ergoly.ai/docs/technical/where-knowledge-lives.md): Memory and skills are files in five tiers, and when two tiers disagree the narrowest one wins.
- [How a channel reaches a worker](https://www.ergoly.ai/docs/technical/how-a-channel-reaches-a-worker.md): Every Slack message is routed to one copy of one worker by a fixed rule, before any model runs.
- [How credentials are held](https://www.ergoly.ai/docs/technical/how-credentials-are-held.md): A worker never holds a password or a key. A gateway puts the secret into the request on the way out.
- [The API](https://www.ergoly.ai/docs/technical/api.md): One key per company, one header, one envelope. The reference is served by the API itself.
- [Glossary](https://www.ergoly.ai/docs/technical/glossary.md): The docs' word, the API's name, and the internal word, side by side.