# Streem Documentation

> Documentation for Streem

## Service and Auth Guides: API Documentation
- [Streem API basics](https://developer.streem.com/docs/getting-started.md)
- [Image detections, ad hoc](https://developer.streem.com/docs/image-detections-ad-hoc.md)
- [Parent Companies: Creating Sub-Companies](https://developer.streem.com/docs/parent-companies-creating-sub-companies.md)
- [Generating Share URLs via REST API](https://developer.streem.com/docs/generating-share-urls-via-rest-api.md)

## Service and Auth Guides: iFrame Embed Workflows
- [Embedding Streem into a CRM](https://developer.streem.com/docs/embedding-streem-into-a-crm-1.md)
  - [Advanced Example: Embedding an iframe in Salesforce using Visualforce](https://developer.streem.com/docs/advanced-example-embedding-an-iframe-in-salesforce-using-visualforce-2.md)

## Service and Auth Guides: Authentication
- [User Management in Streem](https://developer.streem.com/docs/streem-sso-and-user-management-options.md)
- [Classic SSO: Requirements](https://developer.streem.com/docs/classic-sso-requirements-and-details.md)
- [Embedded SSO Requirements](https://developer.streem.com/docs/embedded-sso-requirements.md)
- [API User management](https://developer.streem.com/docs/api-user-management.md)

## Service and Auth Guides: Metrics and Data Collection
- [Finding PII for CCPA requests](https://developer.streem.com/docs/finding-pii-for-ccpa-or-gdpr-requests.md)
- [PII data removal process](https://developer.streem.com/docs/pii-data-removal-process.md)
- [PII data return - Additional Artifact types](https://developer.streem.com/docs/pii-data-return-additional-artifact-types.md)

## Service and Auth Guides: click to video
- [Introduction](https://developer.streem.com/docs/introduction.md)
- [Glossary](https://developer.streem.com/docs/glossary.md)
- [Key Concepts](https://developer.streem.com/docs/key-concepts.md)
- [Pre-requisites for Getting Started](https://developer.streem.com/docs/pre-requisites-for-getting-started.md)
- Workflows
  - [Workflow Overview](https://developer.streem.com/docs/support-link.md)
  - [Support Link](https://developer.streem.com/docs/support-link-copy.md)
  - [Off Hours Messaging](https://developer.streem.com/docs/off-hours-error.md)
  - [Intake Form](https://developer.streem.com/docs/intake-form.md)
  - [The Queue](https://developer.streem.com/docs/the-queue.md)
  - [Cancel Video Chat - From Queue](https://developer.streem.com/docs/cancel-video-chat-from-queue.md)
  - [Lost Queue Position](https://developer.streem.com/docs/lost-queue-position.md)
  - [Call Dropped](https://developer.streem.com/docs/call-dropped.md)
  - [Join Lobby](https://developer.streem.com/docs/join-lobby.md)
  - [Cancel Video Chat - From Lobby](https://developer.streem.com/docs/cancel-video-chat-from-lobby.md)
  - [Streem Lobby](https://developer.streem.com/docs/streem-lobby.md)
- [Expert Training](https://developer.streem.com/docs/expert-training.md)

## Service and Auth Guides: Webhooks
- [Managing](https://developer.streem.com/docs/managing.md)
- [Validating Webhook Requests](https://developer.streem.com/docs/validating-webhook-requests.md)
- [Webhook Event Types](https://developer.streem.com/docs/webhook-event-types.md)
- [Rest API: Docs](https://developer.streem.com/docs/rest-api-docs.md)

## API Reference: Streem API
- companies
  - [List Companies](https://developer.streem.com/reference/listcompanies.md): List companies or sub companies. Can filter based on parent company sid, active status, name, and/or company code.
  - [Create Company](https://developer.streem.com/reference/createcompany.md): Create a new Company.  Provide `parent_company_sid` to create a Sub-Company.  The number of Sub-Companies allowed is limited to 10 initially, but you can request to have this limit increased.…
  - [List API Keys](https://developer.streem.com/reference/listcompanyapikeys.md): List API keys for the specified Company
  - [Create API Key](https://developer.streem.com/reference/createcompanyapikey.md): Create a new API Key for the specified Company
  - [Create a configuration for Room Outcomes](https://developer.streem.com/reference/createcompanyroomoutcomeconfig.md): Create the configuration for post call outcomes dialog
  - [Create user PII request](https://developer.streem.com/reference/createpiirequest.md): Requests all Personally Identifiable Information (PII) associated with a user
  - [List Note Templates](https://developer.streem.com/reference/getnotetemplates.md)
  - [Get Company](https://developer.streem.com/reference/getcompany.md): Get info for a specific Company
  - [Create Note Template](https://developer.streem.com/reference/createnotetemplate.md)
  - [Update Company](https://developer.streem.com/reference/updatecompany.md): Update certain properties of the specified Company
  - [Get Company Room Outcome Configuration](https://developer.streem.com/reference/getcompanyroomoutcomeconfig.md): Get Company Room Outcome Configuration for a specific Company
  - [Delete Company Room Outcome Configuration](https://developer.streem.com/reference/deletecompanyroomoutcomeconfig.md): Delete Company Room Outcome Configuration for a specific Company
  - [Get API Key](https://developer.streem.com/reference/getcompanyapikey.md): Get an API Key by `api_key_id` for the specified Company
  - [Revoke API Key](https://developer.streem.com/reference/revokecompanyapikey.md): Revokes an API Key, which sets the `expires_at` date to now
  - [Get Call Log](https://developer.streem.com/reference/getcompanycalllog.md): Get the Call Log for the specified Company, which are all calls made by Users of the Company
  - [Delete Note Template](https://developer.streem.com/reference/deletenotetemplate.md)
  - [Get Current Company](https://developer.streem.com/reference/getcurrentcompany.md): Returns the company associated with this account
  - [Update Note Template](https://developer.streem.com/reference/updatenotetemplates.md)
- users
  - [Create a user](https://developer.streem.com/reference/createcompanyuser.md): Create a user for log-in for this Company
  - [Get User By External User Id](https://developer.streem.com/reference/getuserbyexternaluserid.md): Get User by `external_user_id`, which should be unique in the scope of the specified Company
  - [Activate User](https://developer.streem.com/reference/activate.md): Activate a user
  - [Deactivate User](https://developer.streem.com/reference/deactivate.md): Deactivate a user
  - [Get User](https://developer.streem.com/reference/getuser.md): Get user by user sid
  - [Update user](https://developer.streem.com/reference/updateuser.md): Update the user
  - [Update User Availability](https://developer.streem.com/reference/updateuseravailability.md): Updates the availability status of a user (Only supported if User Availability is enabled)
- groups
  - [Add user to group for company](https://developer.streem.com/reference/addgroupuser.md): Add a user to a group for a specific company.
  - [Remove user from group for company](https://developer.streem.com/reference/deletegroupuser.md): Remove a user from a group for a specific company.
  - [Cancel group reservation](https://developer.streem.com/reference/cancelgroupreservation.md): Cancel a group reservation for a specific company and group
  - [Confirm group reservation](https://developer.streem.com/reference/confirmmatchedgroupreservation.md): Confirm a group reservation for a specific company and group
  - [/v1/companies/{company_code_or_sid}/groups/{group_name}/reservations/~cancel-all](https://developer.streem.com/reference/cancelqueuedgroupreservations.md)
  - [List groups for company](https://developer.streem.com/reference/listgroups.md): List the groups associated with the company
  - [Create group for company](https://developer.streem.com/reference/creategroup.md): Create a group for a specific company
  - [Create group reservation for company](https://developer.streem.com/reference/creategroupreservation.md): Create a group reservation for a specific company and group
  - [Get group for company](https://developer.streem.com/reference/getgroup.md): Get a group for a company by its name
  - [Get group for company](https://developer.streem.com/reference/getgrouphoursofoperation.md): Get Hours of operation for a group
  - [Delete group from company](https://developer.streem.com/reference/deletegroup.md): Delete a group from a company
  - [Create hours of operation for group](https://developer.streem.com/reference/creategrouphours.md): Create hours of operation for a specific group in a company
  - [Get Group Reservation](https://developer.streem.com/reference/getgroupreservation.md): Get a specified group reservation
  - [Delete all hours of operation for group](https://developer.streem.com/reference/deletegrouphoursofoperation.md): Delete hours of operation for a specific group in a company
  - [Get group reservation wait time](https://developer.streem.com/reference/getgroupreservationwaittime.md): Get group reservation wait time for a specific group
  - [Update hours of operation for group](https://developer.streem.com/reference/updategrouphoursofoperation.md): Update hours of operation for a specific group in a company
  - [List Group Availability](https://developer.streem.com/reference/listgroupavailability.md): List the users in the group that have a certain availability status
  - [List users in group](https://developer.streem.com/reference/listgroupusers.md): List the users that belong to a group.
  - [List user's groups](https://developer.streem.com/reference/listusergroups.md): List the groups that a user belongs to.
  - [/v1/companies/{company_code_or_sid}/groups/reservation-metrics](https://developer.streem.com/reference/savegroupreservationwaitmetric.md)
  - [Requeue group reservation](https://developer.streem.com/reference/transfergroupreservationtorequeue.md): Requeue a group reservation for a specific company and group
  - [Create a group image url](https://developer.streem.com/reference/updategroupimageurl.md): Create image url for a group id
- images
  - [Process Image](https://developer.streem.com/reference/runimagedetector.md): Run OCR on provided image and return results without persisting them to the database
- rooms
  - [List Rooms](https://developer.streem.com/reference/listrooms.md): List Rooms by various filters.  You must provide the `company_sid` param at a minimum.
  - [Upload external audio](https://developer.streem.com/reference/acceptexternalaudio.md): Upload external audio to overwrite Streem-recorded audio in recordings
  - [Delete external audio](https://developer.streem.com/reference/deleteexternalaudio.md): Delete external audio recording and revert original Streem-recorded audio
  - [List RoomOutcomeReports](https://developer.streem.com/reference/listroomoutcomereports.md): List all RoomOutcomeReports for this Room
  - [List Recordings](https://developer.streem.com/reference/listrecordings.md): List all Recording artifacts for this Room
  - [List Share Tokens](https://developer.streem.com/reference/listroomsharetokens.md): List Share Tokens for this Room, which give readonly access to the Assets of the Room
  - [Create Share Token](https://developer.streem.com/reference/createroomsharetoken.md): Create a new Share Token, which can be provided as `Authorization: ShareToken [token]` to gain readonly access to the Room
  - [Get Bookmark](https://developer.streem.com/reference/getbookmark.md): Get info about the specified video recording bookmark
  - [Delete Bookmark](https://developer.streem.com/reference/deletebookmark.md): Delete a video recording bookmark
  - [Get GPS](https://developer.streem.com/reference/getgpsposition.md): Get info about the specified GPS position
  - [Delete GPS](https://developer.streem.com/reference/deletegpsposition.md): Delete the specified GPS position
  - [Delete Recording](https://developer.streem.com/reference/deleterecording.md): Delete a Recording artifact, which will eventually permanently remove it from storage
  - [Get Room](https://developer.streem.com/reference/getroom.md): Get information about the specified Room
  - [Delete Room](https://developer.streem.com/reference/deleteroom.md): Delete the Room, which deletes all Assets from storage, and hides from Call Logs
  - [Get Room Note](https://developer.streem.com/reference/getroomnote.md): Gets the text Note for the specified Room
  - [Update Room Note](https://developer.streem.com/reference/updateroomnote.md): Updates the text Note for the specified Room
  - [Delete Room Note](https://developer.streem.com/reference/deleteroomnote.md): Delete the Note from the specified Room
  - [Get Streemshot](https://developer.streem.com/reference/getstreemshot.md): Get info about the specified Streemshot
  - [Delete Streemshot](https://developer.streem.com/reference/deletestreemshot.md): Delete a Streemshot, which will eventually permanently remove it from storage
  - [Get Streemshot Note](https://developer.streem.com/reference/getstreemshotnote.md): Get the text Note on an existing Streemshot
  - [Update Streemshot Note](https://developer.streem.com/reference/updatestreemshotnote.md): Update the text Note on an existing Streemshot
  - [Delete Streemshot Note](https://developer.streem.com/reference/deletestreemshotnote.md): Delete the text Note from a Streemshot
  - [Get Call Log Entry](https://developer.streem.com/reference/getroomcalllogentry.md): Get the Call Log Entry for this Room and User
  - [Finalize Room Note](https://developer.streem.com/reference/finalizeroomnote.md): Finalize the note for the specified Room
  - [Get Share Token](https://developer.streem.com/reference/getroomsharetoken.md): Get a Share Token by `token_sid`
  - [Revoke Share Token](https://developer.streem.com/reference/revokeroomsharetoken.md): Revoke a Share Token, which sets its `expires_at` value to now
  - [List GPS](https://developer.streem.com/reference/listgpspositions.md): List all GPS positions for the Room
  - [List Artifacts](https://developer.streem.com/reference/listroomartifacts.md): List all Artifacts for this Room, such as Recordings, Streemshots, etc.
  - [List Participants](https://developer.streem.com/reference/listroomparticipants.md): Get the list of Participants for a Room
  - [List Streemshots](https://developer.streem.com/reference/liststreemshots.md): List all Streemshot Artifacts for this Room
  - [List Transcription](https://developer.streem.com/reference/listtranscription.md): List Transcription for this room
- webhooks
  - [List Webhooks](https://developer.streem.com/reference/listwebhooks.md): Get a list of all webhooks
  - [Create Webhook](https://developer.streem.com/reference/createwebhook.md): Create a new webhook, which will be notified of events that occur in the system
  - [Get Webhook](https://developer.streem.com/reference/getwebhook.md): Retrieve a webhook by id
  - [Delete Webhook](https://developer.streem.com/reference/deletewebhook.md): Delete this webhook
  - [Update Webhook](https://developer.streem.com/reference/updatewebhook.md): Update the details of a webhook
  - [List Signing Keys](https://developer.streem.com/reference/listsigningkeys.md): Get a list of all signing keys for this webhook
  - [Create Signing Key](https://developer.streem.com/reference/createsigningkey.md): Create a new webhook signing key, which will be used to generate webhook signature headers
  - [Get Signing Key](https://developer.streem.com/reference/getsigningkey.md): Retrieve a signing key by id, for this webhook
  - [Delete Signing Key](https://developer.streem.com/reference/deletesigningkey.md): Delete this signing key for the given webhook
  - [Update Signing Key](https://developer.streem.com/reference/updatesigningkey.md): Update the details of a webhook signing key
  - [Test Webhook](https://developer.streem.com/reference/testwebhook.md): Send a test event to this webhook