Capture LogoCapture
Sessions
POST/v1/sessions

Creates a stateful browser session on the handling Capture API instance. The session is automatically closed when its TTL expires. Billable sessions charge 1 credit per elapsed minute, rounded up. Each user can have up to 5 active sessions at a time.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/sessions" \  -H "Content-Type: application/json" \  -d '{}'
{
  "success": true,
  "session": {
    "id": "string",
    "status": "active",
    "expiresAt": "2019-08-24T14:15:22Z",
    "maxTtlSeconds": 0,
    "proxy": true,
    "bypassBotDetection": true
  }
}
{
  "success": false,
  "error": "string"
}
{
  "success": false,
  "error": "string"
}
{
  "success": false,
  "error": "string",
  "activeSessionCount": 5,
  "maxConcurrentSessions": 5
}
{
  "success": false,
  "error": "string"
}

Overview

Learn what Capture browser sessions are, when to use them, and how to create a session before running browser actions.

Get session metadata GET

Next Page