Create a computer

Creates a new persistent computer environment.

POST /api/v0/computers

Create a computer

cURL

curl --request POST \
  --url https://api.factory.ai/api/v0/computers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "hostId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "remoteUser": "<string>",
  "repos": [
    "<string>"
  ],
  "autoInstallDeps": true,
  "serviceAccountId": "<string>",
  "source": {
    "kind": "template",
    "templateId": "<string>"
  }
}
'

import requests

url = "https://api.factory.ai/api/v0/computers"

payload = {
    "name": "<string>",
    "hostId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "remoteUser": "<string>",
    "repos": ["<string>"],
    "autoInstallDeps": True,
    "serviceAccountId": "<string>",
    "source": {
        "kind": "template",
        "templateId": "<string>"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    hostId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    remoteUser: '<string>',
    repos: ['<string>'],
    autoInstallDeps: true,
    serviceAccountId: '<string>',
    source: {kind: 'template', templateId: '<string>'}
  })
};

fetch('https://api.factory.ai/api/v0/computers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.factory.ai/api/v0/computers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'hostId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'remoteUser' => '<string>',
    'repos' => [
        '<string>'
    ],
    'autoInstallDeps' => true,
    'serviceAccountId' => '<string>',
    'source' => [
        'kind' => 'template',
        'templateId' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.factory.ai/api/v0/computers"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"hostId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"remoteUser\": \"<string>\",\n  \"repos\": [\n    \"<string>\"\n  ],\n  \"autoInstallDeps\": true,\n  \"serviceAccountId\": \"<string>\",\n  \"source\": {\n    \"kind\": \"template\",\n    \"templateId\": \"<string>\"\n  }\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(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.factory.ai/api/v0/computers")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"hostId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"remoteUser\": \"<string>\",\n  \"repos\": [\n    \"<string>\"\n  ],\n  \"autoInstallDeps\": true,\n  \"serviceAccountId\": \"<string>\",\n  \"source\": {\n    \"kind\": \"template\",\n    \"templateId\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.factory.ai/api/v0/computers")

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  \"name\": \"<string>\",\n  \"hostId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"remoteUser\": \"<string>\",\n  \"repos\": [\n    \"<string>\"\n  ],\n  \"autoInstallDeps\": true,\n  \"serviceAccountId\": \"<string>\",\n  \"source\": {\n    \"kind\": \"template\",\n    \"templateId\": \"<string>\"\n  }\n}"

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

201

{
  "id": "<string>",
  "name": "<string>",
  "createdAt": 123,
  "hostId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "hostname": "<string>",
  "provisioningSteps": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "<string>",
      "error": "<string>",
      "startedAt": 123,
      "completedAt": 123,
      "installSessionId": "<string>"
    }
  ],
  "relayClientUrl": "<string>",
  "relayAgentUrl": "<string>",
  "remoteUser": "<string>",
  "clonedRepoDirectories": [
    "<string>"
  ],
  "ownerPrincipalKind": "<string>",
  "ownerId": "<string>",
  "computerSource": {
    "kind": "template",
    "templateId": "<string>"
  }
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "metadata": {}
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "metadata": {}
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "metadata": {}
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "metadata": {}
}

{
  "detail": "<string>",
  "status": 123,
  "title": "<string>",
  "metadata": {}
}

Authorizations

Authorization · string · header · required

Factory API key or JWT token for authentication

Body

application/json

name · string · required

Required string length: 1 - 63

provider · enum<string>

Available options: byom, e2b

hostId · string<uuid>

remoteUser · string

Required string length: 1 - 63

repos · string<uri>[]

Maximum array length: 20

Maximum string length: 2048

autoInstallDeps · boolean

serviceAccountId · string

Minimum string length: 1

source · object

Option 1

Option 2

Show child attributes

Response

201

application/json

Response for status 201

id · string · required

name · string · required

providerType · enum<string> · required

Available options: byom, e2b

createdAt · number · required

hostId · string<uuid>

hostname · string

status · enum<string>

Available options: provisioning, active, error

provisioningSteps · object[]

Show child attributes

relayClientUrl · string<uri>

relayAgentUrl · string<uri>

remoteUser · string

clonedRepoDirectories · string[]

ownerPrincipalKind · string

ownerId · string

computerSource · object

Option 1

Option 2

Show child attributes