Skip to content

Administrator manual

This manual is for people who manage an organization or run the OpenBot service. OpenBot is headless. Management tasks use its API or tools. API examples here are part of the management task.

Role Responsibility Required access
Organization administrator Members, roles, models, budgets, and shared services in one organization The rights named on each page
Platform administrator Platform settings, shared providers, and organization policy limits Platform admin rights
Server operator Install, update, back up, and monitor the service Access to the server, database, storage, and keys

An organization role does not give platform rights. Server access and platform API rights are separate. If a task needs another role, hand it to the person who holds that role.

  1. Read organizations and members and permissions.
  2. Set up SSO and domains if your organization uses its own sign-in provider.
  3. Add models and providers, then set prices and budgets.
  4. Connect Channels, Computer providers, or secret providers as needed.
  5. Give members the client address and the user manual.
  1. Read deployment and instance configuration.
  2. Set up the platform and sign-in provider.
  3. Set up file storage, Live models, and Code Mode when needed.
  4. Set App Index restrictions, and pair machines that you operate.
  5. Use the backup steps and error logs for ongoing service work.

Check which organization and account the problem affects. Check membership, rights, and model availability first. A server failure belongs to the operator. Include its time and request ID so the operator can find the log. Keep source changes in the developer manual.