Skip to main content
POST
/
instructor
/
executeSync
Create instructor session (synchronous)
curl --request POST \
  --url https://api.kaizenautomation.com/instructor/executeSync \
  --header 'Content-Type: application/json' \
  --data '{
  "workflowId": "<string>",
  "loginId": "<string>",
  "useProxy": false
}'
{
  "id": "<string>",
  "sessionId": "<string>",
  "workflow": {
    "id": "<string>",
    "name": "<string>"
  },
  "logins": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "authentications": [
    {
      "browserSessionId": "<string>",
      "status": "<string>",
      "liveViewUrl": "<string>"
    }
  ],
  "contextAuthentications": [
    {
      "contextAuthenticationId": "<string>",
      "loginSummary": {
        "loginId": "<string>",
        "name": "<string>",
        "isManual": true
      },
      "authenticationStatus": "Unauthenticated"
    }
  ],
  "startTime": "2023-11-07T05:31:56Z",
  "endTime": "2023-11-07T05:31:56Z",
  "durationMs": 123,
  "isRecording": true,
  "browserSessionId": "<string>",
  "status": "<string>",
  "liveViewUrl": "<string>"
}

Body

application/json
​
workflowId
string
required
​
loginId
string
​
useProxy
boolean

Whether to use proxy for this instructor execution (defaults to workflow setting)

Example:

false

Response

Instructor session created and is in progress or completed

  • Option 1
  • Option 2
​
id
string
required

Unique identifier for the instructor execution

​
sessionId
string
required

Session ID for the instructor execution (same as external ID)

​
workflow
object
required
​
logins
object[]
required
​
authentications
(In Progress Authentication · object | Enqueued Authentication · object | Finished Authentication · object | Failed Authentication · object)[]
required
  • In Progress Authentication
  • Enqueued Authentication
  • Finished Authentication
  • Failed Authentication
​
contextAuthentications
object[]
required

Session authentication responses with login summary for this instructor execution

​
startTime
string<date-time>
required

When the instructor execution started

​
endTime
string<date-time> | null
required

When the instructor execution ended (null if still running)

​
durationMs
number | null
required

Duration of the instructor execution in milliseconds (null if still running)

​
isRecording
boolean
required

Whether the instructor execution is currently recording

​
browserSessionId
string | null
required

ID of the browser session associated with this instructor execution

​
status
string
required
Allowed value: "InProgress"
​
liveViewUrl
string
required
⌘I