curl --request POST \
--url https://api.floppydata.net/v2/browser/sessions \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '{}'{
"id": "58e531ee-16ca-49d0-8722-b425d154cc10",
"status": "running",
"connectUrl": "wss://api.floppydata.net/v2/browser/sessions/58e531ee-16ca-49d0-8722-b425d154cc10/connect?token=SIGNED_TOKEN",
"settings": {
"id": "f742823c-7ba6-4488-a72d-6e9c5447eacb"
},
"runtime": {
"timeoutSeconds": 1800,
"keepAlive": true
},
"metadata": {
"taskId": "checkout-42"
},
"createdAt": "2026-07-10T12:00:00Z",
"startedAt": "2026-07-10T12:00:01Z",
"expiresAt": "2026-07-10T12:30:00Z",
"endedAt": null
}{
"error": {
"code": "invalid_request",
"message": "Invalid request parameters.",
"details": {
"issues": [
{
"path": "country",
"code": "invalid_format",
"message": "Expected a 2-letter country code."
}
]
}
}
}{
"error": {
"code": "unauthorized",
"message": "Unauthorized",
"details": {}
}
}{
"error": {
"code": "insufficient_balance",
"message": "Insufficient proxy traffic balance.",
"details": {}
}
}{
"error": {
"code": "forbidden",
"message": "Forbidden",
"details": {}
}
}{
"error": {
"code": "not_found",
"message": "Rotating proxy credential was not found.",
"details": {}
}
}{
"error": {
"code": "account_not_configured",
"message": "Account is not configured for proxy products.",
"details": {}
}
}{
"error": {
"code": "internal_error",
"message": "Internal Server Error",
"details": {}
}
}{
"error": {
"code": "upstream_error",
"message": "Failed to fetch data from an upstream service.",
"details": {
"upstreamStatus": 503
}
}
}Create a Session
Creates and starts a browser. The smallest request is . Add startUrl to open one or more pages at launch, or navigate with Playwright or Puppeteer after connecting. Supply startUrl as one string of absolute HTTP or HTTPS URLs separated by commas without spaces, up to 2,048 characters total. Omit startUrl when supplying settings.id. Use the returned WebSocket URL to connect, select the tab by URL, and wait for the page content you need.
curl --request POST \
--url https://api.floppydata.net/v2/browser/sessions \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '{}'{
"id": "58e531ee-16ca-49d0-8722-b425d154cc10",
"status": "running",
"connectUrl": "wss://api.floppydata.net/v2/browser/sessions/58e531ee-16ca-49d0-8722-b425d154cc10/connect?token=SIGNED_TOKEN",
"settings": {
"id": "f742823c-7ba6-4488-a72d-6e9c5447eacb"
},
"runtime": {
"timeoutSeconds": 1800,
"keepAlive": true
},
"metadata": {
"taskId": "checkout-42"
},
"createdAt": "2026-07-10T12:00:00Z",
"startedAt": "2026-07-10T12:00:01Z",
"expiresAt": "2026-07-10T12:30:00Z",
"endedAt": null
}{
"error": {
"code": "invalid_request",
"message": "Invalid request parameters.",
"details": {
"issues": [
{
"path": "country",
"code": "invalid_format",
"message": "Expected a 2-letter country code."
}
]
}
}
}{
"error": {
"code": "unauthorized",
"message": "Unauthorized",
"details": {}
}
}{
"error": {
"code": "insufficient_balance",
"message": "Insufficient proxy traffic balance.",
"details": {}
}
}{
"error": {
"code": "forbidden",
"message": "Forbidden",
"details": {}
}
}{
"error": {
"code": "not_found",
"message": "Rotating proxy credential was not found.",
"details": {}
}
}{
"error": {
"code": "account_not_configured",
"message": "Account is not configured for proxy products.",
"details": {}
}
}{
"error": {
"code": "internal_error",
"message": "Internal Server Error",
"details": {}
}
}{
"error": {
"code": "upstream_error",
"message": "Failed to fetch data from an upstream service.",
"details": {
"upstreamStatus": 503
}
}
}{}. Add optional startUrl to open one or more pages at launch: supply absolute HTTP or HTTPS URLs in one string, separated by commas without spaces, up to 2,048 characters total. Omit startUrl when supplying settings.id.{
"startUrl": "https://example.com/,https://example.org/"
}
connectUrl to work with the opened tabs. Select the tab by URL and wait for the page content you need. If you omit startUrl, navigate with Playwright or Puppeteer after connecting.
Follow the Cloud Browser guide
Authorizations
Client API key for the authenticated account.
Body
Session-first browser request. Every field is optional. Use startUrl to open pages at launch, or navigate after connecting. Do not combine startUrl with settings.id.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Optional start URL or comma-separated list of start URLs. Each URL opens in a separate tab when the browser launches. Use absolute HTTP or HTTPS URLs, separated by commas without spaces. Supply one string, not a JSON array. The 2,048-character limit applies to the complete string, including separators. Percent-encode commas inside a URL as %2C. Omit this field when supplying settings.id. Wait for the page content you need after connecting.
2048"https://example.com/,https://example.org/"
Show child attributes
Show child attributes
Response
Browser session started.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$running, stopped, timedOut, failed Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?