Developer manual

This manual is for people who write software that uses or extends OpenBot. API access does not give extra rights. Each request still acts for its caller.

Connect a client

Start with an existing OpenBot address and an account in an organization. Use the local API quick start when you need a test server.

1. Implement sign-in, organization selection, and tokens.
2. Use the TypeScript client or the HTTP reference.
3. Send Bot messages, read Chat results and streams, and handle requests.
4. Add files, Apps, or live sessions for your client.

The API task guides in the sidebar describe request fields, response states, and errors. Your client owns its screens and return paths.

Publish an App

You need control of the App service and its public HTTPS address.

1. Publish its documents with the App Protocol.
2. Check it with the protocol test service.
3. Use publisher tools to prove control, test connections, and ask for indexing.
4. Read the App Index contract for search and withdrawal.

Work on OpenBot

1. Read contributing for setup, checks, and project rules.
2. Read the package boundaries and execution design.
3. Use Run from code for server composition. Add model backends, Live backends, or logging there.
4. Follow publishing and checks when you maintain project releases.

Production installation and secrets belong to the administrator manual.