Platform API SDKs

[tbarbugli]

Stream product offering started with Feeds and expanded into Chat. Until now we had one official SDK clients for each popular languages on both products. Starting with video, we decided to change our strategy and create unified Platform API SDKs that expose the API for all products.

This makes the integration simpler (one library, shared code, shared dependencies, ...)

Official Platform SDK Clients (updated November 2023)

Language	Status
Node.js	v0.1
Python	v0.1
Ruby	planned for v0.3
Go	planned for v0.3
PHP	planned for v0.3
Java	planned for v0.3
C#	planned for v0.3

Note
If you do not see your language in this list, you can still integrate to our REST API using the openapi spec. Before doing that please make sure to reach out to us so we can provide help (and perhaps add your language to this list)

Roadmap 🚧

v0.1 - ETA is October 27, 2023

• Video endpoints from openapi spec (server-side)
• User management endpoint using the chat ones (handle compat layer for custom data in/out)
• Code examples for important stuff that you can't do from the Dashboard (https://github.com/GetStream/protocol/tree/main/docusaurus/video/docusaurus/docs/api)
  • Creating / updating users
  • Creating tokens
  • CRUD for calls
  • Query calls
  • Call endpoints
  • Complete livestreaming and recordind docs main...livestream
  • Show how to get RTMP up and running
  • Webhooks (just ensure the list is up-to-date)
• Library minimal setup
  • LICENSE
  • README with basic setup instructions and links
  • Github repo is public
  • Library is available on main package manager(s)
  • Minimal test setup to ensure the library works, example are correct
• Clear namespacing to separate different products and common endpoints
• Python SDK
• Node.js SDK
• Docs quickstart
  • Intro to call: install client, api credentials, create a user with custom data, create the token, create the call, add members
  • Livestream: basic setup + recording start/stop, HLS start/stop, backstage example

import streampy

# main entry-point
api = streampy.Stream(...)

api.video.create_call_type(...)

# call methods are exposed under the Call 
call = api.video.call(...)
call.create()

channel_type = api.chat.create_channel_type(...)

# channel methods are under the channel object
channel = api.chat.channel(...)
channel.send_message(...)

# common endpoints are all at the top-level
api.upsert_users(...)
api.get_app(...)
api.send_custom_user_event(...)

• User management endpoints come from chat and use the v1 custom format

user_reserved_fields = ['id', 'created_at']

def compat_user_decode(user_from_response):
  custom_data = {k: v for k, v in user_from_response if k not in reserved_fields}
  user = {
    # TODO
  }
  return user


def compat_user_encode(user_request):
  # TODO: moves user.custom to the top-level of the dict
  return user

class VideoClient(VideoClientGenerated):
  """
  self.create_user({id: "sacha", custom: {"language": "french"}})
  """

  def create_user(self, user):
    # TODO: remove when we have code-gen and api versions
    super().create_user(compat_user_encode(user))

class VideoClientGenerated():

  def create_user(self, user):
    # code generated passing stuff to client...

v0.2

• CI/CD for tests, run test matrix against different runtimes and language versions (Python 3.10, 3.11, Pypi, Node.js versions, Bun). Badge in the README
• API & docs for app management (call types, channel types, push, app configs, ...)
• Support for webhook/sqs events based on openapi spec
• Use openapi spec to generate parts of the documentation (eg. webhooks <OpenapiModel spec="" {modelName}>)
• All endpoints are code generated from openapi spec
• Code generation tooling support for multiple languages
• gzip compressed request / responses

v0.3

• Expose chat endpoints and document them all
• Use API v3 for all endpoints
• Expose all app config methods
• Ruby SDK
• Golang SDK
• PHP SDK
• Java SDK
• C# SDK

v1.0

• Full replacement of video, chat and feeds clients

[tbarbugli]

Node.js and Python SDK are now available and released (v0.1)

[steve-sun-me]

Hey team, thanks for the awesome library. We are trying to integrate with C# which is not available yet. Reaching out due to Before doing that please make sure to reach out to us so we can provide help (and perhaps add your language to this list) in the announcements to see if we can get docs for the OpenAPI spec 🙏

[guerinoni]

https://github.com/GetStream/protocol/tree/main/openapi

[TinhHuynh]

If you do not see your language in this list, you can still integrate to our REST API using the openapi spec.

@tbarbugli Hi, may I know where the openapi spec is located exactly?
I can't find it in the Stream repositories or the Internet.

I appreciate any help you can provide.

[guerinoni]

https://github.com/GetStream/protocol/tree/main/openapi

[TinhHuynh]

Thanks for the response. I will check it out!