> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.cloudraker.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.cloudraker.com/_mcp/server.

# Start (or fetch) the browser session of a user-triggered playbook action

POST https://api.cloudraker.com/spaces/{spaceId}/playbook-runs/{runId}/actions/{installedActionId}/start-browser

Starts the browser session for a user-triggered form-filling playbook action and returns `{ data: { sessionId, pairUrl, controlUrl, status, ... } }`. The caller opens the pairUrl in a compatible browser with the CloudRaker extension installed; once paired, the playbook agent drives that tab to fill the form. Idempotent: while a session is open the same session (and pairUrl) is returned. Authorization: `space:contribute` (org admins bypass); missing → 403. Returns 409 when dependencies are unmet or another session open, 422 not a user-triggered action, 502 browser session unavailable.

Reference: https://docs.cloudraker.com/api/cloud-raker-api/workspace/playbooks/start-playbook-run-browser-action

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: CloudRaker API
  version: 1.0.0
paths:
  /spaces/{spaceId}/playbook-runs/{runId}/actions/{installedActionId}/start-browser:
    post:
      operationId: start-playbook-run-browser-action
      summary: Start (or fetch) the browser session of a user-triggered playbook action
      description: >-
        Starts the browser session for a user-triggered form-filling playbook
        action and returns `{ data: { sessionId, pairUrl, controlUrl, status,
        ... } }`. The caller opens the pairUrl in a compatible browser with the
        CloudRaker extension installed; once paired, the playbook agent drives
        that tab to fill the form. Idempotent: while a session is open the same
        session (and pairUrl) is returned. Authorization: `space:contribute`
        (org admins bypass); missing → 403. Returns 409 when dependencies are
        unmet or another session open, 422 not a user-triggered action, 502
        browser session unavailable.
      tags:
        - playbooks
      parameters:
        - name: spaceId
          in: path
          required: true
          schema:
            type: string
        - name: runId
          in: path
          required: true
          schema:
            type: string
        - name: installedActionId
          in: path
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: Bearer authentication
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The browser session, including its pairing URL.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlaybookRunBrowserSession'
servers:
  - url: https://api.cloudraker.com
    description: Production
  - url: https://api.staging.raker.one
    description: Staging
  - url: https://api.dev.raker.one
    description: Development
components:
  schemas:
    PlaybookRunBrowserSessionDataStatus:
      type: string
      enum:
        - pairing
        - live
        - ended
        - expired
      title: PlaybookRunBrowserSessionDataStatus
    PlaybookRunBrowserSessionData:
      type: object
      properties:
        sessionId:
          type: string
        installedActionId:
          type: string
        status:
          $ref: '#/components/schemas/PlaybookRunBrowserSessionDataStatus'
        pairUrl:
          type: string
          description: Open in a browser carrying the extension to pair the session.
        controlUrl:
          type: string
        startUrl:
          type:
            - string
            - 'null'
        createdAt:
          type: string
          format: date-time
      required:
        - sessionId
        - installedActionId
        - status
        - pairUrl
        - controlUrl
        - startUrl
        - createdAt
      title: PlaybookRunBrowserSessionData
    PlaybookRunBrowserSession:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/PlaybookRunBrowserSessionData'
      required:
        - data
      title: PlaybookRunBrowserSession
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

```

## Examples



**Request**

```json
{}
```

**Response**

```json
{
  "data": {
    "sessionId": "a3f1c9d2-7b4e-4f8a-9d3e-2b5f6c7d8e9f",
    "installedActionId": "action-12345",
    "status": "pairing",
    "pairUrl": "https://cloudraker.com/pair/session/a3f1c9d2-7b4e-4f8a-9d3e-2b5f6c7d8e9f",
    "controlUrl": "https://api.cloudraker.com/control/session/a3f1c9d2-7b4e-4f8a-9d3e-2b5f6c7d8e9f",
    "startUrl": "https://example.com/form/start",
    "createdAt": "2024-01-15T09:30:00Z"
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.cloudraker.com/spaces/spaceId/playbook-runs/runId/actions/installedActionId/start-browser"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.cloudraker.com/spaces/spaceId/playbook-runs/runId/actions/installedActionId/start-browser';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cloudraker.com/spaces/spaceId/playbook-runs/runId/actions/installedActionId/start-browser"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.cloudraker.com/spaces/spaceId/playbook-runs/runId/actions/installedActionId/start-browser")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.cloudraker.com/spaces/spaceId/playbook-runs/runId/actions/installedActionId/start-browser")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.cloudraker.com/spaces/spaceId/playbook-runs/runId/actions/installedActionId/start-browser', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.cloudraker.com/spaces/spaceId/playbook-runs/runId/actions/installedActionId/start-browser");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.cloudraker.com/spaces/spaceId/playbook-runs/runId/actions/installedActionId/start-browser")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```