Streem API basics

Get API Key ID/Secret

First thing you'll need is your API Key ID and API Key Secret. Today, you'll need to receive those directly from Streem, but we are working on bringing that into the web portal very soon.

All API requests are authenticated using your API Key. Provide the ID and Secret using Basic Authentication, as the username and password.


When an Agent invites a Customer to Streem, they get connected in a Room. Rooms are where all the things associated with a call are stored, including Recordings, Streemshots, GPS location (if approved), and more. You can use the API to retrieve information about each Room, and what Artifacts were created.


Reference ID

An Agent has the option of specifying a Reference ID while inviting a Customer to Streem. This is a free-form text field, but is usually used to specify an identifier that keys to something in your system, such as a Ticket or Call ID (if using Call Center software, for example). If your Agents are using the Reference ID field, then you will likely be interested in querying for Rooms using that Identifier, via GET /v1/rooms?reference_id=abc123