DELETE
/
sessions
/
{session_id}
/
stop
curl
curl -X DELETE "https://api.notte.cc/sessions/$session_id/stop" \
-H "Authorization: Bearer $NOTTE_API_KEY" \
-H "Content-Type: application/json"
{
  "session_id": "<string>",
  "timeout_minutes": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "closed_at": "2023-11-07T05:31:56Z",
  "last_accessed_at": "2023-11-07T05:31:56Z",
  "duration": "<string>",
  "status": "active",
  "steps": [
    {}
  ],
  "error": "<string>",
  "credit_usage": 123,
  "proxies": false,
  "browser_type": "chromium",
  "use_file_storage": false
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
x-notte-request-origin
string | null
​
x-notte-sdk-version
string | null

Path Parameters

​
session_id
string
required

Response

Successful Response

​
session_id
string
required

The ID of the session (created or existing). Use this ID to interact with the session for the next operation.

​
timeout_minutes
integer
required

Session timeout in minutes. Will timeout if now() > last access time + timeout_minutes

​
created_at
string<date-time>
required

Session creation time

​
last_accessed_at
string<date-time>
required

Last access time

​
status
enum<string>
required

Session status

Available options:
active,
closed,
error,
timed_out
​
closed_at
string<date-time> | null

Session closing time

​
duration
string<duration>

Session duration

​
steps
Steps · object[]

Steps of the session

​
error
string | null

Error message if the operation failed to complete

​
credit_usage
number | null

Credit usage for the session. None

​
proxies
boolean
default:false

Whether proxies were used for the session. True if any proxy was applied during session creation.

​
browser_type
enum<string>
default:chromium
Available options:
chromium,
chrome,
firefox,
chrome-nightly
​
use_file_storage
boolean
default:false

Whether FileStorage was attached to the session.