Skip to content

API documentation example #12

Open

Description

@TisRyno

Also as per discussed on discord.

Can we get an example or simple API endpoint added so contributions can begin without having to invent/create the structure and expected format.

Activity

  1. danirukun commented on Oct 28, 2024

    @danirukun

    I think also this page should link to the API docs: https://docs.streamelements.com/api

  2. self-assigned this
    on Oct 28, 2024
  3. TisRyno commented on Dec 13, 2024

    @TisRyno
    Author

    Any movement on this?

    The fact the old API Docs are so neglected and don't even outline all responses properly is a pain.

    Not sure how developers can be expected to build tooling around the products if the API documentation isn't kept consistent or even maintained.

  4. removed their assignment
    on Dec 13, 2024
  5. linked a pull request that will close this issueAdd a link to API docs portal #53on Dec 13, 2024
  6. danirukun commented on Dec 16, 2024

    @danirukun

    @TisRyno I added a link to https://dev.streamelements.com/ in the API section, since that is the new home of the API docs.

  7. TisRyno commented on Dec 16, 2024

    @TisRyno
    Author

    @danirukun I don't understand, the old documentation for API docs won't be migrated into this new documentation?

    That seems very short sighted considering the old documentation contains references to Widgets and WebSockets, both of which are potentially out of date due the documentation being moved.
    Also the old documentation is incredibly slow and sometimes doesn't even load properly, leaving a blank sidebar.

    What's the point in maintaining 2 documentation projects?

  8. c4ldas commented on Jun 10, 2025

    @c4ldas
    Collaborator

    @DaniruKun
    Also the old documentation is incredibly slow and sometimes doesn't even load properly, leaving a blank sidebar.

    Hey! Just wanted to share that I have made an improved version of the API docs with:

    • More endpoints (including some missing ones)
    • Fixed operations (moved broken ones to a wonky - not working section)
    • Better details like:
      • Meaningful descriptions for each operation
      • Auth types per endpoint
      • Required/optional params
      • Request/response examples
      • Expected status codes
      • Faster loading + better search

    I sent the updated OpenAPI YAML to SE devs a while back (some months ago), but since the official docs haven't changed, you can check my version here: https://github.com/c4ldas/streamelements-api (there's a link to the webpage in there)

  9. awingfield916-tech commented on Feb 26, 2026

    @awingfield916-tech

    I'm having an issue with linking it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions