Stream product:common API
The product:common API from Stream — 54 operation(s) for product:common.
Stream product:common API is one of 19 APIs that Stream publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include product:common. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.
This API exposes 84 operations across 54 paths, and defines 241 schemas. It is described by OpenAPI 3.2.0, at version v228.3.0.
Requests are made against a single base URL, https://chat.stream-io-api.com.
84 operations
54 paths
241 schemas
12 DELETE28 GET3 PATCH34 POST7 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Stream product:common API declares
3 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (JWT).
An API key is passed in the query as api_key (api_key).
An API key is passed in the header as Stream-Auth-Type (stream-auth-type).
By default, every request must be authenticated.
JWT— JWT should be always provided when stream-auth-type=jwt. Using JWT auth request could be authenticated as user or as server-side. When using user authenticatio…api_key— Application API key should be always set in order to authenticate the request.stream-auth-type— Stream-Auth-Type should be always set in order to authenticate the request. Possible values: jwt or anonymous. jwt allows you to authenticate as a user. With t…
Paths & Operations 84
Across 54 paths, the API surfaces 84 operations — 12 DELETE, 28 GET, 3 PATCH, 34 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.
product:common 84
GET
/api/v2/app
Get App Settings
PATCH
/api/v2/app
Update App Settings
GET
/api/v2/blocklists
List block lists
POST
/api/v2/blocklists
Create block list
DELETE
/api/v2/blocklists/{name}
Delete block list
GET
/api/v2/blocklists/{name}
Get block list
PUT
/api/v2/blocklists/{name}
Update block list
POST
/api/v2/check_push
Check push
POST
/api/v2/check_sns
Check SNS
POST
/api/v2/check_sqs
Check SQS
DELETE
/api/v2/devices
Delete device
GET
/api/v2/devices
List devices
POST
/api/v2/devices
Create device
POST
/api/v2/export/users
Export users
GET
/api/v2/external_storage
List external storage
POST
/api/v2/external_storage
Create external storage
DELETE
/api/v2/external_storage/{name}
Delete external storage
PUT
/api/v2/external_storage/{name}
Update External Storage
GET
/api/v2/external_storage/{name}/check
Check External Storage
POST
/api/v2/guest
Create Guest
POST
/api/v2/import_urls
Create import URL
GET
/api/v2/imports
Get import
POST
/api/v2/imports
Create import
GET
/api/v2/imports/{id}
Get import
GET
/api/v2/imports/v2
List import v2 tasks
POST
/api/v2/imports/v2
Create import v2 task
DELETE
/api/v2/imports/v2/{id}
Delete import v2 task
GET
/api/v2/imports/v2/{id}
Get import v2 task
DELETE
/api/v2/imports/v2/external-storage
Delete external storage
GET
/api/v2/imports/v2/external-storage
Get external storage
PUT
/api/v2/imports/v2/external-storage
Upsert external storage
POST
/api/v2/imports/v2/external-storage/validate
Validate external storage
GET
/api/v2/og
Get OG
GET
/api/v2/permissions
List permissions
GET
/api/v2/permissions/{id}
Get permission
POST
/api/v2/polls
Create poll
PUT
/api/v2/polls
Update poll
DELETE
/api/v2/polls/{poll_id}
Delete poll
GET
/api/v2/polls/{poll_id}
Get poll
PATCH
/api/v2/polls/{poll_id}
Partial update poll
POST
/api/v2/polls/{poll_id}/options
Create poll option
PUT
/api/v2/polls/{poll_id}/options
Update poll option
DELETE
/api/v2/polls/{poll_id}/options/{option_id}
Delete poll option
GET
/api/v2/polls/{poll_id}/options/{option_id}
Get poll option
POST
/api/v2/polls/{poll_id}/votes
Query votes
POST
/api/v2/polls/query
Query polls
POST
/api/v2/push_preferences
Push notification preferences
GET
/api/v2/push_providers
List push providers
POST
/api/v2/push_providers
Upsert a push provider
DELETE
/api/v2/push_providers/{type}/{name}
Delete a push provider
GET
/api/v2/push_templates
Get push notification templates
POST
/api/v2/push_templates
Upsert a push notification template
GET
/api/v2/rate_limits
Get rate limits
GET
/api/v2/roles
List roles
POST
/api/v2/roles
Create role
DELETE
/api/v2/roles/{name}
Delete role
GET
/api/v2/tasks/{id}
Get status of a task
DELETE
/api/v2/uploads/file
Delete file
POST
/api/v2/uploads/file
Upload file
DELETE
/api/v2/uploads/image
Delete image
POST
/api/v2/uploads/image
Upload image
GET
/api/v2/usergroups
List user groups
POST
/api/v2/usergroups
Create user group
DELETE
/api/v2/usergroups/{id}
Delete user group
GET
/api/v2/usergroups/{id}
Get user group
PUT
/api/v2/usergroups/{id}
Update user group
POST
/api/v2/usergroups/{id}/members
Add user group members
POST
/api/v2/usergroups/{id}/members/delete
Remove user group members
GET
/api/v2/usergroups/search
Search user groups
GET
/api/v2/users
Query users
PATCH
/api/v2/users
Partially update user
POST
/api/v2/users
Upsert users
POST
/api/v2/users/{user_id}/deactivate
Deactivate user
GET
/api/v2/users/{user_id}/export
Export user
POST
/api/v2/users/{user_id}/reactivate
Reactivate user
GET
/api/v2/users/block
Get list of blocked Users
POST
/api/v2/users/block
Block user
POST
/api/v2/users/deactivate
Deactivate users
POST
/api/v2/users/delete
Delete Users
GET
/api/v2/users/live_locations
Get user live locations
PUT
/api/v2/users/live_locations
Update live location
POST
/api/v2/users/reactivate
Reactivate users
POST
/api/v2/users/restore
Restore users
POST
/api/v2/users/unblock
Unblock user
Schemas 241
The contract defines 241 schemas that model the data the API accepts and returns. The most detailed are AppResponseFields (56 properties), UpdateAppRequest (51 properties), MessageResponse (48 properties), ChannelConfigWithInfo (37 properties). Each schema is shown below with its type and property counts.
UpdateUsersRequest
objectnull
1 property
1 required
CreatePollRequest
objectnull
Contains all information needed to create a new poll
13 properties
1 required
GetBlockedUsersResponse
objectnull
2 properties
2 required
AzureRequest
object
Config for creating Azure Blob Storage storage
4 properties
4 required
LimitInfoResponse
object
3 properties
3 required
ReminderResponseData
object
9 properties
5 required
APNS
object
6 properties
2 required
PushNotificationFields
object
7 properties
6 required
FeedsPreferencesResponse
object
8 properties
ChatPreferences
object
8 properties
FullUserResponse
object
31 properties
19 required
QueryUsersPayload
object
8 properties
1 required
DeactivateUserResponse
objectnull
2 properties
1 required
WebhookFailoverConfig
object
4 properties
APIError
objectnull
8 properties
6 required
ReadReceiptsResponse
object
1 property
ImportV2TaskSettings
object
6 properties
PollVoteResponseData
objectnull
9 properties
5 required
UpdateUsersPartialRequest
objectnull
1 property
1 required
CreateImportV2TaskResponse
objectnull
Basic response information
8 properties
8 required
CreateRoleRequest
objectnull
1 property
1 required
AsyncModerationCallbackConfig
object
2 properties
GeofenceSettings
object
1 property
1 required
EventHook
objectnull
25 properties
ReactionResponse
object
8 properties
8 required
ListBlockListResponse
objectnull
Basic response information
2 properties
2 required
RestoreUsersRequest
objectnull
1 property
1 required
UpsertExternalStorageAWSS3Request
object
4 properties
3 required
FileUploadConfig
object
5 properties
1 required
SearchUserGroupsResponse
objectnull
Response for searching user groups
2 properties
2 required
ScreensharingSettings
object
3 properties
2 required
UpdatePollOptionRequest
objectnull
5 properties
2 required
UpsertPushTemplateRequest
objectnull
5 properties
2 required
IngressVideoEncodingOptions
object
2 properties
1 required
CreateBlockListRequest
objectnull
Block list contains restricted words
6 properties
2 required
APNConfig
object
10 properties
UpdateUserGroupResponse
objectnull
Response for updating a user group
2 properties
1 required
CreateGuestResponse
objectnull
3 properties
3 required
UpdateAppRequest
objectnull
51 properties
RingSettings
object
3 properties
3 required
GetTaskResponse
objectnull
7 properties
5 required
PushProviderRequest
object
24 properties
1 required
ReactivateUsersResponse
objectnull
Basic response information
2 properties
2 required
CreateExternalStorageRequest
objectnull
Create external storage
7 properties
3 required
PushProviderResponse
object
28 properties
4 required
HuaweiConfigFields
object
3 properties
1 required
UpsertPushPreferencesRequest
objectnull
1 property
1 required
ListUserGroupsResponse
objectnull
Response for listing user groups
2 properties
2 required
CreateImportResponse
objectnull
Basic response information
2 properties
1 required
UpdateExternalStorageResponse
objectnull
Basic response information
5 properties
5 required
PrivacySettingsResponse
object
3 properties
DraftResponse
object
7 properties
3 required
GetCustomPermissionResponse
objectnull
Basic response information
2 properties
2 required
HuaweiConfig
object
3 properties
GetExternalStorageResponse
objectnull
Basic response information
5 properties
4 required
GeofenceResponse
objectnull
4 properties
1 required
CreateImportV2TaskRequest
objectnull
Client request
4 properties
2 required
CreatePollOptionRequest
objectnull
4 properties
1 required
CreateGuestRequest
objectnull
1 property
1 required
ModerationDashboardPreferences
object
11 properties
RawRecordSettings
object
2 properties
1 required
GetUserGroupResponse
objectnull
Response for getting a user group
2 properties
1 required
IngressSettings
object
3 properties
1 required
LabelThresholds
object
2 properties
UserGroupMember
objectnull
5 properties
5 required
ChannelConfigWithInfo
object
37 properties
28 required
SortParamRequest
objectnull
3 properties
GetImportResponse
objectnull
Basic response information
2 properties
1 required
UnblockUsersResponse
objectnull
1 property
1 required
FileUploadResponse
objectnull
3 properties
1 required
PushPreferenceInput
objectnull
9 properties
ChannelMute
objectnull
5 properties
2 required
UpsertPushProviderResponse
objectnull
Basic response information
2 properties
2 required
ValidateExternalStorageResponse
objectnull
Basic response information
1 property
1 required
UpdateUsersResponse
objectnull
3 properties
3 required
FirebaseConfig
object
6 properties
CreateImportURLResponse
objectnull
Basic response information
3 properties
3 required
ImageSize
object
4 properties
UpsertPushPreferencesResponse
objectnull
3 properties
3 required
BlockListOptions
object
2 properties
2 required
ReactionGroupResponse
objectnull
ReactionGroupResponse contains all information about a reaction of the same type.
5 properties
5 required
SharedLocationsResponse
objectnull
2 properties
2 required
RemoveUserGroupMembersResponse
objectnull
Response for removing members from a user group
2 properties
1 required
ImageData
object
5 properties
5 required
AddUserGroupMembersResponse
objectnull
Response for adding members to a user group
2 properties
1 required
BroadcastSettings
object
3 properties
1 required
FCM
object
1 property
UpdateExternalStorageRequest
objectnull
External storage
6 properties
2 required
QueryPollVotesRequest
objectnull
5 properties
ChannelPushPreferencesResponse
objectnull
3 properties
ErrorResult
object
4 properties
2 required
Response
objectnull
Basic response information
1 property
1 required
BlockUsersRequest
objectnull
3 properties
1 required
TypingIndicatorsResponse
object
1 property
QueryPollsRequest
objectnull
5 properties
BlockedUserResponse
objectnull
5 properties
5 required
DeviceResponse
objectnull
Response for Device
8 properties
4 required
GetApplicationResponse
objectnull
Basic response information
2 properties
2 required
FrameRecordSettings
object
3 properties
2 required
DeactivateUsersRequest
objectnull
Deactivate users request
4 properties
1 required
UserResponse
object
User response object
25 properties
12 required
CreateImportURLRequest
objectnull
1 property
NotificationSettings
object
6 properties
6 required
CreateExternalStorageResponse
objectnull
Basic response information
1 property
1 required
AddUserGroupMembersRequest
objectnull
Request body for adding members to a user group
3 properties
1 required
ListImportsResponse
objectnull
Basic response information
2 properties
2 required
ReactivateUsersRequest
objectnull
Reactivate users in batches
4 properties
1 required
SpeechSegmentConfig
object
2 properties
UpdatePollPartialRequest
objectnull
4 properties
FirebaseConfigFields
object
6 properties
1 required
ImageUploadRequest
objectnull
3 properties
OnlyUserID
object
1 property
1 required
AppResponseFields
object
56 properties
48 required
CheckSNSRequest
objectnull
3 properties
TargetResolution
object
3 properties
3 required
IndividualRecordSettings
object
2 properties
1 required
ChatPreferencesResponse
object
7 properties
GetImportV2TaskResponse
objectnull
Basic response information
9 properties
8 required
QueryPollsResponse
objectnull
4 properties
2 required
EventNotificationSettings
object
3 properties
3 required
VideoSettings
object
5 properties
5 required
APNConfigFields
object
10 properties
2 required
DataDogInfo
object
3 properties
PollOptionRequest
objectnull
3 properties
1 required
GetExternalStorageAWSS3Response
object
4 properties
3 required
ExportUserResponse
objectnull
4 properties
1 required
ExternalStorageResponse
object
4 properties
4 required
DeleteUsersResponse
objectnull
2 properties
2 required
ExportUsersRequest
objectnull
1 property
1 required
ImageUploadResponse
objectnull
4 properties
1 required
UpdateBlockListResponse
objectnull
Basic response information
2 properties
1 required
Field
objectnull
3 properties
3 required
Permission
object
10 properties
9 required
BlockUsersResponse
objectnull
4 properties
4 required
CreateBlockListResponse
objectnull
Basic response information
2 properties
1 required
ImportV2TaskSettingsS3
object
3 properties
Policy
object
8 properties
8 required
GetPushTemplatesResponse
objectnull
Basic response information
2 properties
2 required
AudioSettings
object
8 properties
7 required
CheckPushResponse
objectnull
8 properties
1 required
DeviceErrorInfo
object
3 properties
3 required
XiaomiConfigFields
object
3 properties
1 required
UserRequest
object
User request object
10 properties
1 required
S3Request
object
Config for creating Amazon S3 storage.
4 properties
1 required
UpdateUserGroupRequest
objectnull
Request body for updating a user group
3 properties
CheckSQSRequest
objectnull
3 properties
HLSSettings
object
4 properties
3 required
CallSettings
object
16 properties
Role
object
5 properties
5 required
GetBlockListResponse
objectnull
Response for get block list
2 properties
1 required
UpsertPushTemplateResponse
objectnull
Basic response information
2 properties
1 required
UpdateBlockListRequest
objectnull
4 properties
AsyncModerationConfiguration
object
2 properties
ListDevicesResponse
objectnull
List devices response
2 properties
2 required
CallType
objectnull
8 properties
6 required
RTMPSettings
object
4 properties
1 required
CreateUserGroupRequest
objectnull
Request body for creating a user group
5 properties
1 required
DraftPayloadResponse
object
Contains the draft message content
13 properties
3 required
PollVotesResponse
objectnull
4 properties
2 required
PushPreferencesResponse
objectnull
6 properties
RecordSettings
object
4 properties
1 required
ChannelConfig
objectnull
36 properties
28 required
UpdatePollRequest
objectnull
13 properties
2 required
FileUploadRequest
objectnull
2 properties
ListPermissionsResponse
objectnull
Basic response information
2 properties
2 required
Attachment
objectnull
An attachment is a message object that represents a file uploaded by a user.
22 properties
1 required
CreateImportRequest
objectnull
3 properties
2 required
ReactivateUserRequest
objectnull
3 properties
ModerationV2Response
object
8 properties
2 required
BlockListResponse
object
Block list contains restricted words
9 properties
5 required
RTMPLocation
object
3 properties
3 required
ThumbnailsSettings
object
1 property
1 required
DeliveryReceiptsResponse
object
1 property
IngressAudioEncodingOptions
object
3 properties
3 required
UpsertExternalStorageRequest
objectnull
2 properties
1 required
UpdateUserPartialRequest
object
3 properties
1 required
TranslationSettings
object
2 properties
2 required
TranscriptionSettings
object
5 properties
4 required
PushProvider
objectnull
28 properties
4 required
Images
object
7 properties
7 required
GetOGResponse
objectnull
23 properties
2 required
SessionSettings
object
1 property
1 required
CreateRoleResponse
objectnull
Basic response information
2 properties
2 required
CheckPushRequest
objectnull
Check push request
10 properties
PollOptionInput
objectnull
2 properties
PollResponse
objectnull
2 properties
2 required
UpsertExternalStorageResponse
objectnull
Basic response information
1 property
1 required
ReactionGroupUserResponse
object
Contains information about a user who reacted with this reaction type.
3 properties
2 required
CreateDeviceRequest
objectnull
Create device request
6 properties
2 required
PushNotificationSettingsResponse
object
2 properties
ImportTaskHistory
objectnull
3 properties
3 required
Action
objectnull
5 properties
3 required
LayoutSettings
object
5 properties
3 required
NoiseCancellationSettings
object
1 property
1 required
DeleteImportV2TaskResponse
objectnull
Basic response information
1 property
1 required
PushConfig
object
2 properties
1 required
LimitsSettings
object
4 properties
1 required
CheckSNSResponse
objectnull
4 properties
2 required
UserGroupResponse
object
8 properties
4 required
ChannelMemberResponse
objectnull
20 properties
7 required
ChannelResponse
object
Represents channel in chat
28 properties
8 required
RemoveUserGroupMembersRequest
objectnull
Request body for removing members from a user group
2 properties
1 required
ImportV2TaskItem
object
8 properties
7 required
ListRolesResponse
objectnull
Basic response information
2 properties
2 required
ListImportV2TasksResponse
objectnull
Basic response information
4 properties
2 required
ListExternalStorageResponse
objectnull
Basic response information
2 properties
2 required
Command
objectnull
Represents custom chat command
6 properties
4 required
QueryUsersResponse
objectnull
2 properties
2 required
DeactivateUserRequest
objectnull
2 properties
MessageResponse
object
Represents any chat message
48 properties
23 required
PushTemplateResponse
object
6 properties
5 required
DeactivateUsersResponse
objectnull
Basic response information
2 properties
2 required
SharedLocationResponseData
object
11 properties
8 required
ChatPreferencesInput
object
7 properties
ChannelOwnCapability
string
All possibility of string to use
CheckSQSResponse
objectnull
4 properties
2 required
DeleteUsersRequest
objectnull
8 properties
1 required
PushTemplate
objectnull
5 properties
4 required
UpdateLiveLocationRequest
objectnull
4 properties
1 required
UpsertPushProviderRequest
objectnull
1 property
PollOptionResponse
objectnull
2 properties
2 required
SharedLocationResponse
objectnull
12 properties
9 required
ImportTask
object
8 properties
7 required
ReactivateUserResponse
objectnull
2 properties
1 required
IngressSource
object
3 properties
3 required
DeleteExternalStorageResponse
objectnull
Basic response information
1 property
1 required
XiaomiConfig
object
3 properties
IngressVideoLayer
objectnull
5 properties
5 required
UserMuteResponse
objectnull
5 properties
2 required
BackstageSettings
object
2 properties
1 required
ExportUsersResponse
objectnull
Basic response information
2 properties
2 required
CheckExternalStorageResponse
objectnull
Basic response information
2 properties
2 required
UnblockUsersRequest
objectnull
3 properties
1 required
OverviewDashboardConfig
object
2 properties
PollOptionResponseData
objectnull
3 properties
3 required
GetRateLimitsResponse
objectnull
5 properties
1 required
ListPushProvidersResponse
objectnull
Basic response information
2 properties
2 required
Thresholds
object
Sets thresholds for AI moderation
3 properties
CreateUserGroupResponse
objectnull
Response for creating a user group
2 properties
1 required
PollResponseData
object
21 properties
18 required
FeedsPreferences
object
8 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Stream 12
Other APIs Stream publishes across the network.
Stream Activity Feeds API
Stream Video and Audio API
Stream Application API
Stream Campaigns API
Stream Channels API
Stream Devices API
Stream Members API
Stream Messages API
Stream Moderation API
Stream Permissions API
Stream Reactions API
Stream Roles API
#product:common
Where this information came from
This is an independent, third-party profile of Stream product:common API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.