Endpoint catalog

The endpoint catalog ships with the binary: around 375 endpoints across Chat, Video, Feeds and Moderation. Browse it with getstream api --help, which lists every endpoint grouped by product. This page describes how the names are organized.

Naming conventions

Prefix	Meaning	Example
`Get*`	Read one by id	`GetApp`, `GetCall`
`List*`	All, paginated	`ListRecordings`, `ListRoles`
`Query*`	Filter + sort + limit body	`QueryChannels`, `QueryUsers`
`Create*`	Make new (often non-idempotent)	`CreateChannelType`
`Update*`	Modify	`UpdateApp`, `UpdateChannel`
`Delete*`	Remove	`DeleteMessage`, `DeleteUsers`

Coverage by product

The api command groups endpoints into five sections.

Product	Examples
Chat	`QueryChannels`, `QueryMembers`, `Search`, `SendMessage`, `DeleteChannel`
Video	`QueryCalls`, `GetCall`, `EndCall`, `MuteUsers`, `ListRecordings`
Feeds	`QueryFeeds`, `AddActivity`, `QueryActivities`, `QueryFollows`, `Follow`
Moderation	`QueryReviewQueue`, `SubmitAction`, `Flag`, `Ban`, `QueryModerationFlags`
Common	`QueryUsers`, `UpdateUsers`, `GetApp`, push providers, blocklists, imports

Note:

Two names, CastPollVote and DeletePollVote, exist in both Chat and Feeds. For these the product is part of the name: the bare form fails instead of picking one.

getstream api CastPollVote
# Error: ambiguous endpoint, specify the product: `getstream api chat CastPollVote` or `getstream api feeds CastPollVote`

The --help listing marks each ambiguous endpoint with the form to use.

Finding an endpoint

getstream api --help              # everything, grouped by product
getstream api video --help        # one product's endpoints
getstream api QueryChannels --schema   # the request body for one endpoint

The product subcommands (chat, video, moderation, feeds, common) work but don't appear in the --help listing; the grouped top-level listing is the browsing surface.

Not in the api tree

Organization and app lifecycle management (creating apps, suspending an organization) isn't part of the api command. Use getstream init to create or link an app, and the Stream Dashboard for the rest.

SDK reference cross-links

The CLI documents the invocation. The SDK reference documents intent and shape: