How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Ant Media

Ant Media Broadcasts API

The Broadcasts API from Ant Media — 45 operation(s) for broadcasts.

Documentation Provider Profile APIs.io OpenAPI GitHub

Ant Media Broadcasts API is one of 8 APIs that Ant Media publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Broadcasts. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 50 operations across 45 paths, and defines 23 schemas. It is described by OpenAPI 3.2.0, at version V2.0.

Requests are made against a single base URL, https://test.antmedia.io:5443/Sandbox/rest/.

50 operations 45 paths 23 schemas 7 DELETE25 GET14 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
V2.0
Base URL
https://{ant-media-server}:5443/{application}/rest/v2/
Contact
Ant Media Info
License
Apache 2.0
Resource Areas
1

Paths & Operations 50

Across 45 paths, the API surfaces 50 operations — 7 DELETE, 25 GET, 14 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Broadcasts 50
POST
/v2/broadcasts/{id}/rtmp-endpoint
Adds a third party RTMP end point to the stream
addEndpointV3 2 params body → 200
DELETE
/v2/broadcasts/{id}/rtmp-endpoint
Remove third-party RTMP end point from the stream
removeEndpointV2 3 params → 200
POST
/v2/broadcasts/{stream_id}/id3
Add ID3 data to HLS stream at the moment
addID3Data 1 param body → default
POST
/v2/broadcasts/{stream_id}/sei
Add SEI data to HLS stream at the moment
addSEIData 1 param body → default
POST
/v2/broadcasts/{id}/subtrack
Add a subtrack to a main track (broadcast)
addSubTrack 2 params → 200
DELETE
/v2/broadcasts/{id}/subtrack
Delete a subtrack from a main track (broadcast)
removeSubTrack 2 params → 200
POST
/v2/broadcasts/{id}/subscribers
Add Subscriber to the requested stream
addSubscriber 1 param body → 200
DELETE
/v2/broadcasts/{id}/subscribers
Removes all subscribers related to the requested stream
revokeSubscribers 1 param → 200
PUT
/v2/broadcasts/{id}/subscribers/{sid}/block/{seconds}/{type}
Block specific subscriber
blockSubscriber 4 params → 200
POST
/v2/broadcasts/create
Creates a Broadcast, IP Camera or Stream Source and returns the full broadcast object with rtmp address and other information. The different between Broadcast and IP Camera or Stream Source is that B…
createBroadcast 1 param body → 400200
GET
/v2/broadcasts/{id}
Get broadcast object
getBroadcast 1 param → 200404
PUT
/v2/broadcasts/{id}
Updates the Broadcast objects fields if it's not null. The updated fields are as follows: name, description, userName, password, IP address, streamUrl of the broadcast. It also updates the social end…
updateBroadcast 1 param body → 200
DELETE
/v2/broadcasts/{id}
Delete broadcast from data store and stop if it's broadcasting
deleteBroadcast 1 param → 200
DELETE
/v2/broadcasts
Delete multiple broadcasts from data store and stop if they are broadcasting
deleteBroadcastsBulk 1 param → 200
DELETE
/v2/broadcasts/{id}/subscribers/{sid}
Delete specific subscriber from data store
deleteSubscriber 2 params → 200
PUT
/v2/broadcasts/{id}/recording/{recording-status}
Set stream specific recording setting
enableRecording 4 params → 200
GET
/v2/broadcasts/active-live-stream-count
Return the active live streams
getAppLiveStatistics → 200
GET
/v2/broadcasts/list/{offset}/{size}
Gets the broadcast list from database. It returns max 50 items at a time
getBroadcastList 6 params → default
GET
/v2/broadcasts/{id}/broadcast-statistics
Get the broadcast live statistics
getBroadcastStatistics 1 param → 200
GET
/v2/broadcasts/total-broadcast-statistics
Get total broadcast live statistics
getBroadcastTotalStatistics → 200
GET
/v2/broadcasts/{streamId}/ip-camera-error
Get IP Camera Error after connection failure
getCameraErrorV2 1 param → 200
GET
/v2/broadcasts/{id}/connection-events/{offset}/{size}
Retrieve all subscriber statistics of the requested stream. Deprecated
getConnectionEvents 4 params → 200
GET
/v2/broadcasts/{id}/detections/{offset}/{size}
Retrieve detected objects from the stream
getDetectionListV2 3 params → 200
GET
/v2/broadcasts/duration
Gets the durations of the stream url in milliseconds
getDuration 1 param → 200
GET
/v2/broadcasts/{id}/jwt-token
Generates JWT token for specified stream. It's not required to let the server generate JWT. Generally JWT tokens should be generated on the client side.
getJwtTokenV2 4 params → 200400
GET
/v2/broadcasts/{id}/detections/count
Get total number of detected objects
getObjectDetectedTotal 1 param → 200
GET
/v2/broadcasts/{id}/ip-camera/device-profiles
Get the Profile List for an ONVIF IP Camera
getOnvifDeviceProfiles 1 param → 200
GET
/v2/broadcasts/{id}/rtmp-to-webrtc-stats
Get RTMP to WebRTC Path Stats
getRTMPToWebRTCStats 1 param → 200
GET
/v2/broadcasts/{id}/stream-info
Get stream information
getStreamInfo 1 param → 200
GET
/v2/broadcasts/{id}/subscribers/{sid}/totp
Return TOTP for the subscriberId, streamId, type. This is a helper method. You can generate TOTP on your end.If subscriberId is not in the database, it generates TOTP from the secret in the AppSettin…
getTOTP 3 params → default
GET
/v2/broadcasts/{id}/token
Generates random one-time token for specified stream
getTokenV2 4 params → 200400
GET
/v2/broadcasts/count
Get the total number of broadcasts
getTotalBroadcastNumberV2 → 200
GET
/v2/broadcasts/count/{search}
Get the number of broadcasts based on search criteria
getTotalBroadcastNumberV2_1 1 param → 200
GET
/v2/broadcasts/{stream_id}/webrtc-client-stats/{offset}/{size}
Get WebRTC Client Statistics
getWebRTCClientStatsListV2 3 params → 200
GET
/v2/broadcasts/webrtc-receive-low-level-stats
Get WebRTC Low Level Receive Stats
getWebRTCLowLevelReceiveStats → 200
GET
/v2/broadcasts/webrtc-send-low-level-stats
Get WebRTC Low Level Send Stats
getWebRTCLowLevelSendStats → 200
POST
/v2/broadcasts/import-to-stalker
Import Live Streams to Stalker Portal
importLiveStreams2StalkerV2 → 200
GET
/v2/broadcasts/{id}/subscriber-stats/list/{offset}/{size}deprecated
Retrieve all subscriber statistics of the requested stream. Deprecated use connection-events method.
listSubscriberStatsV2 3 params → 200
GET
/v2/broadcasts/{id}/subscribers/list/{offset}/{size}
Get all subscribers of the requested stream
listSubscriberV2 3 params → 200
GET
/v2/broadcasts/{id}/tokens/list/{offset}/{size}
Get all tokens of requested stream
listTokensV2 3 params → 200
POST
/v2/broadcasts/{id}/ip-camera/move
Move IP Camera
moveIPCamera 5 params → 200
POST
/v2/broadcasts/playlists/{id}/next
Specify the next playlist item to play by index
playNextItem 2 params → 200
DELETE
/v2/broadcasts/{id}/tokens
Removes all tokens related with requested stream
revokeTokensV2 1 param → 200
GET
/v2/broadcasts/onvif-devices
Get Discovered ONVIF IP Cameras
searchOnvifDevicesV2 → 200
POST
/v2/broadcasts/{id}/data
Send message to stream participants via Data Channel
sendMessage 1 param body → 200
POST
/v2/broadcasts/{id}/start
Start streaming sources
startStreamSourceV2 1 param → 200
POST
/v2/broadcasts/{id}/ip-camera/stop-move
Stop move for IP Camera
stopMove 1 param → default
POST
/v2/broadcasts/{id}/stop
Stop streaming for the active stream
stopStreamingV2 1 param → 200
PUT
/v2/broadcasts/{id}/seek-time/{seekTimeMs}
Seeks the playing stream source, vod or playlist on the fly. It accepts seekTimeMs parameter in milliseconds
updateSeekTime 2 params → default
POST
/v2/broadcasts/validate-token
Perform validation of token for requested stream
validateTokenV2 body → 200

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are Broadcast (61 properties), BroadcastUpdate (60 properties), RTMPToWebRTCStats (17 properties), Subscriber (12 properties). Each schema is shown below with its type and property counts.

ObjectId
object
The id of the detected object
2 properties
ConnectionEvent
object
Connection Event for the subscriber
7 properties
TensorFlowObject
object
The TensorFlow detected object class
9 properties
HLSParameters
object
3 properties
PlayListItem
object
5 properties
WebRTCSendStats
object
Aggregation of WebRTC Low Level Send Stats
2 properties
Broadcast
object
The basic broadcast class
61 properties
RTMPToWebRTCStats
object
17 properties
BroadcastUpdate
object
This is the BroadcastUpdate and it's almost same with BroadcastUpdate with all default values are null. We update the fields in update method if it's not null.…
60 properties
WebRTCVideoReceiveStats
object
Video receive stats
11 properties
WebRTCAudioReceiveStats
object
Audio receive stats
7 properties
Token
object
The one-time token class
5 properties
EncoderSettings
object
4 properties
WebRTCAudioSendStats
object
Audio send stats
6 properties
SubscriberStats
object
Statistics for each subsciber to the stream
5 properties
Result
object
The basic result class
4 properties
WebRTCClientStats
object
WebRTC Client statistics.
11 properties
WebRTCReceiveStats
object
Aggregation of WebRTC Low Level Receive Stats
2 properties
SimpleStat
object
Simple generic statistics class to return single values
1 property
BroadcastStatistics
object
4 properties
Endpoint
object
The endpoint class, such as Facebook, Twitter or custom RTMP endpoints
4 properties
Subscriber
object
The time based token subscriber class. This keeps which subscriber can access to which stream and which TOTP
12 properties
WebRTCVideoSendStats
object
Video send stats
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ant-media-broadcasts-api-openapi.yml Raw ↑

Other APIs Ant Media publishes across the network.

Ant Media Server REST API
AE Profile APIs.io
Ant Media Filters API
AE Profile APIs.io
Ant Media Push Notification API
AE Profile APIs.io
Ant Media Version API
AE Profile APIs.io
Ant Media Vods API
AE Profile APIs.io
Ant Media Management API
AE Profile APIs.io
Ant Media Cluster API
AE Profile APIs.io
#Broadcasts
← Back to A APIs
API Details
ID
ant-media:ant-media-broadcasts-api
Base URL
https://{ant-media-server}:5443/{application}/rest/v2/
Docs
https://antmedia.io/rest/
Provider
Ant Media
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=ant-media-broadcasts-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/ant-media-broadcasts-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Ant Media Broadcasts 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.