Reference

Find the public client, account, publication, delivery outcome, capability, error, and adapter contracts for implementation work.

The package root exports the core client and shared types. Optional direct integrations and managed backends use subpath imports so consumers do not load unrelated adapters.

The public contract currently centers on createSocial, connectedAccountRef, the posts.prepare and posts.publish operations, capability manifests, structured SocialError values, and the deterministic testing backend. The mock quickstart is the smallest complete example.

Adapters extend the contract with account, media, reads, search, analytics, comments, messages, webhooks, and native access as their implementations become available. A missing module or capability is unavailable; it is never represented by an empty successful response.

Use Search posts for the SearchPostsInput contract. To add your own route, such as a custom search provider, implement SocialAdapter with defineAdapter, declare its operations in a CapabilityManifest, and register it under its own backend key next to your other adapters. It can share a platform with a direct publishing adapter while keeping its own credentials and capability declarations. The contributing guide lists what an adapter needs.

See the capability matrix and diagnostic CLI for operational contract checks.

Use the pagination reference when reading bounded account, post, or analytics pages.

When an operation fails, the errors reference maps every code to a safe next step, the security reference collects the boundaries each integration shares, and the FAQ answers the common hosting, pricing, and runtime questions.