hyperbrowser/json-structure/hyperbrowser-session-structure.json at main · api-evangelist/hyperbrowser · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
{
  "title": "Hyperbrowser Session Structure",
  "description": "Compact structural overview of the Hyperbrowser Session resource and its lifecycle.",
  "resource": "Session",
  "lifecycle": [
    "create",
    "active",
    "stop",
    "ended"
  ],
  "fields": [
    {
      "name": "id",
      "type": "string",
      "description": "Server-issued session identifier."
    },
    {
      "name": "status",
      "type": "string",
      "enum": [
        "pending",
        "active",
        "ended",
        "error"
      ]
    },
    {
      "name": "wsEndpoint",
      "type": "string",
      "description": "WebSocket CDP endpoint."
    },
    {
      "name": "liveUrl",
      "type": "string",
      "description": "Optional live-view URL."
    },
    {
      "name": "sessionUrl",
      "type": "string",
      "description": "REST URL of this session."
    },
    {
      "name": "createdAt",
      "type": "string",
      "format": "date-time"
    },
    {
      "name": "updatedAt",
      "type": "string",
      "format": "date-time"
    },
    {
      "name": "endedAt",
      "type": "string",
      "format": "date-time"
    },
    {
      "name": "useStealth",
      "type": "boolean"
    },
    {
      "name": "useProxy",
      "type": "boolean"
    },
    {
      "name": "solveCaptchas",
      "type": "boolean"
    },
    {
      "name": "profile",
      "type": "object",
      "description": "Optional persistent profile reference."
    }
  ],
  "transitions": [
    {
      "from": "pending",
      "to": "active",
      "trigger": "session ready"
    },
    {
      "from": "active",
      "to": "ended",
      "trigger": "PUT /api/session/{id}/stop or TTL expiry"
    }
  ]
}