getstream api

Scope: app

Make Stream API calls. Every endpoint is a subcommand named after its SDK method. Names are case-sensitive.

Path parameters are flags. The request body and query parameters are passed as JSON with --request. Check the flags and the request shape with --help for a specific endpoint.

Responses are JSON, and can be queried with --jq using jq syntax.

Like every app-scoped command, api acts on the current project's app unless --app-id or the STREAM_API_KEY and STREAM_API_SECRET environment variables override it.

--jq output

String results print JSON-encoded, so strip the quotes before piping them into read or xargs. @csv and @tsv rows come back as one quoted string each; pipe through jq -r . to unwrap them.

getstream api [flags]
getstream api [command]

Examples

getstream api GetApp --jq '.app.name'

getstream api UpdateChannelType --name messaging --request '{
  "polls": true
}'

getstream api QueryChannels --request '{
  "limit": 30
}' --jq '.channels | length'

Subcommands

Chat

Subcommand Description
AddSegmentTargets Add targets to a segment
CastPollVote Cast vote (use: getstream api chat CastPollVote)
ChannelBatchUpdate Update channels in batch
CommitMessage Commit message
CreateCampaign Create campaign
CreateChannelType Create channel type
CreateCommand Create command
CreatePredefinedFilter Create predefined filter
CreateReminder Create reminder
CreateSegment Create segment
DeleteCampaign Delete campaign
DeleteChannel Delete channel
DeleteChannelFile Delete file
DeleteChannelImage Delete image
DeleteChannelType Delete channel type
DeleteChannels Deletes channels asynchronously
DeleteCommand Delete command
DeleteDraft Delete draft
DeleteMessage Delete message
DeletePollVote Delete vote (use: getstream api chat DeletePollVote)
DeletePredefinedFilter Delete predefined filter
DeleteReaction Delete reaction
DeleteReminder Delete reminder
DeleteRetentionPolicy Delete retention policy
DeleteSegment Delete segment
DeleteSegmentTargets Delete targets from a segment
EphemeralMessageUpdate Ephemeral message update
ExportChannels Export channels
GetCampaign Get campaign
GetChannel Get channel
GetChannelType Get channel type
GetCommand Get command
GetDraft Get draft
GetManyMessages Get many messages
GetMessage Get message
GetOrCreateChannel Get or create channel
GetOrCreateDistinctChannel Get or create channel
GetPinnedMessages Get pinned messages
GetPredefinedFilter Get predefined filter
GetPredefinedFilters Get predefined filters
GetReactions Get reactions
GetReplies Get replies
GetRetentionPolicy Get retention policy
GetRetentionPolicyRuns Get retention policy runs
GetSegment Get segment
GetThread Get Thread
GroupedQueryChannels Grouped query channels
HideChannel Hide channel
ListChannelTypes List channel types
ListCommands List commands
MarkChannelsRead Mark channels as read
MarkDelivered Mark channel message delivery status
MarkRead Mark read
MarkUnread Mark unread
MuteChannel Mute channel
QueryBannedUsers Query Banned Users
QueryCampaigns Query campaigns
QueryChannels Query channels
QueryDrafts Query draft messages
QueryFutureChannelBans Query Future Channel Bans
QueryMembers Query members
QueryMessageFlags Query Message Flags
QueryMessageHistory Query message history
QueryReactions Get reactions on a message
QueryReminders Query reminders
QuerySegmentTargets Query segment targets
QuerySegments Query segments
QueryTeamUsageStats Query Team Usage Statistics
QueryThreads Query Threads
RunMessageAction Run message command action
Search Search messages
SegmentTargetExists Check whether a target exists in a segment
SendEvent Send event
SendMessage Send new message
SendReaction Send reaction
SendUserCustomEvent Send user event
SetRetentionPolicy Set retention policy
ShowChannel Show channel
StartCampaign Start/schedule campaign
StopCampaign Stop campaign
TranslateMessage Translate message
TruncateChannel Truncate channel
UndeleteMessage Undelete message
UnmuteChannel Unmute channel
UnreadCounts Unread counts
UnreadCountsBatch Batch unread counts
UpdateCampaign Update campaign
UpdateChannel Update channel
UpdateChannelPartial Partially update channel
UpdateChannelType Update channel type
UpdateCommand Update command
UpdateMemberPartial Partially channel member update
UpdateMessage Update message
UpdateMessagePartial Partially message update
UpdatePredefinedFilter Update predefined filter
UpdateReminder Updates Reminder
UpdateSegment Update segment
UpdateThreadPartial Partially update thread

Video

Subcommand Description
BlockUser Block user on a call
CollectUserFeedback Collect user feedback
CreateCallType Create Call Type
CreateSIPInboundRoutingRule Create SIP Inbound Routing Rule
CreateSIPTrunk Create SIP Trunk
DeleteCall Delete Call
DeleteCallType Delete Call Type
DeleteRecording Delete recording
DeleteSIPInboundRoutingRule Delete SIP Inbound Routing Rule
DeleteSIPTrunk Delete SIP Trunk
DeleteTranscription Delete transcription
EndCall End call
GetActiveCallsStatus Get active calls status
GetCall Get Call
GetCallParticipantSessionMetrics Get call participant session metrics
GetCallReport Get call report
GetCallSessionParticipantStatsDetails Get call session participant stats details
GetCallStatsMap Map call participants by location
GetCallType Get Call Type
GetDailyDigest Get daily digest
GetEdges Get Edges
GetOrCreateCall Get or create a call
GoLive Set call as live
KickUser Kick user from a call
ListCallTypes List Call Type
ListRecordings List recordings
ListSIPInboundRoutingRule List SIP Inbound Routing Rules
ListSIPTrunks List SIP Trunks
ListTranscriptions List transcriptions
MuteUsers Mute users
QueryAggregateCallStats Query Aggregate call Stats
QueryCallMembers Query call members
QueryCallParticipantSessions Query call participant sessions
QueryCallParticipants Query call participants
QueryCallSessionParticipantStats Query call participant statistics
QueryCallSessionStats Query call session stats
QueryCallStats Query Call Stats
QueryCalls Query call
QueryUserFeedback Query user reported feedback for the calls
ReportClientCallEvent Report client-side events
ResolveSipAuth Resolve SIP Auth
ResolveSipInbound Resolve SIP Inbound Routing
RingCall Ring Call Users
SendCallEvent Send custom event
SendClosedCaption Send closed caption
StartClosedCaptions Start closed captions
StartFrameRecording Start frame recording
StartHLSBroadcasting Start HLS broadcasting
StartRTMPBroadcasts Start RTMP broadcasts
StartRecording Start recording
StartTranscription Start transcription
StopAllRTMPBroadcasts Stop all RTMP broadcasts for a call
StopClosedCaptions Stop closed captions
StopFrameRecording Stop frame recording
StopHLSBroadcasting Stop HLS broadcasting
StopLive Set call as not live
StopRTMPBroadcast Stop RTMP broadcasts
StopRecording Stop recording
StopTranscription Stop transcription
UnblockUser Unblocks user on a call
UpdateCall Update Call
UpdateCallMembers Update Call Member
UpdateCallType Update Call Type
UpdateSIPInboundRoutingRule Update SIP Inbound Routing Rule
UpdateSIPTrunk Update SIP Trunk
UpdateUserPermissions Update user permissions
VideoPin Pin
VideoUnpin Unpin

Moderation

Subcommand Description
Analyze Analyze
Appeal Appeal against the moderation decision
Ban Ban
BulkActionAppeals Bulk action appeals
BulkDeleteActionConfig Bulk delete moderation action configs
BulkImageModeration Bulk image moderation
BulkUpsertActionConfig Bulk create or update moderation action configs
Bypass Bypass Moderation
Check Check
CheckS3Access Check S3 image access
CreatePolicyTestSet Create policy test set
CreateQueue Create queue
CustomCheck Custom check endpoint
DeleteActionConfig Delete a moderation action config
DeleteConfig Delete a moderation policy
DeleteModerationRule Delete moderation rule
DeletePolicyTestSet Delete policy test set
DeleteQueue Delete queue
Flag Flag content for moderation
GetActionConfig Get moderation action configs
GetAppeal Get appeal item
GetConfig Get moderation configuration
GetFlagCount Get flag count for a user
GetModerationRule Get moderation rule
GetPolicyTestRun Get policy test run
GetPolicyTestSet Get policy test set
GetQueue Get queue
GetReviewQueueItem Get review queue item
GetSetupSession Get moderation setup session
InsertActionLog Insert moderation action log
Labels Labels
ListPolicyTestSets List policy test sets
ListQueues List queues
Mute Mute
QueryAppeals Query Appeals
QueryLabelResults Query label results
QueryModerationConfigs Query moderation configurations
QueryModerationFlags Query moderation flags
QueryModerationLogs Query moderation action logs
QueryModerationRules Query moderation rules
QueryReviewQueue Query review queue items
StartPolicyTestRun Start policy test run
SubmitAction Submit moderation action
SubmitModerationFeedback Submit moderation feedback
Unban Unban
Unmute Unmute a user
UpdateQueue Update queue
UpsertActionConfig Create or update a moderation action config
UpsertConfig Create or update moderation configuration
UpsertModerationRule Upsert moderation rule
UpsertSetupSession Create or update moderation setup session
V2DeleteTemplate Delete a moderation template
V2QueryTemplates Query feed moderation templates
V2UpsertTemplate Upsert feeds template

Feeds

Subcommand Description
AcceptFeedMemberInvite Accept a feed member request
AcceptFollow Accept a follow request
ActivityFeedback Provide feedback on an activity
AddActivity Add a single activity
AddActivityReaction Add reaction
AddBookmark Add bookmark
AddComment Add a comment or reply
AddCommentBookmark Add comment bookmark
AddCommentReaction Add comment reaction
AddCommentsBatch Add multiple comments in a batch
BatchQueryActivityReactions Batch query activity reactions
BatchQueryCommentReactions Batch query comment reactions
CastPollVote Cast vote (use: getstream api feeds CastPollVote)
ChangeFeedVisibility Change a feed's visibility
CreateCollections Create multiple collections
CreateFeedGroup Create a new feed group
CreateFeedView Create a new feed view
CreateFeedsBatch Create multiple feeds at once
CreateMembershipLevel Create membership level
DeleteActivities Remove multiple activities
DeleteActivity Delete a single activity
DeleteActivityReaction Remove reaction
DeleteBookmark Delete a bookmark
DeleteBookmarkFolder Delete a bookmark folder
DeleteCollections Delete multiple collections
DeleteComment Delete a comment
DeleteCommentBookmark Delete a comment bookmark
DeleteCommentReaction Delete comment reaction
DeleteFeed Delete a single feed
DeleteFeedGroup Delete a feed group
DeleteFeedUserData Delete all feed data for a user
DeleteFeedView Delete a feed view
DeleteFeedsBatch Delete multiple feeds
DeleteMembershipLevel Delete membership level
DeletePollVote Delete vote (use: getstream api feeds DeletePollVote)
ExportFeedUserData Export all feed data for a user
Follow Create a follow
FollowBatch Create multiple follows at once
GetActivity Get activity
GetComment Get comment
GetCommentReplies Get replies for a comment
GetComments Get comments for an object
GetFeedCounts Get feed counts
GetFeedGroup Get a feed group
GetFeedView Get a feed view
GetFeedVisibility Get feed visibility
GetFeedsRateLimits Get Feeds Rate Limits
GetFollowSuggestions Get follow suggestions
GetOrCreateFeed Create a new feed
GetOrCreateFeedGroup Get or create a feed group
GetOrCreateFeedView Get or create a feed view
GetOrCreateFollow Upsert a follow
GetOrCreateFollows Upsert multiple follows at once
GetOrCreateUnfollow Unfollow a feed (idempotent)
GetOrCreateUnfollows Unfollow multiple feeds (idempotent)
GetUserInterests Get a user's computed interests
ListFeedGroups List all feed groups
ListFeedViews List all feed views
ListFeedVisibilities List feed visibilities
MarkActivity Mark activities as read/seen/watched
OwnBatch Get own fields for multiple feeds
PinActivity Pin an activity to a feed
QueryActivities Query activities
QueryActivityReactions Query activity reactions
QueryActivityShares Query activity shares
QueryBookmarkFolders Query bookmark folders
QueryBookmarks Query bookmarks
QueryCollections Query collections
QueryCommentReactions Query comment reactions
QueryComments Query comments
QueryFeedMembers Query feed members
QueryFeeds Query feeds
QueryFeedsUsageStats Query Feed Usage Statistics
QueryFollows Query follows
QueryMembershipLevels Query membership levels
QueryPinnedActivities Query pinned activities
QueryRevisionHistory Query revision history
ReadCollections Read collections
RejectFeedMemberInvite Reject an invite to become a feed member
RejectFollow Reject a follow request
RestoreActivity Restore an activity
RestoreComment Restore a comment
RestoreFeedGroup Restore a feed group
TrackActivityMetrics Track activity metrics
TranslateActivity Translate activity
TranslateComment Translate comment
Unfollow Unfollow a feed
UnfollowBatch Unfollow multiple feeds at once
UnpinActivity Unpin an activity from a feed
UpdateActivitiesPartialBatch Batch partial activity update
UpdateActivity Full activity update
UpdateActivityPartial Partial activity update
UpdateBookmark Update bookmark
UpdateBookmarkFolder Update a bookmark folder
UpdateCollections Update multiple collections
UpdateComment Update a comment
UpdateCommentBookmark Update comment bookmark
UpdateCommentPartial Partial comment update
UpdateFeed Update a feed
UpdateFeedGroup Update a feed group
UpdateFeedMembers Update feed members
UpdateFeedView Update a feed view
UpdateFeedVisibility Update Feed Visibility
UpdateFollow Update a follow
UpdateMembershipLevel Update membership level
UpsertActivities Upsert multiple activities
UpsertCollections Upsert multiple collections

Common

Subcommand Description
AddUserGroupMembers Add user group members
BlockUsers Block user
CancelImportV2Task Cancel import v2 task
CheckExternalStorage Check External Storage
CheckPush Check push
CheckSNS Check SNS
CheckSQS Check SQS
CreateBlockList Create block list
CreateDevice Create device
CreateExternalStorage Create external storage
CreateGuest Create Guest
CreateImport Create import
CreateImportURL Create import URL
CreateImportV2Task Create import v2 task
CreatePermission Create permission
CreatePoll Create poll
CreatePollOption Create poll option
CreateRole Create role
CreateUserGroup Create user group
DeactivateUser Deactivate user
DeactivateUsers Deactivate users
DeleteBlockList Delete block list
DeleteDevice Delete device
DeleteExternalStorage Delete external storage
DeleteFile Delete file
DeleteImage Delete image
DeleteImportV2Task Delete import v2 task
DeleteImporterExternalStorage Delete external storage
DeletePermission Delete permission
DeletePoll Delete poll
DeletePollOption Delete poll option
DeletePushProvider Delete a push provider
DeleteRole Delete role
DeleteUserGroup Delete user group
DeleteUsers Delete Users
ExportUser Export user
ExportUsers Export users
GetApp Get App Settings
GetBlockList Get block list
GetBlockedUsers Get list of blocked Users
GetImport Get import
GetImportV2Task Get import v2 task
GetImporterExternalStorage Get external storage
GetOG Get OG
GetPermission Get permission
GetPoll Get poll
GetPollOption Get poll option
GetPushTemplates Get push notification templates
GetRateLimits Get rate limits
GetTask Get status of a task
GetUserGroup Get user group
GetUserLiveLocations Get user live locations
ImportBlockList Import block list items
ListBlockLists List block lists
ListDevices List devices
ListExternalStorage List external storage
ListImportV2Tasks List import v2 tasks
ListImports Get import
ListPermissions List permissions
ListPushProviders List push providers
ListRoles List roles
ListUserGroups List user groups
QueryPollVotes Query votes
QueryPolls Query polls
QueryUsers Query users
ReactivateUser Reactivate user
ReactivateUsers Reactivate users
RemoveUserGroupMembers Remove user group members
RestoreUsers Restore users
SearchRoles Search roles
SearchUserGroups Search user groups
UnblockUsers Unblock user
UpdateApp Update App Settings
UpdateBlockList Update block list
UpdateExternalStorage Update External Storage
UpdateLiveLocation Update live location
UpdatePermission Update permission
UpdatePoll Update poll
UpdatePollOption Update poll option
UpdatePollPartial Partial update poll
UpdatePushNotificationPreferences Push notification preferences
UpdateUserGroup Update user group
UpdateUsers Upsert users
UpdateUsersPartial Partially update user
UpsertImporterExternalStorage Upsert external storage
UpsertPushProvider Upsert a push provider
UpsertPushTemplate Upsert a push notification template
ValidateImporterExternalStorage Validate external storage

Flags

Flag Description
--app-id <int> id of the app to act on; defaults to the project's app

Global flags

Flag Description
--verbose print API requests and full error details