> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://platform.bctrl.ai/llms.txt.
> For full documentation content, see https://platform.bctrl.ai/llms-full.txt.

# Start Runtime

POST https://api.bctrl.ai/v2/runtimes/{runtimeId}/start
Content-Type: application/json

Start a runtime, open its active run, and return the default CDP connection URL and live view URL.

Reference: https://platform.bctrl.ai/v2/api/api-reference/runtimes/start

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: bctrl API
  version: 1.0.0
paths:
  /v2/runtimes/{runtimeId}/start:
    post:
      operationId: v-2-runtimes-start
      summary: Start a runtime
      description: >-
        Start a runtime, open its active run, and return the default CDP
        connection URL and live view URL.
      tags:
        - subpackage_runtimes
      parameters:
        - name: runtimeId
          in: path
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: Use Bearer <api-key>.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/runtimes_v2.runtimes.start_Response_200'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                live:
                  $ref: >-
                    #/components/schemas/V2RuntimesRuntimeIdStartPostRequestBodyContentApplicationJsonSchemaLive
servers:
  - url: https://api.bctrl.ai
  - url: http://localhost:8787
components:
  schemas:
    V2RuntimesRuntimeIdStartPostRequestBodyContentApplicationJsonSchemaLiveControl:
      type: string
      enum:
        - none
        - input
      title: >-
        V2RuntimesRuntimeIdStartPostRequestBodyContentApplicationJsonSchemaLiveControl
    V2RuntimesRuntimeIdStartPostRequestBodyContentApplicationJsonSchemaLive:
      type: object
      properties:
        control:
          $ref: >-
            #/components/schemas/V2RuntimesRuntimeIdStartPostRequestBodyContentApplicationJsonSchemaLiveControl
        expiresInSeconds:
          type: integer
      title: V2RuntimesRuntimeIdStartPostRequestBodyContentApplicationJsonSchemaLive
    V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaConnection:
      type: object
      properties:
        expiresAt:
          type:
            - string
            - 'null'
          format: date-time
        id:
          type: string
          format: uuid
        protocol:
          type: string
          enum:
            - cdp
        url:
          type: string
      required:
        - expiresAt
        - id
        - protocol
        - url
      title: >-
        V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaConnection
    V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaLiveControl:
      type: string
      enum:
        - none
        - input
      title: >-
        V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaLiveControl
    V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaLive:
      type: object
      properties:
        control:
          $ref: >-
            #/components/schemas/V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaLiveControl
        expiresAt:
          type: string
        url:
          type: string
      required:
        - control
        - expiresAt
        - url
      title: V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaLive
    V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRunRuntimeType:
      type: string
      enum:
        - browser
        - desktop
        - spreadsheet
      title: >-
        V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRunRuntimeType
    V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRunStatus:
      type: string
      enum:
        - active
        - stopped
        - failed
      title: >-
        V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRunStatus
    V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRun:
      type: object
      properties:
        createdAt:
          type: string
        durationMs:
          type:
            - integer
            - 'null'
        endedReason:
          type:
            - string
            - 'null'
        failureReason:
          type:
            - string
            - 'null'
        finishedAt:
          type:
            - string
            - 'null'
        id:
          type: string
          format: uuid
        lastSeenAt:
          type:
            - string
            - 'null'
        runtimeId:
          type: string
          format: uuid
        runtimeType:
          $ref: >-
            #/components/schemas/V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRunRuntimeType
        spaceId:
          type: string
          format: uuid
        startedAt:
          type: string
        status:
          $ref: >-
            #/components/schemas/V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRunStatus
      required:
        - createdAt
        - id
        - runtimeId
        - runtimeType
        - spaceId
        - startedAt
        - status
      title: V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRun
    V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntimeConfigOneOf0Browser:
      type: object
      properties:
        profile:
          type: boolean
      required:
        - profile
      title: >-
        V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntimeConfigOneOf0Browser
    V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntimeConfigOneOf0FingerprintViewport:
      type: object
      properties:
        height:
          type: integer
        width:
          type: integer
      required:
        - height
        - width
      title: >-
        V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntimeConfigOneOf0FingerprintViewport
    V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntimeConfigOneOf0Fingerprint:
      type: object
      properties:
        browser:
          type: string
        locale:
          type: string
        timezone:
          type: string
        userAgent:
          type: string
        viewport:
          $ref: >-
            #/components/schemas/V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntimeConfigOneOf0FingerprintViewport
      title: >-
        V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntimeConfigOneOf0Fingerprint
    V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntimeConfigOneOf0Lifecycle:
      type: object
      properties:
        idleTimeoutMinutes:
          type: integer
        lastActivityAt:
          type: string
          format: date-time
      required:
        - idleTimeoutMinutes
        - lastActivityAt
      title: >-
        V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntimeConfigOneOf0Lifecycle
    V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntimeConfigOneOf0Proxy:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
      title: >-
        V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntimeConfigOneOf0Proxy
    V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntimeConfigOneOf0Stealth:
      type: string
      enum:
        - medium
        - high
        - ultra
      title: >-
        V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntimeConfigOneOf0Stealth
    V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntimeConfig0:
      type: object
      properties:
        browser:
          $ref: >-
            #/components/schemas/V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntimeConfigOneOf0Browser
        extensions:
          type: array
          items:
            type: string
        fingerprint:
          $ref: >-
            #/components/schemas/V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntimeConfigOneOf0Fingerprint
        lifecycle:
          $ref: >-
            #/components/schemas/V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntimeConfigOneOf0Lifecycle
        proxy:
          oneOf:
            - $ref: >-
                #/components/schemas/V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntimeConfigOneOf0Proxy
            - type: 'null'
        stealth:
          $ref: >-
            #/components/schemas/V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntimeConfigOneOf0Stealth
      required:
        - browser
      title: >-
        V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntimeConfig0
    V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntimeConfig:
      oneOf:
        - $ref: >-
            #/components/schemas/V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntimeConfig0
        - type: object
          additionalProperties:
            description: Any type
      title: >-
        V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntimeConfig
    V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntimeMetadata:
      type: object
      properties: {}
      title: >-
        V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntimeMetadata
    V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntimeStatus:
      type: string
      enum:
        - active
        - stopped
        - failed
      title: >-
        V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntimeStatus
    V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntimeType:
      type: string
      enum:
        - browser
        - desktop
        - spreadsheet
      title: >-
        V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntimeType
    V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntime:
      type: object
      properties:
        activeRunId:
          type:
            - string
            - 'null'
          format: uuid
        config:
          $ref: >-
            #/components/schemas/V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntimeConfig
        createdAt:
          type: string
        id:
          type: string
          format: uuid
        metadata:
          oneOf:
            - $ref: >-
                #/components/schemas/V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntimeMetadata
            - type: 'null'
        name:
          type: string
        status:
          $ref: >-
            #/components/schemas/V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntimeStatus
        type:
          $ref: >-
            #/components/schemas/V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntimeType
        updatedAt:
          type: string
      required:
        - activeRunId
        - createdAt
        - id
        - name
        - status
        - type
        - updatedAt
      title: V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntime
    runtimes_v2.runtimes.start_Response_200:
      type: object
      properties:
        connection:
          $ref: >-
            #/components/schemas/V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaConnection
        live:
          $ref: >-
            #/components/schemas/V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaLive
        run:
          $ref: >-
            #/components/schemas/V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRun
        runtime:
          $ref: >-
            #/components/schemas/V2RuntimesRuntimeIdStartPostResponsesContentApplicationJsonSchemaRuntime
      required:
        - connection
        - live
        - run
        - runtime
      title: runtimes_v2.runtimes.start_Response_200
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Use Bearer <api-key>.

```

## SDK Code Examples

```python
import requests

url = "https://api.bctrl.ai/v2/runtimes/runtimeId/start"

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.bctrl.ai/v2/runtimes/runtimeId/start';
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.bctrl.ai/v2/runtimes/runtimeId/start"

	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.bctrl.ai/v2/runtimes/runtimeId/start")

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.bctrl.ai/v2/runtimes/runtimeId/start")
  .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.bctrl.ai/v2/runtimes/runtimeId/start', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.bctrl.ai/v2/runtimes/runtimeId/start");
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.bctrl.ai/v2/runtimes/runtimeId/start")! 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()
```