Retrieve a magic url to automatically sign-in to ScreenMeet console as the currently authenticated user.

Claim for **'role_agent'** value must be set to 'true'.



The URL must be used to sign-in within 60 seconds or the console login token will expire.

default

MalformedJWTOrBadSignature

Authorization token is invalid: JsonWebTokenError request id: 1-62ed1a55-0265e424598b4f1b580bd784 [8/5/2022, 6:25:41 AM PST]

PermissionDenied

Authorization token is invalid: Error request id: 1-62ed207a-24baa293558168e06b8402c3 [8/5/2022, 6:51:54 AM PST]

Desired target page to land on after magic console sign-on, e.g: sessionhistory/details/ldpNkWLdPWaW

target_path

OK

Response body will contain a plain text URL that can be used to login to the ScreenMeet console.

Authorization Problem - either the JWT is malformed or the signature is bad, or permission is denied

bearerAuth

Retrieve console sign-on magic URL

Generate a short-lived session token for launching a ScreenMeet session
in a browser without exposing the plaintext SupportSession ID.

Tokens are valid for 60 seconds by default, but can be set to a maximum
of 10 minutes.

See [How to launch a Screenmeet session](docs/How-to-launch-a-Screenmeet-session.md)
for more information.

Generate temporary session token

Retrieve the AI summary configuration currently set for the given
organization.

The AI summary feature automatically generates a summary of a Remote
Support Session when it ends. Whether (and how) a summary is generated is
controlled by the `summary_workflow` field (see the POST operation).

Most fields returned here are managed for you through the ScreenMeet
console's **AI Studio** and should not be edited directly via the API.
Only `summary_workflow` is intended to be toggled through this endpoint.

> **Entitlement required:** The AI summary feature only works when the
> AI+ (`aiplus`) entitlement is enabled for the organization's customer.

Get AI summary configuration for an organization

Set the AI summary configuration for the given organization.

Setting `summary_workflow` to any value other than `dont-generate`
enables AI summarization at the end of a session; the generated summary
is handled according to the selected workflow. Setting it to
`dont-generate` (the default) disables the feature.

Allowed `summary_workflow` values:

* **review-generation** - Generate a summary for the agent to review.
* **automatic-crm-note** - Automatically post the summary as a note to the CRM. Only for ServiceNow and SFDC customers.
* **automatic-crm-resolution** - Automatically post the summary as a resolution to the CRM. Only for ServiceNow customers.
* **data-collection** - Collect data for summarization without surfacing a summary.
* **dont-generate** - Do not generate a summary (feature disabled). This is the default.

In addition to `summary_workflow`, the fields `include_screenmeet_chat`,
`enable_post_to_crm`, `enable_post_as_resolution`, `log_to_kibana`, and
`retain_raw_data` may optionally be set (see the request body below). All
fields are optional - any field omitted from the request is left
unchanged.

The summarizer definition (`activeSummarizer`) is managed through the
ScreenMeet console's **AI Studio** and should not be edited via the API.

> **Entitlement required:** The AI summary feature only works when the
> AI+ (`aiplus`) entitlement is enabled for the organization's customer.
> Attempting to enable a summary workflow without it returns a `400`
> validation error.

Set AI summary configuration for an organization

Reset the AI summary configuration for the given organization back to its
default value. This sets `summary_workflow` back to `dont-generate`,
which disables AI summarization at the end of a session.

> **Entitlement required:** The AI summary feature only works when the
> AI+ (`aiplus`) entitlement is enabled for the organization's customer.

Reset AI summary configuration for an organization

Finds a ScreenMeet session associated with a CRM "Parent Object" - Used

Get sessions by external lookup key

Poll session state

Required field: `ids`


Poll session state - Returns any sessions which are 'active' from the list of ids provided.

Get user information for currently authenticated user.

Get current user account information

Generate an OAuth token for use with the ScreenMeet API using
an ApiKey's client_id and client_secret.

- grant_type should be 'client_credentials'
- client_id and client_secret are required

See [How to authenticate using an API key](docs/How-to-authenticate-using-an-API-key.md)
for more information.

Generate OAuth token

Returns all support sessions for the organization. Use query parameters to paginate and sort.
Use `metaData.client.name` to filter by client type (e.g., `windows-external-unattended` for unattended Windows sessions).

See [How to filter unattended sessions](docs/How-to-filter-unattended-sessions.md) for a complete PowerShell example (Tanium, ServiceNow, etc.).

**Example: Filtering unattended sessions (PowerShell)** - Useful for Tanium and other customers integrating with unattended access:

```powershell
# 1. Headers (uses the $token variable from your login)
$headers = @{
    Authorization = "Bearer $token"
    Accept        = "application/json"
}

# 2. Fetch the last 100 sessions to ensure a good sample size
$url = "https://api-v3.screenmeet.com/v3/organization/9177/supportsessions?limit=100&orderby=createdAt&orderdir=DESC"
$response = Invoke-RestMethod -Uri $url -Method Get -Headers $headers

# 3. Filter for the specific 'windows-external-unattended' client name
$filteredSessions = $response.rows | Where-Object {
    $_.metaData.client.name -eq "windows-external-unattended"
}

# 4. Display the specific matches
if ($filteredSessions) {
    Write-Host "Found $($filteredSessions.Count) Windows Unattended sessions:" -ForegroundColor Green
    $filteredSessions | Select-Object id, status, @{Name="Version"; Expression={$_.metaData.client.version}}, createdAt | Format-Table
} else {
    Write-Host "No matching client names found in the last 100 sessions." -ForegroundColor Yellow
}
```


List all organization sessions

List unattended groups (Beam) for an organization.

List unattended groups

Get a single unattended group by ID. Response includes ws_url and beam_config.

Get unattended group details

List devices in unattended group

Reset master-org signing key.

organization_id is required.

Reset master-org signing key

Get information about a specific sub-organization. The request should be authorized using the master org signing key.

Get info about specific sub-org

Change 'name' field or 'isProduction' field about a specific sub-organization. The request should be authorized using the master org signing key.

Change info of a specific sub-org

Get the signing key for a specific sub-organization. The request should be authorized using the master org signing key.

Get org signing key

Reset the signing key for a specific sub-organization. The request should be authorized using the master org signing key.

Reset sub-org signing key

Retrieve list of partner sub-organizations. The request should be authorized using the master org signing key.

List my orgs (paginated)

Create a new sub-org under your master partner org. The request should be authorized using the master org signing key.

Create a new partner org

Get available products and options for authenticated user.

Get products and options

Reschedule a session for a different time.

Reschedule a session for a different time

Schedule a Live session for future start time.


Schedule session for future start time

Retrieve the AI-generated summary for a support session.

This endpoint uses a polling pattern. When the session is first ready to be
summarized, generation is triggered automatically and an `in-progress` response
is returned immediately. Continue polling until the status is `finished`, or a 
terminal state like `error` or `expired`.

The organization must have **AI Summary** enabled.

**Authorization:** Send `Authorization: Bearer {token}` using a bearer
token from the API key or a JWT.

An API key must be created with the **organization administrator**
(`role:group_admin`) or **supervisor** (`role:supervisor`) scope.

The JWT payload may include **`roles.group_admin`** or **`roles.supervisor`**; 
if it does not, the **`user_id`** claim must match the user identity of the agent 
who created the session.

See [How to Get a Session AI Summary](docs/How-to-Get-a-Session-Summary.md)
for a complete guide with polling examples.

Get AI summary for a support session

Close a session. 

session_id is required.

Close session

Returns a list of the sessions for current agent that are in open or active state. Scheduled sessions will not be included unless you include the 'scheduled' query parameter - ('scheduled=1').


Retrieve open sessions for agent

Create a session.

Option to include parent object.

"type" field in JSON body specifies the type of session to create.

Values can be:
- "live" for Live session
- "support" for Remote Support session
- "cobrowse" for CoBrowse session
- "replay" for Replay session


Create session

Getting Application from ServiceNow Store

Deploying a Pre-installed Client

Using your Azure Blob for ScreenMeet File Storage

Minimal Cobrowse Script

Frequently Asked Questions

Timeout Settings

July

Remote Control

IP Access Control Feature

Live Release Notes Q2 2024

Video Chat Integration

Cobrowse Settings

CoBrowse Release Notes Q2 23

Connecting to Mac devices

Connecting to a Device Using Beam

Windows Tools

Retrieve console sign-on magic URL

Authorization

Parameters

Responses