Skip to main content
cURL
curl --request POST \
  --url https://api.simplex.sh/start_capture_mode \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}'
{
  "succeeded": true
}
Starts capture mode for a session.

Authorizations

X-API-Key
string
header
required

Simplex API Key

Body

application/json
session_id
string<uuid>

The ID of the session.

Response

Start capture mode response

succeeded
boolean

Indicates if the action succeeded.

Example:

true

I