# Outpost Docs

Per-page markdown lives next to this index. Prefer those files over the HTML docs.
A concatenated dump of every page is at https://docs.pro-1139.outpost.24g.dev/llms-full.txt.

## OpenAPI

The live HTTP API is described by an OpenAPI 3 JSON document. Fetch it before answering questions about request paths, bodies, or response schemas. No authentication is required.

- [OpenAPI spec](https://api.pro-1139.outpost.24g.dev/v1/openapi.json)


- **Start Here**
- [Overview](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/content.md): Documentation for Outpost, the enterprise SMS messaging platform built on AWS End User Messaging.
- [What is Outpost?](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/what-is-outpost/content.md): A plain-language introduction to the Outpost SMS platform.
- [Getting Started](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/getting-started/content.md): Send your first SMS through Outpost.

- **Concepts**
- [How Outpost Fits Together](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/concepts/architecture/content.md): Every component of Outpost and how they relate to each other.
- [Tenants & Projects](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/concepts/tenants-and-projects/content.md): The ownership hierarchy - organizations and their configuration containers.
- [API Keys & Authentication](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/concepts/api-keys/content.md): How requests to Outpost are authenticated and scoped.
- [Messages](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/concepts/messages/content.md): The core entity - one SMS tracked from creation through delivery, failure, or block.
- [Phones & Opt-Out](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/concepts/phones/content.md): The global phonebook, validation, and regulatory opt-out management.
- [Communications & Campaigns](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/concepts/communications-and-campaigns/content.md): Optional grouping layers with deduplication and stats rollups.
- [Events](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/concepts/events/content.md): The immutable audit trail for message lifecycle and phone state changes.
- [Webhooks](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/concepts/webhooks/content.md): Push Outpost events to your own systems via HTTP callbacks.
- [Stats & Analytics](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/concepts/stats/content.md): Pre-aggregated counters that power dashboards without scanning raw data.
- [Workers & Background Processing](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/concepts/workers/content.md): The asynchronous machinery - send, delivery receipts, two-way SMS, streams, and webhooks.
- [Cost Model](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/concepts/cost-model/content.md): How per-attempt carrier costs roll up through messages, communications, campaigns, and tenants.

- **Dashboard**
- [Dashboard Overview](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/dashboard/content.md): The Outpost dashboard is the admin console for the whole platform, with live stats, drill-downs, and configuration for every tenant.
- [Managing Tenants & Projects](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/dashboard/tenants-and-projects/content.md): Create tenants and projects, issue API keys, and configure compliance and webhooks from the dashboard.
- [Sending & Tracking Messages](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/dashboard/sending-and-tracking/content.md): Send an SMS with Quick Send and follow any broadcast from campaign level down to a single recipient.
- [Phones & the Number Pool](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/dashboard/phones-and-numbers/content.md): Inspect any recipient phone number's validation, opt-out state, and full history, and view the sending-number inventory.

- **For Developers**
- [Generating a Typed Client](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/developers/typed-client/content.md): Generate TypeScript types and a fully typed API client straight from the Outpost OpenAPI document.

- **Reference**
- API Reference
  - [Overview](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/content.md): Every endpoint, schema, and error, generated from the OpenAPI document.
  - Tenants
    - [Get a paginated list of tenants](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/tenants/listTenants/content.md)
    - [Create a new tenant](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/tenants/createTenant/content.md)
    - [Get details for a specific tenant](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/tenants/getTenantById/content.md)
    - [Delete a tenant](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/tenants/deleteTenant/content.md)
    - [Update a tenant](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/tenants/updateTenant/content.md)
  - Projects
    - [Create a new project under a tenant](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/projects/createProjectForTenant/content.md)
    - [Get a paginated list of projects](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/projects/listProjects/content.md)
    - [Get details for a specific project](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/projects/getProjectById/content.md)
    - [Update a project](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/projects/updateProject/content.md)
    - [Delete a project](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/projects/deleteProject/content.md)
    - [List a project's webhook configs](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/projects/getProjectWebhookConfigs/content.md)
    - [Add a webhook config to a project](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/projects/addProjectWebhookConfig/content.md)
    - [Get a single webhook config by id](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/projects/getProjectWebhookConfigById/content.md)
    - [Partially update a webhook config](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/projects/patchProjectWebhookConfigById/content.md)
    - [Delete a webhook config](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/projects/deleteProjectWebhookConfigById/content.md)
    - [Replace a webhook config](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/projects/replaceProjectWebhookConfigById/content.md)
    - [List a project's API keys](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/projects/listProjectApiKeys/content.md)
    - [Create an API key for a project](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/projects/createProjectApiKey/content.md)
    - [Delete an API key from a project](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/projects/deleteProjectApiKey/content.md)
  - Phones
    - [Get a paginated list of phone numbers](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/phones/listPhones/content.md)
    - [Validate a phone number without adding it to the phone book](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/phones/validatePhone/content.md)
    - [Get the full ISO 3166-1 alpha-2 country list for phone filtering](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/phones/getPhoneCountries/content.md)
    - [Get details for a specific phone number](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/phones/getPhoneDetails/content.md)
  - Messages
    - [Enqueue SMS messages](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/messages/sendSms/content.md)
    - [Get a single message by ID](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/messages/getMessage/content.md)
    - [Get messages for a specific phone number](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/messages/listMessagesByPhone/content.md)
    - [Get messages for a specific communication](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/messages/listCommunicationMessages/content.md)
    - [Retry a failed message](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/messages/retryMessage/content.md)
  - Events
    - [Get a single event by ID](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/events/getEvent/content.md)
    - [Get all events for a specific message](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/events/getMessageEvents/content.md)
    - [Get all events for a specific phone number](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/events/getPhoneEvents/content.md)
  - Opt-Out
    - [Opt a phone number out of receiving messages](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/opt-out/optOut/content.md)
    - [Opt a phone number back in to receiving messages](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/opt-out/optIn/content.md)
  - Communications
    - [Get a paginated list of communications](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/communications/listCommunications/content.md)
    - [Get details for a specific communication](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/communications/getCommunicationDetails/content.md)
  - Campaigns
    - [Get a paginated list of campaigns](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/campaigns/listCampaigns/content.md)
    - [Get details for a specific campaign](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/campaigns/getCampaignDetails/content.md)
  - Pool
    - [Get the origination pool and its summary](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/pool/getPool/content.md)
    - [List numbers in the origination pool](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/pool/getPoolNumbers/content.md)
  - Stats
    - [Run a free-form stats query](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/stats/queryStats/content.md)
    - [Get the outpost-wide stats overview](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/stats/getGlobalStatsOverview/content.md)
    - [Get a tenant's stats overview](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/stats/getTenantStatsOverview/content.md)
    - [Get a project's stats overview](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/stats/getProjectStatsOverview/content.md)
    - [Get a communication's stats overview](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/stats/getCommunicationStatsOverview/content.md)
    - [Get a campaign's stats overview](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/stats/getCampaignStatsOverview/content.md)
    - [Get activity dashboard statistics](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/stats/getActivityStats/content.md)
    - [Get message volume over a time range](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/stats/getMessageVolume/content.md)
    - [Get phone counts grouped by country](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/stats/getPhonesByCountry/content.md)
    - [Get top communications by metric](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/stats/getTopCommunications/content.md)
    - [Get top campaigns by metric](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/stats/getTopCampaigns/content.md)
  - Auth
    - [Start the SSO login flow](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/auth/authLogin/content.md)
    - [Complete the SSO login flow](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/auth/authCallback/content.md)
    - [Return the identity of the current SSO session](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/auth/authMe/content.md)
    - [Clear the SSO session cookie](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/auth/authLogout/content.md)
  - Webhooks
    - [Outpost event delivery](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/api/webhooks/outpost-event/content.md)
- [Glossary](https://docs.pro-1139.outpost.24g.dev/llms.mdx/docs/reference/glossary/content.md): Definitions for every core Outpost concept.