Create worker
curl --request POST \
--url https://api.openworklabs.com/v1/workers \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"workspacePath": "<string>",
"sandboxBackend": "<string>",
"imageVersion": "<string>"
}
'import requests
url = "https://api.openworklabs.com/v1/workers"
payload = {
"name": "<string>",
"description": "<string>",
"workspacePath": "<string>",
"sandboxBackend": "<string>",
"imageVersion": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
workspacePath: '<string>',
sandboxBackend: '<string>',
imageVersion: '<string>'
})
};
fetch('https://api.openworklabs.com/v1/workers', 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.openworklabs.com/v1/workers",
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>',
'description' => '<string>',
'workspacePath' => '<string>',
'sandboxBackend' => '<string>',
'imageVersion' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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.openworklabs.com/v1/workers"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"workspacePath\": \"<string>\",\n \"sandboxBackend\": \"<string>\",\n \"imageVersion\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.openworklabs.com/v1/workers")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"workspacePath\": \"<string>\",\n \"sandboxBackend\": \"<string>\",\n \"imageVersion\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/workers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"workspacePath\": \"<string>\",\n \"sandboxBackend\": \"<string>\",\n \"imageVersion\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"worker": {
"id": "<string>",
"orgId": "<string>",
"createdByUserId": "<string>",
"isMine": true,
"name": "<string>",
"description": "<string>",
"destination": "<string>",
"status": "<string>",
"imageVersion": "<string>",
"workspacePath": "<string>",
"sandboxBackend": "<string>",
"lastHeartbeatAt": "2023-11-07T05:31:56Z",
"lastActiveAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"tokens": {
"owner": "<string>",
"host": "<string>",
"client": "<string>"
},
"instance": {
"provider": "<string>",
"region": "<string>",
"url": "<string>",
"status": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"launch": {
"mode": "<string>",
"pollAfterMs": 0
}
}{
"worker": {
"id": "<string>",
"orgId": "<string>",
"createdByUserId": "<string>",
"isMine": true,
"name": "<string>",
"description": "<string>",
"destination": "<string>",
"status": "<string>",
"imageVersion": "<string>",
"workspacePath": "<string>",
"sandboxBackend": "<string>",
"lastHeartbeatAt": "2023-11-07T05:31:56Z",
"lastActiveAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"tokens": {
"owner": "<string>",
"host": "<string>",
"client": "<string>"
},
"instance": {
"provider": "<string>",
"region": "<string>",
"url": "<string>",
"status": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"launch": {
"mode": "<string>",
"pollAfterMs": 0
}
}{
"error": "<string>",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
]
}{
"error": "<string>"
}{
"error": "<string>",
"limitType": "<string>",
"limit": 0,
"currentCount": 0,
"message": "<string>"
}Workers
Create worker
Creates a local or cloud worker for the active organization and returns the initial tokens needed to connect to it.
POST
/
v1
/
workers
Create worker
curl --request POST \
--url https://api.openworklabs.com/v1/workers \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"workspacePath": "<string>",
"sandboxBackend": "<string>",
"imageVersion": "<string>"
}
'import requests
url = "https://api.openworklabs.com/v1/workers"
payload = {
"name": "<string>",
"description": "<string>",
"workspacePath": "<string>",
"sandboxBackend": "<string>",
"imageVersion": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
workspacePath: '<string>',
sandboxBackend: '<string>',
imageVersion: '<string>'
})
};
fetch('https://api.openworklabs.com/v1/workers', 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.openworklabs.com/v1/workers",
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>',
'description' => '<string>',
'workspacePath' => '<string>',
'sandboxBackend' => '<string>',
'imageVersion' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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.openworklabs.com/v1/workers"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"workspacePath\": \"<string>\",\n \"sandboxBackend\": \"<string>\",\n \"imageVersion\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.openworklabs.com/v1/workers")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"workspacePath\": \"<string>\",\n \"sandboxBackend\": \"<string>\",\n \"imageVersion\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/workers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"workspacePath\": \"<string>\",\n \"sandboxBackend\": \"<string>\",\n \"imageVersion\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"worker": {
"id": "<string>",
"orgId": "<string>",
"createdByUserId": "<string>",
"isMine": true,
"name": "<string>",
"description": "<string>",
"destination": "<string>",
"status": "<string>",
"imageVersion": "<string>",
"workspacePath": "<string>",
"sandboxBackend": "<string>",
"lastHeartbeatAt": "2023-11-07T05:31:56Z",
"lastActiveAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"tokens": {
"owner": "<string>",
"host": "<string>",
"client": "<string>"
},
"instance": {
"provider": "<string>",
"region": "<string>",
"url": "<string>",
"status": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"launch": {
"mode": "<string>",
"pollAfterMs": 0
}
}{
"worker": {
"id": "<string>",
"orgId": "<string>",
"createdByUserId": "<string>",
"isMine": true,
"name": "<string>",
"description": "<string>",
"destination": "<string>",
"status": "<string>",
"imageVersion": "<string>",
"workspacePath": "<string>",
"sandboxBackend": "<string>",
"lastHeartbeatAt": "2023-11-07T05:31:56Z",
"lastActiveAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"tokens": {
"owner": "<string>",
"host": "<string>",
"client": "<string>"
},
"instance": {
"provider": "<string>",
"region": "<string>",
"url": "<string>",
"status": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"launch": {
"mode": "<string>",
"pollAfterMs": 0
}
}{
"error": "<string>",
"details": [
{
"message": "<string>",
"path": [
"<string>"
]
}
]
}{
"error": "<string>"
}{
"error": "<string>",
"limitType": "<string>",
"limit": 0,
"currentCount": 0,
"message": "<string>"
}Body
application/json
Was this page helpful?
⌘I