gRPCSessionService.CreateSession

SessionService.CreateSession

Launch a new stealth browser session.

Proxy configuration for the session.

RESIDENTIAL, DATACENTER, or MOBILE.

ISO 3166-1 alpha-2 country code.

Use sticky IP for session duration.

Existing profile ID to load.

Session time-to-live.

Enable stealth mode.

Proto Definition

service SessionService {
  rpc CreateSession(CreateSessionRequest) returns (Session);
}

message CreateSessionRequest {
  ProxyConfig proxy = 1;
  string profile_id = 2;
  int32 ttl_seconds = 3;
  bool stealth = 4;
}

message Session {
  string id = 1;
  SessionStatus status = 2;
  string ws_endpoint = 3;
  ProxyConfig proxy = 4;
  google.protobuf.Timestamp created_at = 5;
  google.protobuf.Timestamp expires_at = 6;
}

Request

{
  "proxy": { "type": "RESIDENTIAL", "country": "US", "sticky": true },
  "ttl_seconds": 3600,
  "stealth": true
}

Response

{
  "id": "ses_k8m2n4p6",
  "status": "ACTIVE",
  "ws_endpoint": "wss://session-k8m2n4p6.sessionkit.dev",
  "proxy": { "type": "RESIDENTIAL", "country": "US", "sticky": true },
  "created_at": "2026-06-23T15:00:00Z",
  "expires_at": "2026-06-23T16:00:00Z"
}