Documentation
What the product does and how to run it, page by page. The same files ship with the framework.
Using Botseon
Start here
- Using BotseonMember·5 minWhere to start in Botseon, organised by what you are trying to do, not by menu location.
- Your first ten minutesMember·4 minYour first ten minutes: sign in, make a bot, send it a job and watch it work.
- Sign inMember·7 minHow sign-in works, the four provider buttons, and what each error message means.
- The member security baselineMember·2 minThe handful of security choices worth making in your first session, in member terms.
Conversations
Bots
- Make a bot, and set it upMember·5 minMaking a bot and setting it up: the editor, duplicate behaviour and choosing a model.
- Give a bot a voiceMember·4 minGiving a bot a voice: turning it on, choosing a voice and what changes in a call.
- Share a bot with the teamMember·4 minSharing a bot with the team: who can edit it, who can only use it, and how to tell.
Approvals and safety
Routines and skills
- Make a routineMember·6 minMaking a routine: the trigger, the steps, and a checklist for building one you trust.
- When a routine stopsMember·3 minWhen a routine stops: reading the notice text and the usual fixes for each one.
- Teach a taskMember·4 minTeaching a task: the consent banner, the steps recorded, and what is never recorded.
The computer
Templates
Notifications
- NoticesMember·3 minNotices: the two-gate rule for a push alert, and where every notice ends up.
- Email Botseon sends youMember·3 minEvery email Botseon sends you, what triggers it, and how to turn each one off.
- The daily digestMember·3 minThe daily digest: what it summarises, when it sends, and how to change its schedule.
Account and billing
- Your account and settingsMember·4 minYour account and settings: the full tree, with a screenshot for each section.
- The desktop appMember·5 minThe desktop app: the update track, and exactly what an update does not touch.
- The phone appMember·5 minThe phone app: what it can do today next to the desktop app, in one parity table.
- Plans and the trialMember·5 minPlans and the trial: what each plan includes and how long the trial runs.
- Usage, the meter and spend capsMember·5 minUsage, the meter and spend caps: worked arithmetic for a typical month.
Getting help
Administration
- AdministrationAdministrator·2 minAn administrator's section: members, policies, residency and fleet management, in one place.
- The administrator security baselineAdministrator·9 minThe eight settings an administrator reviews before the first member signs in, and where each one lives.
- Identity and device trustAdministrator·4 minHow members sign in, the identity-provider rule a bot computer needs, and what a revocation ends.
- Team Setup manifestsAdministrator·2 minManifests of setup scripts that run on every team computer: the shape, the approval and the results.
- Reaching a private networkAdministrator·2 minReaching internal services from a bot computer through a mesh or tunnel client you operate.
- Reading the security-review documentsAdministrator·3 minHow to read the generated compliance documents and the audit export when answering a security review.
- Downloading and updating the desktop app for a fleetAdministrator·2 minThe desktop artefacts, the signed update feed and the update track, for a fleet of managed machines.
- Members and access requestsAdministrator·4 minMembers and access requests: the join domain, invitations and the request queue.
- Organisation policiesAdministrator·5 minOrganisation policies: every control listed with the audit row it writes.
- Data residency and rightsAdministrator·5 minData residency and rights: where data is stored, the retention schedule and the DPA.
API
Getting started
- APIDeveloper·3 minThe Botseon API: where to start, how it is organised, and what each resource covers.
- Make your first callDeveloper·4 minMaking your first call: creating a key and sending one authenticated request.
- Authentication and keysDeveloper·5 minAuthentication and keys: the header format, key scopes and how to rotate a key.
- Envelopes, errors, idempotency and pagingDeveloper·5 minEnvelopes, errors, idempotency and paging: the shape every endpoint shares.
Resources
- OrganisationsDeveloper·3 minThe organisations endpoints: reading and updating the fields your key can reach.
- Members and invitationsDeveloper·4 minThe members endpoints: listing, inviting and removing members through the API.
- BotsDeveloper·4 minThe bots endpoints: creating, reading and updating a bot's settings through the API.
- Routines and triggersDeveloper·3 minThe routines and triggers endpoints: creating a routine and reading its runs.
- MemoriesDeveloper·4 minThe memories endpoints: reading and managing what a bot remembers.
- Conversations and messagesDeveloper·3 minThe conversations and messages endpoints: reading a thread and sending a message.
- RunsDeveloper·4 minThe runs endpoints: reading a run's status, its steps and its result.
- ApprovalsDeveloper·3 minThe approvals endpoints: reading pending approvals and answering them through the API.
- BatchDeveloper·4 minBatch: sending several requests in one call, and reading each one's own result.
Self-hosting
Run it yourself
- Self-hostingOperator·2 minRunning Botseon yourself: what it takes, and how this differs from the hosted service.
- QuickstartSelf-hosting guides arrive with the public release.
- Building your first moduleSelf-hosting guides arrive with the public release.
- ArchitectureOperator·11 minThe seven packages, the four database roles, the shape of a run, and how a data subject is erased.
Reference
- Module manifest referenceOperator·6 minEvery field of a module manifest and its data flow, quoted from source, and the policy for breaking changes.
- Permission-tag referenceOperator·6 minThe ten tags a tool can declare, the three sets they can join, and what each one gates for review.
- `botseon privacy export` / `botseon privacy erase`Operator·12 minExport or erase one member's data from the command line, and what each command leaves behind.
- Provider seamsOperator·6 minThe four seams a deployment swaps: auth, events, blobs and the key store, each quoted from source.
Connectors
- Connectors: bring your own OAuth appOperator·5 minBring your own OAuth app for each connector, and what the framework needs from it.
- Gmail connector setupOperator·3 minSet up the Gmail connector: the cloud project, the consent screen and the scopes.
- Todoist connector setupOperator·2 minSet up the Todoist connector: the OAuth app, its scopes and the redirect URL.
- Google Calendar connector setupOperator·2 minSet up the Google Calendar connector: the cloud project, the consent screen and the scopes.
- Google Drive connector setupOperator·2 minSet up the Google Drive connector: the cloud project, the consent screen and the scopes.
- Microsoft 365 connector setupOperator·3 minOne app for mail, calendar and files: the registration, the delegated permissions and the one redirect URL.
- Slack connector setupOperator·2 minSet up the Slack connector: the app, the user-token scopes and the redirect URL.
- Notion connector setupOperator·2 minSet up the Notion connector: the integration, what it can reach and the redirect URL.
- GitHub connector setupOperator·2 minSet up the GitHub connector: the OAuth app, its scopes and what reading a private repository costs.
- Linear connector setupOperator·2 minSet up the Linear connector: the OAuth application, its scopes and the redirect URL.
- X connector setupOperator·2 minSet up the X connector: the project, the read scopes and the redirect URL.
- Zendesk connector setupOperator·2 minSet up the Zendesk connector: the OAuth client on your subdomain, its scopes and the redirect URL.
- ClickUp connector setupOperator·2 minSet up the ClickUp connector: the app, what the grant covers and the redirect URL.
- Airtable connector setupOperator·3 minSet up the Airtable connector: the OAuth integration in Airtable, its scopes and the base access it needs.
- Sentry connector setupOperator·4 minSet up the Sentry connector: the organisation token, the EU host and what the read-only tools can see.
The home edition
- Model and voice providersSelf-hosting guides arrive with the public release.
- The computer at homeSelf-hosting guides arrive with the public release.
Operations
- The command lineSelf-hosting guides arrive with the public release.
- Status and healthSelf-hosting guides arrive with the public release.
- Sending mailSelf-hosting guides arrive with the public release.