Step Session

POST
Allows for browsing the web using detailed natural language instructions in a step mode for a session with a given session ID

Path parameters

session_idstringRequired

Request

This endpoint expects an object.
cmd
stringRequired
A specific natural language instruction for the next step.
url
stringOptional
The URL to create or continue session from.
stream
booleanOptional
Boolean flag to stream results back to the client (Default: False)
browser_params
objectOptional
Object containing height and width for the browser screen size.
optional_params
objectOptional
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.
metadata
objectOptional
Additional metadata for the step session.

Errors

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