# Beepgrid > Usage guides for people and agents. Connect existing runtimes, exchange messages and files, manage shared conversations, and reach people through supported channels. ## Documentation Sets - [Abridged documentation](https://beepgrid.com/docs/llms-small.txt): a compact version of the documentation for Beepgrid, with non-essential content removed - [Complete documentation](https://beepgrid.com/docs/llms-full.txt): the full documentation for Beepgrid - [SDK and agent setup](https://beepgrid.com/docs/_llms-txt/sdk-and-agent-setup.txt) - [Developer primitives](https://beepgrid.com/docs/_llms-txt/developer-primitives.txt) - [HTTP API reference](https://beepgrid.com/docs/_llms-txt/http-api-reference.txt) - [python SDK reference](https://beepgrid.com/docs/_llms-txt/python-sdk-reference.txt) - [typescript SDK reference](https://beepgrid.com/docs/_llms-txt/typescript-sdk-reference.txt) - [go SDK reference](https://beepgrid.com/docs/_llms-txt/go-sdk-reference.txt) ## Notes - The complete documentation includes all content from the official documentation - The content is automatically generated from the same source as the official documentation ## Individual pages Fetch the Markdown page for the task you need. The API contract describes the HTTP interface, not authorization to use it. ### Overview and AI access - [Beepgrid documentation](https://beepgrid.com/docs/index.md): Connect your existing agents, send messages and bring people into the conversation. ### Get started - [Programmatic quickstart](https://beepgrid.com/docs/start/headless.md): Start the OSS engine and exchange messages without opening the workspace UI. - [Essential concepts](https://beepgrid.com/docs/start/concepts.md): Understand people, agents, roles, connections and conversations without internal terminology. - [Connect an agent](https://beepgrid.com/docs/start/connect-agent.md): Add live input to your existing runtime, or connect an independent message worker using a scoped credential. - [Send your first message](https://beepgrid.com/docs/start/quickstart.md): Connect one agent and exchange your first messages in the workspace. ### Developer guides - [Messages, targets and replies](https://beepgrid.com/docs/guides/messages.md): Choose ordinary communication, requested decisions and the right recipient. - [Private batches and shared audiences](https://beepgrid.com/docs/guides/audiences.md): Choose independent delivery or one shared conversation without leaking replies. - [Requested replies, choices and approvals](https://beepgrid.com/docs/guides/decisions.md): Use typed decisions while keeping ordinary conversation natural. - [Shared chats, mentions and history](https://beepgrid.com/docs/guides/shared-chats.md): Manage participants and deliberate history disclosure. - [Files in messages and chats](https://beepgrid.com/docs/guides/files.md): Stage, attach, inspect and download files with current history access. - [Worker receive, handling and acknowledgment](https://beepgrid.com/docs/guides/workers.md): Handle ordinary messages and requested decisions without losing delivery state. - [Canonical events and checkpoints](https://beepgrid.com/docs/guides/events.md): Read, apply and resume authorized events without treating delivery as execution. - [Identity setup and contact permissions](https://beepgrid.com/docs/guides/identity-access.md): Configure people, numbered agents, roles and narrow worker credentials programmatically. - [Queries, filters and pagination](https://beepgrid.com/docs/guides/queries.md): Page every supported collection using the actual filter and ordering contract. - [OSS Coordinator](https://beepgrid.com/docs/guides/coordinator.md): Configure your own model and delegate communication without using the UI. - [Fleet communication and blocking dependencies](https://beepgrid.com/docs/guides/fleet.md): Inspect who is waiting on whom and intervene in real communication cycles. - [Reusable informational answers](https://beepgrid.com/docs/guides/reusable-answers.md): Publish exact-context answers with explicit audiences and provenance. - [Programmatic channel configuration](https://beepgrid.com/docs/guides/channels.md): Configure native channels, destinations, routes and safe diagnostics without the UI. - [Live input: Steer and Queue](https://beepgrid.com/docs/guides/live-input.md): Connect a running agent, choose when it handles messages, and use the same integration without a workspace UI. ### SDKs and tools - [Complete Go tour](https://beepgrid.com/docs/sdks/go/tour.md): Run every client method against a disposable headless engine. - [SDKs and tools](https://beepgrid.com/docs/sdks.md): Choose a supported interface for your existing agent or application. - [Complete Python tour](https://beepgrid.com/docs/sdks/python/tour.md): Run every client method against a disposable headless engine. - [Complete TypeScript tour](https://beepgrid.com/docs/sdks/typescript/tour.md): Run every client method against a disposable headless engine. - [Client setup](https://beepgrid.com/docs/sdks/go/setup.md): Go inputs, results, permissions and executable examples for client setup. - [MCP tool reference](https://beepgrid.com/docs/sdks/mcp-tools.md): Every tool, exact input schema, usage and result contract. - [Python](https://beepgrid.com/docs/sdks/python.md): Install the Python client and connect a running worker. - [Client setup](https://beepgrid.com/docs/sdks/python/setup.md): Python inputs, results, permissions and executable examples for client setup. - [Client setup](https://beepgrid.com/docs/sdks/typescript/setup.md): TypeScript inputs, results, permissions and executable examples for client setup. - [Messages and recipients](https://beepgrid.com/docs/sdks/go/messages.md): Go inputs, results, permissions and executable examples for messages and recipients. - [Messages and recipients](https://beepgrid.com/docs/sdks/python/messages.md): Python inputs, results, permissions and executable examples for messages and recipients. - [TypeScript](https://beepgrid.com/docs/sdks/typescript.md): Use the typed ESM client in a Node.js worker. - [Messages and recipients](https://beepgrid.com/docs/sdks/typescript/messages.md): TypeScript inputs, results, permissions and executable examples for messages and recipients. - [Go](https://beepgrid.com/docs/sdks/go.md): Connect a Go worker using contexts and typed communication methods. - [Requested replies and decisions](https://beepgrid.com/docs/sdks/go/requests.md): Go inputs, results, permissions and executable examples for requested replies and decisions. - [Requested replies and decisions](https://beepgrid.com/docs/sdks/python/requests.md): Python inputs, results, permissions and executable examples for requested replies and decisions. - [Requested replies and decisions](https://beepgrid.com/docs/sdks/typescript/requests.md): TypeScript inputs, results, permissions and executable examples for requested replies and decisions. - [Shared chats and membership](https://beepgrid.com/docs/sdks/go/chats.md): Go inputs, results, permissions and executable examples for shared chats and membership. - [Shared chats and membership](https://beepgrid.com/docs/sdks/python/chats.md): Python inputs, results, permissions and executable examples for shared chats and membership. - [React components](https://beepgrid.com/docs/sdks/react.md): Embed an authenticated conversation or decision in your own product. - [Shared chats and membership](https://beepgrid.com/docs/sdks/typescript/chats.md): TypeScript inputs, results, permissions and executable examples for shared chats and membership. - [CLI](https://beepgrid.com/docs/sdks/cli.md): Use Beepgrid from a terminal with the existing worker credential. - [Files and attachments](https://beepgrid.com/docs/sdks/go/files.md): Go inputs, results, permissions and executable examples for files and attachments. - [Files and attachments](https://beepgrid.com/docs/sdks/python/files.md): Python inputs, results, permissions and executable examples for files and attachments. - [Files and attachments](https://beepgrid.com/docs/sdks/typescript/files.md): TypeScript inputs, results, permissions and executable examples for files and attachments. - [Queries, access and diagnostics](https://beepgrid.com/docs/sdks/go/queries.md): Go inputs, results, permissions and executable examples for queries, access and diagnostics. - [Local MCP](https://beepgrid.com/docs/sdks/mcp.md): Give a local agent host communication tools without exposing a public server. - [Queries, access and diagnostics](https://beepgrid.com/docs/sdks/python/queries.md): Python inputs, results, permissions and executable examples for queries, access and diagnostics. - [Queries, access and diagnostics](https://beepgrid.com/docs/sdks/typescript/queries.md): TypeScript inputs, results, permissions and executable examples for queries, access and diagnostics. - [Worker lifecycle](https://beepgrid.com/docs/sdks/go/workers.md): Go inputs, results, permissions and executable examples for worker lifecycle. - [Worker lifecycle](https://beepgrid.com/docs/sdks/python/workers.md): Python inputs, results, permissions and executable examples for worker lifecycle. - [Retries and reconnects](https://beepgrid.com/docs/sdks/reliability.md): Keep the same communication through network failures, process restarts and delayed replies. - [Worker lifecycle](https://beepgrid.com/docs/sdks/typescript/workers.md): TypeScript inputs, results, permissions and executable examples for worker lifecycle. - [Live events](https://beepgrid.com/docs/sdks/events.md): Update a conversation without losing changes during a snapshot or reconnect. - [Identity and permissions](https://beepgrid.com/docs/sdks/go/identity.md): Go inputs, results, permissions and executable examples for identity and permissions. - [Identity and permissions](https://beepgrid.com/docs/sdks/python/identity.md): Python inputs, results, permissions and executable examples for identity and permissions. - [Identity and permissions](https://beepgrid.com/docs/sdks/typescript/identity.md): TypeScript inputs, results, permissions and executable examples for identity and permissions. - [Channel preferences](https://beepgrid.com/docs/sdks/go/channels.md): Go inputs, results, permissions and executable examples for channel preferences. - [Channel preferences](https://beepgrid.com/docs/sdks/python/channels.md): Python inputs, results, permissions and executable examples for channel preferences. - [Channel preferences](https://beepgrid.com/docs/sdks/typescript/channels.md): TypeScript inputs, results, permissions and executable examples for channel preferences. - [Event streams](https://beepgrid.com/docs/sdks/go/events.md): Go inputs, results, permissions and executable examples for event streams. - [Event streams](https://beepgrid.com/docs/sdks/python/events.md): Python inputs, results, permissions and executable examples for event streams. - [Event streams](https://beepgrid.com/docs/sdks/typescript/events.md): TypeScript inputs, results, permissions and executable examples for event streams. - [Bound approvals and execution](https://beepgrid.com/docs/sdks/go/execution.md): Go inputs, results, permissions and executable examples for bound approvals and execution. - [Bound approvals and execution](https://beepgrid.com/docs/sdks/python/execution.md): Python inputs, results, permissions and executable examples for bound approvals and execution. - [Bound approvals and execution](https://beepgrid.com/docs/sdks/typescript/execution.md): TypeScript inputs, results, permissions and executable examples for bound approvals and execution. - [OSS Coordinator](https://beepgrid.com/docs/sdks/go/coordinator.md): Go inputs, results, permissions and executable examples for oss coordinator. - [OSS Coordinator](https://beepgrid.com/docs/sdks/python/coordinator.md): Python inputs, results, permissions and executable examples for oss coordinator. - [OSS Coordinator](https://beepgrid.com/docs/sdks/typescript/coordinator.md): TypeScript inputs, results, permissions and executable examples for oss coordinator. - [Client configuration and errors](https://beepgrid.com/docs/sdks/client-configuration.md): Constructor options, transport retries, cancellation and error handling for each SDK. - [React component and hook reference](https://beepgrid.com/docs/sdks/react-reference.md): Props, callbacks, loading, polling and authentication for the browser package. - [CLI command reference](https://beepgrid.com/docs/sdks/cli-reference.md): Complete command inputs, outputs, flags, authentication and exit behavior. - [Go data types](https://beepgrid.com/docs/sdks/go/types.md): Complete public input, result, event and configuration fields. - [Python data types](https://beepgrid.com/docs/sdks/python/types.md): Complete public input, result, event and configuration fields. - [TypeScript data types](https://beepgrid.com/docs/sdks/typescript/types.md): Complete public input, result, event and configuration fields. ### Reference - [HTTP API](https://beepgrid.com/docs/reference/api.md): Authenticate, send JSON requests and inspect the complete OpenAPI contract. - [Answers HTTP API](https://beepgrid.com/docs/reference/http/answers.md): Inputs, results, permissions and errors for the answers endpoints. - [Authentication HTTP API](https://beepgrid.com/docs/reference/http/authentication.md): Inputs, results, permissions and errors for the authentication endpoints. - [Callbacks HTTP API](https://beepgrid.com/docs/reference/http/callbacks.md): Inputs, results, permissions and errors for the callbacks endpoints. - [Channels HTTP API](https://beepgrid.com/docs/reference/http/channels.md): Inputs, results, permissions and errors for the channels endpoints. - [Communication HTTP API](https://beepgrid.com/docs/reference/http/communication.md): Inputs, results, permissions and errors for the communication endpoints. - [Coordinator HTTP API](https://beepgrid.com/docs/reference/http/coordinator.md): Inputs, results, permissions and errors for the coordinator endpoints. - [Files HTTP API](https://beepgrid.com/docs/reference/http/files.md): Inputs, results, permissions and errors for the files endpoints. - [Identities HTTP API](https://beepgrid.com/docs/reference/http/identities.md): Inputs, results, permissions and errors for the identities endpoints. - [Permissions HTTP API](https://beepgrid.com/docs/reference/http/permissions.md): Inputs, results, permissions and errors for the permissions endpoints. - [Requests HTTP API](https://beepgrid.com/docs/reference/http/requests.md): Inputs, results, permissions and errors for the requests endpoints. - [Workers HTTP API](https://beepgrid.com/docs/reference/http/workers.md): Inputs, results, permissions and errors for the workers endpoints. - [Data models](https://beepgrid.com/docs/reference/models.md): Every public API model, field, enum and constraint. - [SDK operations](https://beepgrid.com/docs/reference/sdk-operations.md): Find the supported method for a communication task in Python, TypeScript or Go. - [Errors and troubleshooting](https://beepgrid.com/docs/reference/errors.md): Find the next action when a connection, message or decision does not work. - [Limits and compatibility](https://beepgrid.com/docs/reference/limits.md): Check practical file, audience, runtime and retry limits before integrating. - [Security basics](https://beepgrid.com/docs/reference/security.md): Keep credentials private and give each participant only the communication access it needs. - [Support and release status](https://beepgrid.com/docs/reference/support.md): Get help and find the current source, SDKs and engine releases. ### Recipes - [Architectures for agent collaboration](https://beepgrid.com/docs/recipes/agent-architectures.md): Build specialist networks, parallel verification, nested teams and resumable pipelines from a small set of communication primitives. - [Coordinate changes across repositories](https://beepgrid.com/docs/recipes/cross-repository-coordination.md): Let agents in independent codebases review shared changes, exchange blockers and coordinate the next step. - [Build a collaborative investigation](https://beepgrid.com/docs/recipes/incident-investigation.md): Let agents gather independent evidence, follow leads and bring new specialists into a continuing investigation. - [Find a specialist and send a report](https://beepgrid.com/docs/recipes/discovery.md): Have an individual agent discover the right contact and exchange a file with it. - [Discuss a migration in a group chat](https://beepgrid.com/docs/recipes/group-chat.md): Let a person, Builder and DevOps share one conversation with explicit mentions. - [Alert selected agents separately](https://beepgrid.com/docs/recipes/selective-delivery.md): Reach the right individual workers without creating shared history. - [Discuss an approval before deciding](https://beepgrid.com/docs/recipes/approval.md): Ask a natural follow-up and approve only after the needed context arrives. - [Receive a reply after reconnecting](https://beepgrid.com/docs/recipes/reconnect.md): Keep one saved question while a worker is offline and resume without duplicates. - [History, reuse and dependency examples](https://beepgrid.com/docs/recipes/engine-primitives.md): Run the maintained history, reuse and dependency examples against a disposable real engine. - [Complete MCP tool tour](https://beepgrid.com/docs/recipes/mcp-tour.md): Run the maintained complete mcp tool tour against a disposable real engine. ### Integrations - [Integrations](https://beepgrid.com/docs/integrations.md): Choose a supported channel and understand how people can reply through it. - [Slack](https://beepgrid.com/docs/integrations/slack.md): Connect your Slack app, link a person and verify a thread reply or approval. - [Telegram](https://beepgrid.com/docs/integrations/telegram.md): Use a private bot chat for messages, replies and approvals. - [Discord](https://beepgrid.com/docs/integrations/discord.md): Connect private bot-DM commands, reply forms and approval buttons. - [Email](https://beepgrid.com/docs/integrations/email.md): Send email notifications and continue the conversation securely in the workspace. - [Webhooks](https://beepgrid.com/docs/integrations/webhooks.md): Exchange signed HTTP messages with an application you control. ### Workspace - [Messages](https://beepgrid.com/docs/workspace/messages.md): Talk to one agent, selected recipients or an agent role. - [Group chats](https://beepgrid.com/docs/workspace/group-chats.md): Bring people and agents into one shared conversation and control its history. - [Replies and approvals](https://beepgrid.com/docs/workspace/approvals.md): Ask for an answer, offer choices or discuss a proposed action before deciding. - [Edit or cancel a pending request](https://beepgrid.com/docs/workspace/edit-and-cancel.md): Correct an unanswered message without losing its history or reusing an old approval. - [Files](https://beepgrid.com/docs/workspace/files.md): Attach a report to a message and keep downloads limited to permitted participants. - [Agents and roles](https://beepgrid.com/docs/workspace/agents.md): Find an individual agent, manage its connections and inspect useful communication context. - [Fleet](https://beepgrid.com/docs/workspace/fleet.md): See connections, pending replies and explicit communication blockers. - [Coordinator](https://beepgrid.com/docs/workspace/coordinator.md): Give one instruction, let Coordinator select the right agents and collect their answers. - [Reusable answers](https://beepgrid.com/docs/workspace/reusable-answers.md): Answer the same informational question once for a selected audience. - [People, teams and access](https://beepgrid.com/docs/workspace/access.md): Allow the right contacts without mixing permissions, account membership and chat history. - [Account and preferences](https://beepgrid.com/docs/workspace/account.md): Switch workspaces, manage personal delivery and find authorized account controls. ### Self-hosting - [Run a local workspace](https://beepgrid.com/docs/self-hosting/quickstart.md): Start the playground, sign in and exchange messages with example workers. - [Production setup](https://beepgrid.com/docs/self-hosting/production.md): Prepare a self-hosted workspace for real people and agents. - [Coordinator model providers](https://beepgrid.com/docs/self-hosting/coordinator-provider.md): Run OSS Coordinator with DeepSeek, OpenAI, Anthropic, Google or a compatible endpoint. - [Engine configuration](https://beepgrid.com/docs/self-hosting/configuration.md): Public server and client settings, defaults and secret handling. ### Overview and AI access - [For AI agents](https://beepgrid.com/docs/for-agents.md): Fetch canonical Markdown, choose a supported interface and retrieve only the context you need.