POST
/
v1
/
sessions
/
new
curl --request POST \
  --url https://api.allyson.ai/v1/sessions/new \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "task": "Search for the price of an ESP32 & save it to a text file.",
  "sessionVariables": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "sessionDetails": "<string>",
  "maxSteps": 123
}'
{
  "message": "Browser session started successfully",
  "sessionId": "a1b2c3d4",
  "messages": [
    {
      "role": "<string>",
      "content": "<string>"
    }
  ],
  "status": "active",
  "name": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Add your API key from app.allyson.ai/api to the x-api-key header.

Body

application/json
​
task
string
required

The task description for the automation session

Example:

"Search for the price of an ESP32 & save it to a text file."

​
maxSteps
number
required

Maximum number of steps for the session

​
sessionVariables
object[]

Optional settings for the session

​
sessionDetails
string

Detailed description of the session

Response

200
application/json
Session started successfully
​
message
string
required
Example:

"Browser session started successfully"

​
sessionId
string
required
Example:

"a1b2c3d4"

​
messages
object[]
required
​
status
enum<string>
required
Available options:
active,
inactive,
completed,
failed,
humanInput,
stopped
​
name
string
required

AI-generated name for the task