Stream product:video API
The product:video API from Stream — 121 operation(s) for product:video.
Stream product:video 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:video. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.
This API exposes 143 operations across 121 paths, and defines 333 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.
143 operations
121 paths
333 schemas
12 DELETE35 GET2 PATCH87 POST7 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Stream product:video 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 143
Across 121 paths, the API surfaces 143 operations — 12 DELETE, 35 GET, 2 PATCH, 87 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.
product:video 143
GET
/api/v2/video/active_calls_status
Get active calls status
GET
/api/v2/video/call/{type}/{id}
Get Call
PATCH
/api/v2/video/call/{type}/{id}
Update Call
POST
/api/v2/video/call/{type}/{id}
Get or create a call
DELETE
/api/v2/video/call/{type}/{id}/{session}/recordings/{filename}
Delete recording
DELETE
/api/v2/video/call/{type}/{id}/{session}/transcriptions/{filename}
Delete transcription
POST
/api/v2/video/call/{type}/{id}/block
Block user on a call
POST
/api/v2/video/call/{type}/{id}/closed_captions
Send closed caption
POST
/api/v2/video/call/{type}/{id}/delete
Delete Call
POST
/api/v2/video/call/{type}/{id}/event
Send custom event
POST
/api/v2/video/call/{type}/{id}/feedback
Collect user feedback
POST
/api/v2/video/call/{type}/{id}/go_live
Set call as live
POST
/api/v2/video/call/{type}/{id}/kick
Kick user from a call
POST
/api/v2/video/call/{type}/{id}/mark_ended
End call
POST
/api/v2/video/call/{type}/{id}/members
Update Call Member
POST
/api/v2/video/call/{type}/{id}/mute_users
Mute users
POST
/api/v2/video/call/{type}/{id}/participants
Query call participants
POST
/api/v2/video/call/{type}/{id}/pin
Pin
GET
/api/v2/video/call/{type}/{id}/recordings
List recordings
POST
/api/v2/video/call/{type}/{id}/recordings/{recording_type}/start
Start recording
POST
/api/v2/video/call/{type}/{id}/recordings/{recording_type}/stop
Stop recording
GET
/api/v2/video/call/{type}/{id}/report
Get call report
POST
/api/v2/video/call/{type}/{id}/ring
Ring Call Users
POST
/api/v2/video/call/{type}/{id}/rtmp_broadcasts
Start RTMP broadcasts
POST
/api/v2/video/call/{type}/{id}/rtmp_broadcasts/{name}/stop
Stop RTMP broadcasts
POST
/api/v2/video/call/{type}/{id}/rtmp_broadcasts/stop
Stop all RTMP broadcasts for a call
GET
/api/v2/video/call/{type}/{id}/session/{session}/participant/{user}/{user_session}/details/track
Get call participant session metrics
GET
/api/v2/video/call/{type}/{id}/session/{session}/participant_sessions
Query call participant sessions
POST
/api/v2/video/call/{type}/{id}/start_broadcasting
Start HLS broadcasting
POST
/api/v2/video/call/{type}/{id}/start_closed_captions
Start closed captions
POST
/api/v2/video/call/{type}/{id}/start_frame_recording
Start frame recording
POST
/api/v2/video/call/{type}/{id}/start_transcription
Start transcription
POST
/api/v2/video/call/{type}/{id}/stop_broadcasting
Stop HLS broadcasting
POST
/api/v2/video/call/{type}/{id}/stop_closed_captions
Stop closed captions
POST
/api/v2/video/call/{type}/{id}/stop_frame_recording
Stop frame recording
POST
/api/v2/video/call/{type}/{id}/stop_live
Set call as not live
POST
/api/v2/video/call/{type}/{id}/stop_transcription
Stop transcription
GET
/api/v2/video/call/{type}/{id}/transcriptions
List transcriptions
POST
/api/v2/video/call/{type}/{id}/unblock
Unblocks user on a call
POST
/api/v2/video/call/{type}/{id}/unpin
Unpin
POST
/api/v2/video/call/{type}/{id}/user_permissions
Update user permissions
POST
/api/v2/video/call/feedback
Query user reported feedback for the calls
POST
/api/v2/video/call/members
Query call members
POST
/api/v2/video/call/stats
Query Call Stats
POST
/api/v2/video/call_stats
Query call session stats
GET
/api/v2/video/call_stats/{call_type}/{call_id}/{session}/map
Map call participants by location
GET
/api/v2/video/call_stats/{call_type}/{call_id}/{session}/participant/{user}/{user_session}/details
Get call session participant stats details
GET
/api/v2/video/call_stats/{call_type}/{call_id}/{session}/participants
Query call participant statistics
GET
/api/v2/video/call_stats/{call_type}/{call_id}/{session}/participants/{user}/{user_session}/timeline
Get participant timeline events
POST
/api/v2/video/calls
Query call
GET
/api/v2/video/calltypes
List Call Type
POST
/api/v2/video/calltypes
Create Call Type
DELETE
/api/v2/video/calltypes/{name}
Delete Call Type
GET
/api/v2/video/calltypes/{name}
Get Call Type
PUT
/api/v2/video/calltypes/{name}
Update Call Type
GET
/api/v2/video/edges
Get Edges
POST
/api/v2/video/sip/auth
Resolve SIP Auth
GET
/api/v2/video/sip/inbound_routing_rules
List SIP Inbound Routing Rules
POST
/api/v2/video/sip/inbound_routing_rules
Create SIP Inbound Routing Rule
DELETE
/api/v2/video/sip/inbound_routing_rules/{id}
Delete SIP Inbound Routing Rule
PUT
/api/v2/video/sip/inbound_routing_rules/{id}
Update SIP Inbound Routing Rule
GET
/api/v2/video/sip/inbound_trunks
List SIP Trunks
POST
/api/v2/video/sip/inbound_trunks
Create SIP Trunk
DELETE
/api/v2/video/sip/inbound_trunks/{id}
Delete SIP Trunk
PUT
/api/v2/video/sip/inbound_trunks/{id}
Update SIP Trunk
POST
/api/v2/video/sip/resolve
Resolve SIP Inbound Routing
POST
/api/v2/video/stats
Query Aggregate call Stats
GET
/video/active_calls_status
Get active calls status
GET
/video/call/{type}/{id}
Get Call
PATCH
/video/call/{type}/{id}
Update Call
POST
/video/call/{type}/{id}
Get or create a call
DELETE
/video/call/{type}/{id}/{session}/recordings/{filename}
Delete recording
DELETE
/video/call/{type}/{id}/{session}/transcriptions/{filename}
Delete transcription
POST
/video/call/{type}/{id}/block
Block user on a call
POST
/video/call/{type}/{id}/closed_captions
Send closed caption
POST
/video/call/{type}/{id}/delete
Delete Call
POST
/video/call/{type}/{id}/event
Send custom event
POST
/video/call/{type}/{id}/feedback
Collect user feedback
POST
/video/call/{type}/{id}/go_live
Set call as live
POST
/video/call/{type}/{id}/kick
Kick user from a call
POST
/video/call/{type}/{id}/mark_ended
End call
POST
/video/call/{type}/{id}/members
Update Call Member
POST
/video/call/{type}/{id}/mute_users
Mute users
POST
/video/call/{type}/{id}/participants
Query call participants
POST
/video/call/{type}/{id}/pin
Pin
GET
/video/call/{type}/{id}/recordings
List recordings
POST
/video/call/{type}/{id}/recordings/{recording_type}/start
Start recording
POST
/video/call/{type}/{id}/recordings/{recording_type}/stop
Stop recording
GET
/video/call/{type}/{id}/report
Get call report
POST
/video/call/{type}/{id}/ring
Ring Call Users
POST
/video/call/{type}/{id}/rtmp_broadcasts
Start RTMP broadcasts
POST
/video/call/{type}/{id}/rtmp_broadcasts/{name}/stop
Stop RTMP broadcasts
POST
/video/call/{type}/{id}/rtmp_broadcasts/stop
Stop all RTMP broadcasts for a call
GET
/video/call/{type}/{id}/session/{session}/participant/{user}/{user_session}/details/track
Get call participant session metrics
GET
/video/call/{type}/{id}/session/{session}/participant_sessions
Query call participant sessions
POST
/video/call/{type}/{id}/start_broadcasting
Start HLS broadcasting
POST
/video/call/{type}/{id}/start_closed_captions
Start closed captions
POST
/video/call/{type}/{id}/start_frame_recording
Start frame recording
POST
/video/call/{type}/{id}/start_transcription
Start transcription
POST
/video/call/{type}/{id}/stop_broadcasting
Stop HLS broadcasting
POST
/video/call/{type}/{id}/stop_closed_captions
Stop closed captions
POST
/video/call/{type}/{id}/stop_frame_recording
Stop frame recording
POST
/video/call/{type}/{id}/stop_live
Set call as not live
POST
/video/call/{type}/{id}/stop_transcription
Stop transcription
GET
/video/call/{type}/{id}/transcriptions
List transcriptions
POST
/video/call/{type}/{id}/unblock
Unblocks user on a call
POST
/video/call/{type}/{id}/unpin
Unpin
POST
/video/call/{type}/{id}/user_permissions
Update user permissions
POST
/video/call/feedback
Query user reported feedback for the calls
POST
/video/call/members
Query call members
POST
/video/call/stats
Query Call Stats
POST
/video/call_stats
Query call session stats
GET
/video/call_stats/{call_type}/{call_id}/{session}/map
Map call participants by location
GET
/video/call_stats/{call_type}/{call_id}/{session}/participant/{user}/{user_session}/details
Get call session participant stats details
GET
/video/call_stats/{call_type}/{call_id}/{session}/participants
Query call participant statistics
GET
/video/call_stats/{call_type}/{call_id}/{session}/participants/{user}/{user_session}/timeline
Get participant timeline events
POST
/video/calls
Query call
GET
/video/calltypes
List Call Type
POST
/video/calltypes
Create Call Type
DELETE
/video/calltypes/{name}
Delete Call Type
GET
/video/calltypes/{name}
Get Call Type
PUT
/video/calltypes/{name}
Update Call Type
DELETE
/video/devices
Delete device
GET
/video/devices
List devices
POST
/video/devices
Create device
GET
/video/edges
Get Edges
GET
/video/external_storage
List external storage
POST
/video/external_storage
Create external storage
DELETE
/video/external_storage/{name}
Delete external storage
PUT
/video/external_storage/{name}
Update External Storage
GET
/video/external_storage/{name}/check
Check External Storage
POST
/video/guest
Create Guest
POST
/video/sip/auth
Resolve SIP Auth
GET
/video/sip/inbound_routing_rules
List SIP Inbound Routing Rules
POST
/video/sip/inbound_routing_rules
Create SIP Inbound Routing Rule
DELETE
/video/sip/inbound_routing_rules/{id}
Delete SIP Inbound Routing Rule
PUT
/video/sip/inbound_routing_rules/{id}
Update SIP Inbound Routing Rule
GET
/video/sip/inbound_trunks
List SIP Trunks
POST
/video/sip/inbound_trunks
Create SIP Trunk
DELETE
/video/sip/inbound_trunks/{id}
Delete SIP Trunk
PUT
/video/sip/inbound_trunks/{id}
Update SIP Trunk
POST
/video/sip/resolve
Resolve SIP Inbound Routing
POST
/video/stats
Query Aggregate call Stats
Schemas 333
The contract defines 333 schemas that model the data the API accepts and returns. The most detailed are CallResponse (25 properties), UserResponse (25 properties), UserResponse_2 (23 properties), CallStatsParticipantSession (22 properties). Each schema is shown below with its type and property counts.
FrameRecordingSettingsResponse
object
3 properties
2 required
QueryCallMembersRequest
objectnull
7 properties
2 required
RingCallRequest
objectnull
2 properties
UpdateSIPInboundRoutingRuleRequest
objectnull
Request to update a SIP Inbound Routing Rule
9 properties
3 required
APIError
objectnull
8 properties
6 required
PublishedTrackMetrics
object
7 properties
PinResponse
objectnull
Basic response information
1 property
1 required
RingSettingsRequest
object
3 properties
2 required
StartRTMPBroadcastsRequest
objectnull
StartRTMPBroadcastsRequest is the payload for starting RTMP broadcasts.
1 property
1 required
CallStatsMapSubscriber
object
5 properties
3 required
GoLiveRequest
objectnull
9 properties
ThumbnailsSettingsRequest
object
1 property
StopLiveRequest
objectnull
8 properties
QualityScoreReportResponse
object
1 property
1 required
EventNotificationSettingsResponse
object
3 properties
3 required
UpdateExternalStorageResponse
objectnull
Basic response information
5 properties
5 required
CallRequest
object
CallRequest is the payload for creating a call.
9 properties
CallSessionResponse
object
12 properties
7 required
SubscriberAllMetrics
object
3 properties
SubscriberVideoMetrics
object
3 properties
BroadcastSettingsResponse
object
BroadcastSettingsResponse is the payload for broadcasting settings
3 properties
3 required
ListSIPInboundRoutingRuleResponse
objectnull
Response containing the list of SIP Inbound Routing Rules
2 properties
2 required
ActiveCallsMetrics
object
3 properties
CallsPerDayReport
object
1 property
1 required
SendClosedCaptionResponse
objectnull
1 property
1 required
TranscriptionSettingsRequest
object
5 properties
SIPPinProtectionConfigsResponse
object
PIN protection configuration response
4 properties
1 required
CallStatsParticipant
object
5 properties
2 required
CreateExternalStorageResponse
objectnull
Basic response information
1 property
1 required
CallReportResponse
object
3 properties
1 required
ResolveSipInboundResponse
objectnull
Response containing resolved SIP inbound routing information
4 properties
2 required
IngressAudioEncodingOptionsRequest
object
3 properties
2 required
UserFeedbackReport
object
2 properties
2 required
ParticipantSeriesTimeframe
object
4 properties
4 required
SFULocationResponse
object
5 properties
4 required
ParticipantReportResponse
object
10 properties
2 required
CallSettingsResponse
object
16 properties
15 required
SendCallEventResponse
objectnull
1 property
1 required
IngressSettingsRequest
object
3 properties
DailyAggregateCallsPerDayReportResponse
object
2 properties
2 required
UserRequest
object
User request object
10 properties
1 required
ChatActivityStatsResponse
object
1 property
SIPDirectRoutingRuleCallConfigsRequest
object
Configuration for direct routing rule calls
2 properties
2 required
ListDevicesResponse
objectnull
List devices response
2 properties
2 required
StopAllRTMPBroadcastsResponse
objectnull
1 property
1 required
QueryUserFeedbackResponse
objectnull
Basic response information
4 properties
2 required
LocationResponse
object
Geographic location metadata
3 properties
3 required
QueryCallSessionParticipantStatsTimelineResponse
objectnull
Basic response information
7 properties
7 required
CollectUserFeedbackResponse
objectnull
Basic response information
1 property
1 required
CollectUserFeedbackRequest
objectnull
6 properties
3 required
CountByMinuteResponse
objectnull
2 properties
2 required
RawRecordingSettingsResponse
object
2 properties
1 required
GetCallParticipantSessionMetricsResponse
objectnull
Basic response information
9 properties
1 required
ScreensharingSettingsRequest
object
3 properties
CallParticipantResponse
object
4 properties
4 required
CallDurationReport
object
1 property
1 required
SessionSettingsResponse
object
1 property
1 required
BackstageSettingsResponse
object
2 properties
1 required
BlockUserResponse
objectnull
BlockUserResponse is the payload for blocking a user.
1 property
1 required
PushNotificationSettingsResponse
object
2 properties
SIPTrunkResponse
object
SIP trunk information
9 properties
9 required
MemberRequest
object
MemberRequest is the payload for adding a member to a call.
3 properties
1 required
CallStatsParticipantSession_2
object
22 properties
3 required
ResolutionMetricsTimeSeries
object
2 properties
ListTranscriptionsResponse
objectnull
2 properties
2 required
SessionWarningResponse
object
3 properties
2 required
QueryUserFeedbackRequest
objectnull
5 properties
ParticipantSeriesSubscriptionTrackMetrics
object
4 properties
1 required
PrivacySettingsResponse_2
object
CallStatsMapPublishers
object
1 property
1 required
UpdateUserPermissionsRequest
objectnull
3 properties
1 required
ActiveCallsLatencyStats
object
2 properties
2 required
StartTranscriptionResponse
objectnull
1 property
1 required
UserFeedbackResponse
object
9 properties
8 required
EgressRTMPResponse
object
4 properties
2 required
ActiveCallsResolutionStats
object
2 properties
2 required
SessionSettingsRequest
object
1 property
1 required
SIPInboundRoutingRuleRequest
objectnull
Request to create or update a SIP Inbound Routing Rule
9 properties
3 required
VideoSettingsRequest
object
5 properties
StartFrameRecordingResponse
objectnull
StartFrameRecordingResponse is the response payload for the start frame recording endpoint.
1 property
1 required
SIPCallConfigsRequest
object
Configuration for SIP call settings
1 property
StopClosedCaptionsRequest
objectnull
1 property
PublisherStatsResponse
object
3 properties
2 required
SDKUsageReport
object
1 property
1 required
IngressVideoEncodingResponse
object
2 properties
2 required
ReportResponse
object
3 properties
3 required
QueryCallSessionParticipantStatsResponse
objectnull
Basic response information
12 properties
6 required
CallStatsMapSFUs
object
1 property
1 required
ParticipantSeriesTrackMetrics
object
9 properties
1 required
StopRecordingResponse
objectnull
Basic response information
1 property
1 required
RTMPSettingsResponse
object
RTMPSettingsResponse is the payload for RTMP settings
3 properties
3 required
CreateGuestResponse
objectnull
3 properties
3 required
StopLiveResponse
objectnull
2 properties
2 required
UpdateCallTypeResponse_2
objectnull
UpdateCallTypeResponse is the payload for updating a call type.
8 properties
7 required
BackstageSettingsRequest
object
2 properties
DeleteCallRequest
objectnull
DeleteCallRequest is the payload for deleting a call.
1 property
Bound
object
2 properties
2 required
SRTIngress
object
1 property
1 required
QueryCallSessionParticipantStatsResponse_2
objectnull
Basic response information
12 properties
6 required
PublisherVideoMetrics
object
5 properties
EdgeResponse
object
10 properties
10 required
DailyAggregateSDKUsageReportResponse
object
2 properties
2 required
GroupedStatsResponse
objectnull
2 properties
2 required
IndividualRecordingResponse
object
1 property
1 required
MetricTimeSeries
object
1 property
APNSPayload
object
6 properties
IngressVideoEncodingOptionsRequest
object
2 properties
2 required
RTMPSettingsRequest
object
3 properties
PlatformDataResponse
object
3 properties
3 required
UpdateUserPermissionsResponse
objectnull
Basic response information
1 property
1 required
ParticipantSeriesUserStats
object
4 properties
MetricDescriptor
object
3 properties
1 required
GetCallTypeResponse
objectnull
8 properties
7 required
PublishersMetrics
object
1 property
RingCallResponse
objectnull
2 properties
2 required
QueryCallsResponse
objectnull
4 properties
2 required
UserResponse
object
User response object
25 properties
12 required
SpeechSegmentConfig
object
2 properties
QueryCallStatsRequest
objectnull
5 properties
ReportByHistogramBucket
object
5 properties
3 required
EgressResponse
object
7 properties
2 required
PerSDKUsageReport
objectnull
2 properties
2 required
LayoutSettingsResponse
object
5 properties
3 required
QueryCallParticipantsRequest
objectnull
1 property
TargetResolution
object
3 properties
3 required
MessageStatsResponse
object
1 property
QueryCallStatsResponse
objectnull
Basic response information
4 properties
2 required
QueryCallStatsMapResponse
objectnull
Basic response information
14 properties
5 required
MetricThreshold
object
5 properties
3 required
ResolveSipAuthResponse
objectnull
Response containing the pre-authentication decision for a SIP trunk
5 properties
2 required
CallStatsLocation
object
8 properties
DailyAggregateUserFeedbackReportResponse
object
2 properties
2 required
DeleteTranscriptionResponse
objectnull
DeleteTranscriptionResponse is the payload for deleting a transcription.
1 property
1 required
RTMPBroadcastRequest
object
RTMPBroadcastRequest is the payload for starting an RTMP broadcast.
5 properties
2 required
GetCallResponse
objectnull
4 properties
5 required
CoordinatesResponse
object
Geographic coordinates
2 properties
2 required
SIPCallConfigsResponse
object
SIP call configuration response
1 property
1 required
ListCallTypeResponse
objectnull
Response for ListCallType
2 properties
2 required
CallsPerDayReportResponse
object
1 property
1 required
DeleteCallResponse
objectnull
DeleteCallResponse is the payload for deleting a call.
3 properties
2 required
RecordSettingsResponse
object
RecordSettings is the payload for recording settings
4 properties
4 required
CallTranscription
object
CallTranscription represents a transcription of a call.
5 properties
5 required
DeliveryReceiptsResponse
object
1 property
TranslationSettings
object
2 properties
2 required
QueryCallParticipantsResponse
objectnull
6 properties
7 required
GoLiveResponse
objectnull
Basic response information
2 properties
2 required
CreateDeviceRequest
objectnull
Create device request
6 properties
2 required
UpdateCallRequest_2
objectnull
Request for updating a call
3 properties
NoiseCancellationSettings
object
1 property
1 required
CallStatsSessionResponse
object
7 properties
5 required
QueryAggregateCallStatsResponse
objectnull
Basic response information
8 properties
1 required
RingSettingsResponse
object
3 properties
3 required
SubscriberStatsResponse
object
3 properties
3 required
CreateCallTypeResponse_2
objectnull
Response for creating a call type
8 properties
7 required
UpdateSIPTrunkRequest
objectnull
Request to update a SIP trunk
4 properties
2 required
DailyAggregateQualityScoreReportResponse
object
2 properties
2 required
SubscribersMetrics
object
1 property
FrameRecordingSettingsRequest
object
3 properties
2 required
IngressSettingsResponse
object
3 properties
1 required
StartHLSBroadcastingResponse
objectnull
StartHLSBroadcastingResponse is the payload for starting an HLS broadcasting.
2 properties
2 required
OwnCapability
string
All possibility of string to use
UpdateCallRequest
objectnull
Request for updating a call
3 properties
MemberResponse
object
MemberResponse is the payload for a member of a call.
7 properties
5 required
LimitsSettingsResponse
object
4 properties
1 required
IndividualRecordingSettingsRequest
object
2 properties
1 required
CheckExternalStorageResponse
objectnull
Basic response information
2 properties
2 required
ClientOSDataResponse
object
3 properties
GetCallSessionParticipantStatsDetailsResponse
objectnull
Basic response information
10 properties
6 required
StopRecordingRequest
objectnull
QualityScoreReport
object
1 property
1 required
AzureRequest
object
Config for creating Azure Blob Storage storage
4 properties
4 required
TranscriptionSettingsResponse
object
5 properties
4 required
ParticipantSeriesPublisherStats
object
5 properties
CreateSIPTrunkRequest
objectnull
Request to create a new SIP trunk
4 properties
2 required
GetCallParticipantSessionMetricsResponse_2
objectnull
Basic response information
9 properties
1 required
CallStatsParticipantSession
object
22 properties
3 required
StartClosedCaptionsRequest
objectnull
4 properties
QueryCallsRequest
objectnull
5 properties
ActiveCallsBitrateStats
object
2 properties
2 required
DeleteSIPInboundRoutingRuleResponse
objectnull
Response confirming SIP Inbound Routing Rule deletion
1 property
1 required
SendClosedCaptionRequest
objectnull
9 properties
2 required
QueryCallSessionStatsResponse
objectnull
Basic response information
4 properties
2 required
JoinCallAPIMetrics
object
3 properties
2 required
UpdateCallTypeRequest
objectnull
UpdateCallTypeRequest is the payload for updating a call type.
4 properties
IngressSourceRequest
object
3 properties
3 required
HLSSettingsRequest
object
4 properties
1 required
CreateExternalStorageRequest
objectnull
Create external storage
7 properties
3 required
MuteUsersResponse
objectnull
MuteUsersResponse is the response payload for the mute users endpoint.
1 property
1 required
CallSettingsRequest
object
16 properties
GeofenceSettingsRequest
object
1 property
StartTranscriptionRequest
objectnull
3 properties
PrivacySettingsResponse
object
3 properties
ParticipantSeriesSubscriberStats
object
5 properties
GetOrCreateCallRequest
objectnull
5 properties
CreateGuestRequest
objectnull
1 property
1 required
NotificationSettingsResponse
object
6 properties
6 required
StopHLSBroadcastingResponse
objectnull
Basic response information
1 property
1 required
BroadcastSettingsRequest
object
3 properties
SortParamRequest
objectnull
3 properties
ThumbnailsSettingsResponse
object
1 property
1 required
PublisherAudioMetrics
object
1 property
AudioSettingsRequest
object
8 properties
1 required
UpdateExternalStorageRequest
objectnull
External storage
6 properties
2 required
GetActiveCallsStatusResponse
objectnull
Response containing active calls status information
5 properties
3 required
RTMPIngress
object
RTMP input settings
1 property
1 required
DeviceResponse
objectnull
Response for Device
8 properties
4 required
FCMPayload
object
1 property
ListRecordingsResponse
objectnull
Response for listing recordings
2 properties
2 required
CallStatsMapPublisher
object
7 properties
4 required
IngressAudioEncodingResponse
object
3 properties
3 required
ParticipantCountOverTimeResponse
object
1 property
CallLevelEventPayload
object
4 properties
3 required
SIPInboundRoutingRuleResponse_2
objectnull
SIP Inbound Routing Rule response
13 properties
7 required
CallResponse
object
Represents a call
25 properties
17 required
StartRecordingResponse
objectnull
StartRecordingResponse is the response payload for the start recording endpoint.
1 property
1 required
VideoReactionOverTimeResponse
object
1 property
ThumbnailResponse
object
1 property
1 required
CallStatsParticipant_2
object
5 properties
2 required
ExternalStorageResponse
object
4 properties
4 required
FrameRecordingResponse
object
1 property
1 required
ResolveSipInboundRequest
objectnull
Request to resolve SIP inbound routing using challenge authentication
6 properties
2 required
IngressVideoLayerRequest
objectnull
5 properties
5 required
TrackStatsResponse
objectnull
2 properties
2 required
CreateCallTypeResponse
objectnull
Response for creating a call type
8 properties
7 required
S3Request
object
Config for creating Amazon S3 storage.
4 properties
1 required
CallStatsReportSummaryResponse
object
8 properties
5 required
RawRecordingResponse
object
1 property
1 required
StopFrameRecordingResponse
objectnull
Basic response information
1 property
1 required
QueryCallStatsMapResponse_2
objectnull
Basic response information
14 properties
5 required
StopRTMPBroadcastsResponse
objectnull
Basic response information
1 property
1 required
StopRTMPBroadcastsRequest
objectnull
Request for stopping RTMP broadcasts
CallTypeResponse
object
CallTypeResponse is the payload for a call type.
7 properties
6 required
PushNotificationSettingsResponse_2
object
2 properties
SendCallEventRequest
objectnull
Send a call event to the other user
3 properties
BlockUserRequest
objectnull
BlockUserRequest is the payload for blocking a user.
1 property
1 required
CallParticipantCountReportResponse
object
1 property
1 required
QueryAggregateCallStatsRequest
objectnull
3 properties
ListExternalStorageResponse
objectnull
Basic response information
2 properties
2 required
HLSSettingsResponse
object
HLSSettings is the payload for HLS settings
4 properties
4 required
DeviceDataResponse
object
2 properties
CallIngressResponse
object
CallIngressResponse is the payload for ingress settings
3 properties
3 required
DeleteExternalStorageResponse
objectnull
Basic response information
1 property
1 required
UpdateCallTypeResponse
objectnull
UpdateCallTypeResponse is the payload for updating a call type.
8 properties
7 required
DailyAggregateCallDurationReportResponse
object
2 properties
2 required
UserFeedbackReportResponse
object
1 property
1 required
CallRecording
object
CallRecording represents a recording of a call.
6 properties
6 required
StartRTMPBroadcastsResponse
objectnull
StartRTMPBroadcastsResponse is the payload for starting an RTMP broadcast.
1 property
1 required
ParticipantCountByMinuteResponse
objectnull
5 properties
5 required
StopTranscriptionResponse
objectnull
Basic response information
1 property
1 required
CreateSIPTrunkResponse
objectnull
Response containing the created SIP trunk
2 properties
1 required
ScreensharingSettingsResponse
object
3 properties
2 required
CallStateResponseFields
object
CallStateResponseFields is the payload for call state response
3 properties
4 required
SIPCallerConfigsRequest
object
Configuration for SIP caller settings
2 properties
1 required
ReadReceiptsResponse
object
1 property
MuteUsersRequest
objectnull
8 properties
IndividualRecordingSettingsResponse
object
2 properties
1 required
SIPCallerConfigsResponse
object
SIP caller configuration response
2 properties
2 required
DeviceResponse_2
objectnull
Response for Device
8 properties
4 required
QueryCallSessionStatsRequest
objectnull
5 properties
SIPChallengeRequest
object
SIP digest challenge authentication data
16 properties
VideoSettingsResponse
object
5 properties
5 required
ActiveCallsSummary
object
4 properties
4 required
LimitsSettingsRequest
object
4 properties
CreateCallTypeRequest
objectnull
Request for creating a call type
5 properties
1 required
StartRecordingRequest
objectnull
1 property
DailyAggregateCallParticipantCountReportResponse
object
2 properties
2 required
UpdateCallMembersResponse
objectnull
Basic response information
2 properties
2 required
ResolveSipAuthRequest
objectnull
Request to determine SIP trunk authentication requirements
4 properties
2 required
UpdateSIPTrunkResponse
objectnull
Response containing the updated SIP trunk
2 properties
1 required
QueryCallParticipantSessionsResponse
objectnull
Basic response information
10 properties
7 required
GetCallTypeResponse_2
objectnull
8 properties
7 required
SIPPinProtectionConfigsRequest
object
Configuration for PIN protection settings
4 properties
GetCallReportResponse
objectnull
Basic response information
6 properties
3 required
UserResponse_2
object
User response object
23 properties
12 required
UnblockUserRequest
objectnull
UnblockUserRequest is the payload for unblocking a user.
1 property
1 required
Response
objectnull
Basic response information
1 property
1 required
CallStatsMapLocation
object
3 properties
2 required
TypingIndicatorsResponse
object
1 property
UnblockUserResponse
objectnull
UnblockUserResponse is the payload for unblocking a user.
1 property
1 required
CompositeRecordingResponse
object
1 property
1 required
CallStatsMapSubscribers
object
2 properties
1 required
KickUserRequest
objectnull
KickUserRequest is the payload for kicking a user from a call. Optionally block the user as well.
4 properties
1 required
SessionClient
object
5 properties
StartFrameRecordingRequest
objectnull
1 property
PinRequest
objectnull
PinRequest is the payload for pinning a message.
2 properties
2 required
IngressVideoLayerResponse
objectnull
5 properties
5 required
GetActiveCallsStatusResponse_2
objectnull
Response containing active calls status information
5 properties
3 required
StopTranscriptionRequest
objectnull
1 property
VideoReactionsResponse
objectnull
2 properties
1 required
SendClosedCaptionRequest_2
objectnull
9 properties
2 required
KickUserResponse
objectnull
KickUserResponse is the payload for kicking a user from a call.
1 property
1 required
NetworkMetricsReportResponse
object
4 properties
PublishedTrackFlags
object
4 properties
4 required
StopClosedCaptionsResponse
objectnull
Basic response information
1 property
1 required
StartClosedCaptionsResponse
objectnull
1 property
1 required
ParticipantSessionDetails
object
7 properties
4 required
AudioSettingsResponse
object
8 properties
7 required
RecordSettingsRequest
object
4 properties
1 required
LayoutSettingsRequest
object
5 properties
1 required
QueryCallMembersResponse
objectnull
Basic response information
4 properties
2 required
GetEdgesResponse
objectnull
Basic response information
2 properties
2 required
BrowserDataResponse
object
2 properties
EgressHLSResponse
object
2 properties
2 required
CallParticipantTimeline
object
4 properties
4 required
SubscriberAudioMetrics
object
3 properties
CallParticipantCountReport
object
1 property
1 required
DeleteSIPTrunkResponse
objectnull
Response confirming SIP trunk deletion
1 property
1 required
ListSIPTrunksResponse
objectnull
Response containing the list of SIP trunks
2 properties
2 required
IngressSourceResponse
object
3 properties
3 required
NotificationSettingsRequest
object
6 properties
SIPInboundRoutingRulePinConfigsResponse
object
PIN routing rule call configuration response
5 properties
DeleteRecordingResponse
objectnull
Response for DeleteRecording
1 property
1 required
EventNotificationSettingsRequest
object
3 properties
UnpinResponse
objectnull
UnpinResponse is the payload for unpinning a message.
1 property
1 required
UnpinRequest
objectnull
UnpinRequest is the payload for unpinning a message.
2 properties
2 required
UpdateCallMembersRequest
objectnull
Update call members
2 properties
GeofenceSettingsResponse
object
1 property
1 required
UserRatingReportResponse
object
2 properties
2 required
EndCallResponse
objectnull
Response for ending a call
1 property
1 required
SIPInboundRoutingRulePinConfigsRequest
object
Configuration for PIN routing rule calls
5 properties
SDKUsageReportResponse
object
1 property
1 required
UpdateCallResponse
objectnull
Response for updating a call
4 properties
5 required
WHIPIngress
object
1 property
1 required
SIPDirectRoutingRuleCallConfigsResponse
object
Direct routing rule call configuration response
2 properties
2 required
ActiveCallsFPSStats
object
4 properties
4 required
RawRecordingSettingsRequest
object
2 properties
1 required
CallStatsParticipantCounts
object
13 properties
7 required
SIPInboundRoutingRuleResponse
objectnull
SIP Inbound Routing Rule response
13 properties
7 required
GetOrCreateCallResponse
objectnull
5 properties
6 required
PublisherAllMetrics
object
3 properties
SipInboundCredentials
object
Credentials for SIP inbound call authentication
7 properties
7 required
UpdateSIPInboundRoutingRuleResponse
objectnull
Response containing the updated SIP Inbound Routing Rule
2 properties
1 required
CallDurationReportResponse
object
1 property
1 required
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:video
Where this information came from
This is an independent, third-party profile of Stream product:video 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.