# Hum Documentation

- [Introduction](https://docs.letshum.com/introduction.md): Welcome to Hum — Connecting Residents with Internet Services
- [Environments and API Keys](https://docs.letshum.com/environments.md): Choose a Hum API environment, obtain the matching key, and verify access
- [Postman Collection](https://docs.letshum.com/postman.md): Import the Hum API collection and environments into Postman
- [Widget Overview](https://docs.letshum.com/widget-integration/overview.md): Learn about the Hum widget's capabilities, features, and integration options
- [JavaScript Integration](https://docs.letshum.com/widget-integration/javascript.md): Step-by-step guide to integrate the Hum widget into your website using JavaScript and HTML
- [WebView Integration](https://docs.letshum.com/widget-integration/webview.md): Learn how to integrate Hum into mobile applications using WebView with URL parameters
- [Widget Hook Notifications](https://docs.letshum.com/widget-integration/hooks.md): Learn how to listen for and handle events from the Hum widget across web, iOS, and Android platforms
- [API Integration](https://docs.letshum.com/api-integration.md): Learn how to integrate Hum into your application using our API
- [Order & Commission Reporting](https://docs.letshum.com/order-reporting.md): Retrieve order status, installation state, commissions, and checkout progression
- [Hum Broadband MCP](https://docs.letshum.com/mcp/overview.md): Connect an AI agent to Hum for broadband availability, exact-offer validation, authorized ordering, and outcome recovery
- [Quickstart](https://docs.letshum.com/mcp/quickstart.md): Connect an MCP client and complete Hum's safe broadband availability and ordering workflow
- [Tool reference](https://docs.letshum.com/mcp/tool-reference.md): Inputs, outputs, statuses, errors, side effects, and recovery rules for Hum's four MCP tools
- [Availability and offers](https://docs.letshum.com/mcp/availability-and-offers.md): Interpret FCC evidence, live qualification, partial results, clarification, questions, catalog plans, and executable offers
- [Ordering and recovery](https://docs.letshum.com/mcp/ordering-and-recovery.md): Validate an exact broadband offer, obtain authorization, submit once, and recover lost or uncertain responses
- [Testing](https://docs.letshum.com/mcp/testing.md): Verify Hum MCP discovery, availability, validation, authorization, submission recovery, and environment limits
- [Releases and migration](https://docs.letshum.com/mcp/releases-and-migration.md): Migrate from Hum's availability-only MCP to the schema-version 4 broadband workflow
- [Create New Session](https://docs.letshum.com/api-reference/sessions/create-new-session.md): Creates a new session for processing a service address. This is typically the first endpoint called when starting  a new address lookup flow.
- [Get Session Status](https://docs.letshum.com/api-reference/sessions/get-session-status.md): Retrieves an open session. Provider results are usually returned by `POST /sessions`, but when `qualify_status` is `pending` or `retry_later`, poll `GET /sessions/{token}/services/internet` until the status resolves.
- [Close Session](https://docs.letshum.com/api-reference/sessions/close-session.md): Closes an active session. Sessions remain open until this endpoint is called.
- [Get Internet Service Availability](https://docs.letshum.com/api-reference/service-availability/get-internet-service-availability.md): Retrieves available Internet service providers and their offerings for the service address associated with  the current session.
- [API Health Check](https://docs.letshum.com/api-reference/health-check/api-health-check.md): Simple health check endpoint to verify API availability and authentication status. Use this endpoint  for monitoring and to validate API tokens.
- [Get FCC Service Providers](https://docs.letshum.com/api-reference/informational/get-fcc-service-providers.md): Retrieves a comprehensive list of FCC service providers and their supplemental brands.  This endpoint provides access to the complete database of Internet service providers  that are tracked by the FCC and used by Hum for service availability lookups.
- [List Sessions](https://docs.letshum.com/api-reference/analytics/list-sessions.md): Returns a paginated list of sessions with address, cart progression, order, and commission data. Scoped to all tokens belonging to the authenticated client.
- [Get Session Detail](https://docs.letshum.com/api-reference/analytics/get-session-detail.md): Returns a single session with address, order, commission, and full cart progression timeline. The session must belong to the authenticated client. The path accepts either the session UUID returned by the analytics index endpoint or the session token returned by session create.

## OpenAPI Specs

- [swagger](/swagger.yaml)

## Optional

- [Website](https://letshum.com)
- [Support](mailto:support@letshum.com)
- [Operational Status](https://status.letshum.com)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.