Skip to main content
POST
Create session

Authorizations

Authorization
string
header
required

Polymorfa organization key (pmfa_ prefix), project token (pmfa_pt_ prefix) where supported, or short-lived client token (pmfa_ct_ prefix). Organization and project keys may be personal or service-account owned and enforce selected action scopes. Organization keys cover the team and its projects; project tokens stay inside one project. Client tokens stay inside their live project and session and enforce their client rules.

Path Parameters

projectId
string
required

Identifier of the Polymorfa project that owns this resource.

Value constraints

Minimum string length: 1

Body

application/json
name
string

Optional display label. The server generates the session identifier.

Value constraints

Minimum string length: 1
startOnConnect
boolean
default:false

Start connecting immediately after creation. Pairing or credentials are still required.

type
enum<string>
default:linked_device

Connection type. Immutable after creation.

Allowed values

Available options:
linked_device,
cloud_api
testMode
boolean
default:false

Create a simulated testing session.

cloudApi
object

Specifies cloud api for this native create session request.

config
object

Specifies config for this native create session request.

Response

Session created; a testing session is connected and command-ready before this response

success
enum<boolean>
required

Whether the request succeeded.

Allowed values

Available options:
true
data
object
required

Structured data carried by this object.