> 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.

# Create Runtime

POST https://api.bctrl.ai/v2/runtimes
Content-Type: application/json

Create a runtime and return the simplified runtime detail resource. Pass the owning space id in the request body.

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

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: bctrl API
  version: 1.0.0
paths:
  /v2/runtimes:
    post:
      operationId: v-2-runtimes-create
      summary: Create a runtime
      description: >-
        Create a runtime and return the simplified runtime detail resource. Pass
        the owning space id in the request body.
      tags:
        - subpackage_runtimes
      parameters:
        - 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.create_Response_200'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                config:
                  $ref: >-
                    #/components/schemas/V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfig
                metadata:
                  $ref: >-
                    #/components/schemas/V2RuntimesPostRequestBodyContentApplicationJsonSchemaMetadata
                name:
                  type: string
                spaceId:
                  type: string
                  format: uuid
                type:
                  type: string
                  enum:
                    - browser
              required:
                - spaceId
                - type
servers:
  - url: https://api.bctrl.ai
  - url: http://localhost:8787
components:
  schemas:
    V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigBrowser:
      type: object
      properties:
        profile:
          type: boolean
      title: V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigBrowser
    V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigFingerprintBrowser:
      type: string
      enum:
        - chrome
        - edge
      title: >-
        V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigFingerprintBrowser
    V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigFingerprintLocale:
      type: string
      enum:
        - en-US
        - en-GB
        - de-DE
        - fr-FR
        - es-ES
        - es-MX
        - it-IT
        - nl-NL
        - pt-BR
        - pt-PT
        - pl-PL
        - tr-TR
        - sv-SE
        - da-DK
        - nb-NO
        - fi-FI
        - ja-JP
        - ko-KR
        - zh-CN
        - zh-TW
      title: >-
        V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigFingerprintLocale
    V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigFingerprint:
      type: object
      properties:
        browser:
          $ref: >-
            #/components/schemas/V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigFingerprintBrowser
        locale:
          $ref: >-
            #/components/schemas/V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigFingerprintLocale
      title: V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigFingerprint
    V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigLifecycle:
      type: object
      properties:
        idleTimeoutMinutes:
          type: integer
      title: V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigLifecycle
    V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigProxyDiscriminatorMappingCustomProtocol:
      type: string
      enum:
        - http
        - socks5
      title: >-
        V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigProxyDiscriminatorMappingCustomProtocol
    V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigProxyDiscriminatorMappingSavedOverridesAffinity:
      oneOf:
        - type: object
          properties:
            strategy:
              type: string
              enum:
                - rotate
              description: 'Discriminator value: rotate'
          required:
            - strategy
          description: rotate variant
        - type: object
          properties:
            strategy:
              type: string
              enum:
                - sticky
              description: 'Discriminator value: sticky'
            key:
              type: string
          required:
            - strategy
          description: sticky variant
      discriminator:
        propertyName: strategy
      title: >-
        V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigProxyDiscriminatorMappingSavedOverridesAffinity
    V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigProxyDiscriminatorMappingSavedOverridesGeo:
      type: object
      properties:
        city:
          type: string
        country:
          type: string
        isp:
          type: string
        region:
          type: string
      title: >-
        V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigProxyDiscriminatorMappingSavedOverridesGeo
    V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigProxyDiscriminatorMappingSavedOverridesIpFamily:
      type: string
      enum:
        - dual-stack
        - ipv4-only
      title: >-
        V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigProxyDiscriminatorMappingSavedOverridesIpFamily
    V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigProxyDiscriminatorMappingSavedOverridesPoolPreference:
      type: string
      enum:
        - quality
        - quality-speed
        - speed
        - max-pool
      title: >-
        V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigProxyDiscriminatorMappingSavedOverridesPoolPreference
    V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigProxyDiscriminatorMappingSavedOverridesProtocol:
      type: string
      enum:
        - http
        - socks5
      title: >-
        V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigProxyDiscriminatorMappingSavedOverridesProtocol
    V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigProxyDiscriminatorMappingSavedOverrides:
      type: object
      properties:
        affinity:
          $ref: >-
            #/components/schemas/V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigProxyDiscriminatorMappingSavedOverridesAffinity
        geo:
          $ref: >-
            #/components/schemas/V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigProxyDiscriminatorMappingSavedOverridesGeo
        ipFamily:
          $ref: >-
            #/components/schemas/V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigProxyDiscriminatorMappingSavedOverridesIpFamily
        poolPreference:
          $ref: >-
            #/components/schemas/V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigProxyDiscriminatorMappingSavedOverridesPoolPreference
        protocol:
          $ref: >-
            #/components/schemas/V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigProxyDiscriminatorMappingSavedOverridesProtocol
      title: >-
        V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigProxyDiscriminatorMappingSavedOverrides
    V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigProxy:
      oneOf:
        - type: object
          properties:
            mode:
              type: string
              enum:
                - custom
              description: 'Discriminator value: custom'
            host:
              type: string
            password:
              type: string
            port:
              type: integer
            protocol:
              $ref: >-
                #/components/schemas/V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigProxyDiscriminatorMappingCustomProtocol
            username:
              type: string
          required:
            - mode
            - host
            - port
            - protocol
          description: custom variant
        - type: object
          properties:
            mode:
              type: string
              enum:
                - saved
              description: 'Discriminator value: saved'
            id:
              type: string
              format: uuid
            overrides:
              $ref: >-
                #/components/schemas/V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigProxyDiscriminatorMappingSavedOverrides
          required:
            - mode
            - id
          description: saved variant
      discriminator:
        propertyName: mode
      title: V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigProxy
    V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigStealth:
      type: string
      enum:
        - medium
        - high
        - ultra
      title: V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigStealth
    V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfig:
      type: object
      properties:
        browser:
          $ref: >-
            #/components/schemas/V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigBrowser
        extensions:
          type: array
          items:
            type: string
        fingerprint:
          $ref: >-
            #/components/schemas/V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigFingerprint
        lifecycle:
          $ref: >-
            #/components/schemas/V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigLifecycle
        proxy:
          oneOf:
            - $ref: >-
                #/components/schemas/V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigProxy
            - type: 'null'
        stealth:
          $ref: >-
            #/components/schemas/V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfigStealth
      title: V2RuntimesPostRequestBodyContentApplicationJsonSchemaConfig
    V2RuntimesPostRequestBodyContentApplicationJsonSchemaMetadata:
      type: object
      properties: {}
      title: V2RuntimesPostRequestBodyContentApplicationJsonSchemaMetadata
    V2RuntimesPostResponsesContentApplicationJsonSchemaConfigOneOf0Browser:
      type: object
      properties:
        profile:
          type: boolean
      required:
        - profile
      title: V2RuntimesPostResponsesContentApplicationJsonSchemaConfigOneOf0Browser
    V2RuntimesPostResponsesContentApplicationJsonSchemaConfigOneOf0FingerprintViewport:
      type: object
      properties:
        height:
          type: integer
        width:
          type: integer
      required:
        - height
        - width
      title: >-
        V2RuntimesPostResponsesContentApplicationJsonSchemaConfigOneOf0FingerprintViewport
    V2RuntimesPostResponsesContentApplicationJsonSchemaConfigOneOf0Fingerprint:
      type: object
      properties:
        browser:
          type: string
        locale:
          type: string
        timezone:
          type: string
        userAgent:
          type: string
        viewport:
          $ref: >-
            #/components/schemas/V2RuntimesPostResponsesContentApplicationJsonSchemaConfigOneOf0FingerprintViewport
      title: >-
        V2RuntimesPostResponsesContentApplicationJsonSchemaConfigOneOf0Fingerprint
    V2RuntimesPostResponsesContentApplicationJsonSchemaConfigOneOf0Lifecycle:
      type: object
      properties:
        idleTimeoutMinutes:
          type: integer
        lastActivityAt:
          type: string
          format: date-time
      required:
        - idleTimeoutMinutes
        - lastActivityAt
      title: V2RuntimesPostResponsesContentApplicationJsonSchemaConfigOneOf0Lifecycle
    V2RuntimesPostResponsesContentApplicationJsonSchemaConfigOneOf0Proxy:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
      title: V2RuntimesPostResponsesContentApplicationJsonSchemaConfigOneOf0Proxy
    V2RuntimesPostResponsesContentApplicationJsonSchemaConfigOneOf0Stealth:
      type: string
      enum:
        - medium
        - high
        - ultra
      title: V2RuntimesPostResponsesContentApplicationJsonSchemaConfigOneOf0Stealth
    V2RuntimesPostResponsesContentApplicationJsonSchemaConfig0:
      type: object
      properties:
        browser:
          $ref: >-
            #/components/schemas/V2RuntimesPostResponsesContentApplicationJsonSchemaConfigOneOf0Browser
        extensions:
          type: array
          items:
            type: string
        fingerprint:
          $ref: >-
            #/components/schemas/V2RuntimesPostResponsesContentApplicationJsonSchemaConfigOneOf0Fingerprint
        lifecycle:
          $ref: >-
            #/components/schemas/V2RuntimesPostResponsesContentApplicationJsonSchemaConfigOneOf0Lifecycle
        proxy:
          oneOf:
            - $ref: >-
                #/components/schemas/V2RuntimesPostResponsesContentApplicationJsonSchemaConfigOneOf0Proxy
            - type: 'null'
        stealth:
          $ref: >-
            #/components/schemas/V2RuntimesPostResponsesContentApplicationJsonSchemaConfigOneOf0Stealth
      required:
        - browser
      title: V2RuntimesPostResponsesContentApplicationJsonSchemaConfig0
    V2RuntimesPostResponsesContentApplicationJsonSchemaConfig:
      oneOf:
        - $ref: >-
            #/components/schemas/V2RuntimesPostResponsesContentApplicationJsonSchemaConfig0
        - type: object
          additionalProperties:
            description: Any type
      title: V2RuntimesPostResponsesContentApplicationJsonSchemaConfig
    V2RuntimesPostResponsesContentApplicationJsonSchemaMetadata:
      type: object
      properties: {}
      title: V2RuntimesPostResponsesContentApplicationJsonSchemaMetadata
    V2RuntimesPostResponsesContentApplicationJsonSchemaStatus:
      type: string
      enum:
        - active
        - stopped
        - failed
      title: V2RuntimesPostResponsesContentApplicationJsonSchemaStatus
    V2RuntimesPostResponsesContentApplicationJsonSchemaType:
      type: string
      enum:
        - browser
        - desktop
        - spreadsheet
      title: V2RuntimesPostResponsesContentApplicationJsonSchemaType
    runtimes_v2.runtimes.create_Response_200:
      type: object
      properties:
        activeRunId:
          type:
            - string
            - 'null'
          format: uuid
        config:
          $ref: >-
            #/components/schemas/V2RuntimesPostResponsesContentApplicationJsonSchemaConfig
        createdAt:
          type: string
        id:
          type: string
          format: uuid
        metadata:
          oneOf:
            - $ref: >-
                #/components/schemas/V2RuntimesPostResponsesContentApplicationJsonSchemaMetadata
            - type: 'null'
        name:
          type: string
        status:
          $ref: >-
            #/components/schemas/V2RuntimesPostResponsesContentApplicationJsonSchemaStatus
        type:
          $ref: >-
            #/components/schemas/V2RuntimesPostResponsesContentApplicationJsonSchemaType
        updatedAt:
          type: string
      required:
        - activeRunId
        - createdAt
        - id
        - name
        - status
        - type
        - updatedAt
      title: runtimes_v2.runtimes.create_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"

payload = {
    "spaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "browser"
}
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';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"spaceId":"3fa85f64-5717-4562-b3fc-2c963f66afa6","type":"browser"}'
};

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"

	payload := strings.NewReader("{\n  \"spaceId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"type\": \"browser\"\n}")

	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")

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 = "{\n  \"spaceId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"type\": \"browser\"\n}"

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")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"spaceId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"type\": \"browser\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.bctrl.ai/v2/runtimes', [
  'body' => '{
  "spaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "type": "browser"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.bctrl.ai/v2/runtimes");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"spaceId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"type\": \"browser\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "spaceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "type": "browser"
] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.bctrl.ai/v2/runtimes")! 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()
```