Create Session

POST
Creates a new session and returns session details including a unique session ID.

Request

This endpoint expects an object.
url
stringRequired
The URL to create or continue session from.
local
booleanOptional
Boolean flag to indicate if session to be run locally or in the cloud (Default: False)
browser_params
objectOptional
Object containing height and width for the browser screen size.
include_screenshot
booleanOptional

Response

This endpoint returns an object
status
string
The current status of the session.
message
string
A message providing more details about the session status.
session_id
string
The unique identifier for the session.
url
string
The URL associated with the session.
screenshot
string
image url of the screenshot taken during the session.

Errors

POST
1curl -X POST https://api.multion.ai/v1/web/session \
2 -H "X_MULTION_API_KEY: <apiKey>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "url": "url"
6}'
1{
2 "status": "status",
3 "message": "message",
4 "session_id": "session_id",
5 "url": "url",
6 "screenshot": "screenshot"
7}