API Reference
The Broodnet REST API provisions and manages agent mailboxes, organizations, outbound policy, agents, and webhooks.
Developer resources
Section titled “Developer resources”- Base URL:
https://api.broodnet.com - OpenAPI 3.1 specification: https://api.broodnet.com/openapi.json
- Interactive API reference: https://api.broodnet.com/docs
- Authentication guide: Authentication
- Webhook guide: Webhooks
The OpenAPI document is the canonical machine-readable description of Broodnet’s custom REST endpoints. Each operation has a stable operationId, a description, typed request parameters, and response schemas where the endpoint returns a body. Authentication protocol endpoints publish their own schema in the interactive reference.
Authentication
Section titled “Authentication”Management requests use either a bearer session or an organization API key. Mailbox-scoped requests use the mailbox token issued when the mailbox is created.
Use the narrowest credential that fits the job. Agents reading and sending mailbox email normally need a mailbox token, not an organization API key. See Authentication for header formats and scopes.
Calling the API
Section titled “Calling the API”The public plans endpoint does not require authentication:
curl https://api.broodnet.com/api/plansFor authenticated endpoints, derive the request and response shapes from the OpenAPI specification rather than copying examples into a separate schema.
Client generation
Section titled “Client generation”OpenAPI-compatible tools can generate typed clients directly from the published specification:
curl -o broodnet-openapi.json https://api.broodnet.com/openapi.jsonReview generated clients before use and keep authentication credentials outside generated source files.