How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Sauce Labs Sessions API

The Sessions API from Sauce Labs — 5 operation(s) for sessions.

Sauce Labs Sessions API is one of 9 APIs that Sauce Labs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Sessions. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 5 paths, and defines 7 schemas. It is described by OpenAPI 3.0.3, at version 1.1.

Requests are made against 2 base URLs: https://api.us-west-1.saucelabs.com, https://api.eu-central-1.saucelabs.com.

7 operations 5 paths 7 schemas 2 DELETE2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.1
Base URL
https://api.us-west-1.saucelabs.com
Authentication
HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 1

Sauce Labs Sessions API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — Use your Sauce Labs username and access key as the HTTP Basic Authentication credentials.

Paths & Operations 7

Across 5 paths, the API surfaces 7 operations — 2 DELETE, 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Sessions 7
GET
/sessions
List Active Sessions
listSessions → 200401
POST
/sessions
Create a Device Session
createSession body → 200400401
GET
/sessions/{sessionId}
Get Session Details
getSession 1 param → 200401404
DELETE
/sessions/{sessionId}
Close a Session
closeSession 1 param → 200401404
POST
/sessions/{sessionId}/device/executeShellCommand
Execute Shell Command on Device
executeShellCommand 1 param body → 200401
POST
/sessions/{sessionId}/device/installApp
Install App on Device
installApp 1 param body → 200400401
DELETE
/sessions/{sessionId}/device/uninstallApp
Uninstall App from Device
uninstallApp 1 param body → 200400401

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are DeviceDescriptor (10 properties), Session (7 properties), Device (4 properties), SessionCreation (4 properties). Each schema is shown below with its type and property counts.

DeviceDescriptor
object
Hardware characteristics that identify a device model.
10 properties
Session
object
A real device session on Sauce Labs.
7 properties
AppiumSession
object
Appium-specific session metadata.
2 properties
SessionCreation
object
Request body for creating a new real device session.
4 properties 1 required
Device
object
A real physical device available in the Sauce Labs cloud.
4 properties
PaginationMeta
object
3 properties
ErrorBody
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sauce-labs-sessions-api-openapi.yml Raw ↑

Other APIs Sauce Labs publishes across the network.

Sauce Labs Platform API
Sauce Labs Sauce Connect API
Sauce Labs Storage API
Sauce Labs Devices API
Sauce Labs Job Assets API
Sauce Labs Jobs API
Sauce Labs Platform API
Sauce Labs Users API
Where this information came from

This is an independent, third-party profile of Sauce Labs Sessions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.