GET
/
streaming
/
streams
/
{stream_id}
/
overlays
/
{overlay_id}
Python
from gcore import Gcore

client = Gcore(
    api_key="My API Key",
)
overlay = client.streaming.streams.overlays.get(
    overlay_id=0,
    stream_id=0,
)
print(overlay.id)
{
  "id": 1,
  "stream_id": 12345,
  "url": "http://domain.com/myoverlay1.html",
  "width": 120,
  "height": 40,
  "x": 30,
  "y": 30,
  "stretch": false,
  "created_at": "2023-09-20T00:01:01.000Z",
  "updated_at": "2023-10-01T12:01:01.000Z"
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

​
stream_id
integer
required

Stream ID

​
overlay_id
integer
required

Overlay ID

Response

200
application/json

Successful

The response is of type object.