For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
  • Core
    • Overview
    • Authorization
    • Base URL
    • Data formats
    • Paging
    • Error codes
    • Permissions
  • Calling
        • POSTCreate conference stream
        • POSTCreate room stream
        • DELDelete stream
        • GETGet stream
        • GETList conference streams
        • GETList room streams
        • PUTUpdate stream
  • Datasphere
  • Logs
  • Messaging
  • Phone Number Management
  • Platform
  • Resource Management
LogoLogoSignalWire Docs
Log inSign up
Support
CallingVideoStreams

Get stream

|View as Markdown|Open in Claude|
GET
https://{your_space_name}.signalwire.com/api/video/streams/:id
GET
/api/video/streams/:id
$curl https://{your_space_name}.signalwire.com/api/video/streams/id \
>     -u "<project_id>:<api_token>"
1{
2  "id": "c22d24f6-5a47-4597-9a23-c7d01e696b92",
3  "url": "rtmp://broadcaster",
4  "stream_type": "rtmp",
5  "width": 1920,
6  "height": 1080,
7  "fps": 20,
8  "created_at": "2022-01-01T10:00:00Z",
9  "updated_at": "2022-01-01T11:00:00Z"
10}

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Video.

Learn more about API scopes.

Was this page helpful?
Previous

List conference streams

Next
Built with

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

idstringRequiredformat: "uuid"
Unique ID of the stream.

Response

Stream response object.
idstringformat: "uuid"
Unique identifier for the stream.
urlstring or null

RTMP or RTMPS URL. This must be the address of a server accepting incoming RTMP/RTMPS streams.

stream_typestring or null
The type of stream.
widthinteger or null
The stream's width in pixels.
heightinteger or null
The stream's height in pixels.
fpsinteger or null
The stream's frames per second.
created_atdatetime
Timestamp when the stream was created.
updated_atdatetime
Timestamp when the stream was last updated.

Errors

401
Unauthorized Error
404
Not Found Error
500
Internal Server Error

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)