Activate an Automation
curl --request POST \
--url https://api.openworklabs.com/v1/automations/{id}/activate \
--header 'x-api-key: <api-key>'import requests
url = "https://api.openworklabs.com/v1/automations/{id}/activate"
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.openworklabs.com/v1/automations/{id}/activate', 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/automations/{id}/activate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.openworklabs.com/v1/automations/{id}/activate"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-api-key", "<api-key>")
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/automations/{id}/activate")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/automations/{id}/activate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"automation": {
"id": "<string>",
"organizationId": "<string>",
"ownerMemberId": "<string>",
"name": "<string>",
"state": "active",
"currentRevisionId": "<string>",
"nextDueAt": 4503599627370495,
"latestRunAt": 4503599627370495,
"needsAttentionReason": {
"code": "owner_membership_lost",
"message": "<string>",
"occurredAt": 4503599627370495
},
"createdAt": 4503599627370495,
"updatedAt": 4503599627370495,
"archivedAt": 4503599627370495,
"latestSuccessfulRunId": "<string>",
"latestSuccessfulResult": "<unknown>"
},
"revision": {
"id": "<string>",
"automationId": "<string>",
"version": 123,
"instructions": "<string>",
"schedule": {
"kind": "once",
"timezone": "<string>",
"at": 4503599627370495
},
"model": {
"providerId": "<string>",
"modelId": "<string>",
"variant": "<string>"
},
"maximumRuntimeMs": 1805000,
"digest": "<string>",
"createdAt": 4503599627370495,
"action": {
"kind": "agent",
"instructions": "<string>",
"model": {
"providerId": "<string>",
"modelId": "<string>",
"variant": "<string>"
}
},
"executionTarget": "desktop",
"workspaceId": "<string>"
},
"latestRun": {
"id": "<string>",
"automationId": "<string>",
"revisionId": "<string>",
"trigger": "scheduled",
"scheduledFor": 4503599627370495,
"idempotencyKey": "<string>",
"status": "queued",
"leaseOwner": "<string>",
"leaseExpiresAt": 4503599627370495,
"heartbeatAt": 4503599627370495,
"attemptCount": 1,
"executionTarget": "desktop",
"executionThread": {
"id": "<string>",
"threadKind": "automation",
"executionLocation": "desktop",
"automationId": "<string>",
"automationRunId": "<string>",
"engineKind": "<string>",
"nativeThreadId": "<string>",
"workspaceId": "<string>"
},
"providerId": "<string>",
"modelId": "<string>",
"startedAt": 4503599627370495,
"finishedAt": 4503599627370495,
"error": {
"code": "owner_membership_lost",
"message": "<string>",
"retryable": true
},
"resultSummary": "<string>",
"usage": {
"inputTokens": 4503599627370495,
"outputTokens": 4503599627370495,
"costMicros": 4503599627370495
},
"createdAt": 4503599627370495,
"updatedAt": 4503599627370495,
"modelVariant": "<string>",
"codemodeReceiptId": "<string>",
"validatedResult": "<unknown>",
"triggerContext": {
"kind": "calendar_meeting",
"eventId": "<string>",
"title": "<string>",
"start": 4503599627370495,
"end": 4503599627370495,
"attendeeDomains": [
"<string>"
],
"externalAttendees": 4503599627370495,
"link": "<string>"
}
}
}{
"error": "openwork_web_access_required",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Automations
Activate an Automation
Den schedules Automations and keeps durable run history. A Desktop Automation runs on any of the owner’s connected desktops (one pinned to a workspace, on a desktop that has it); a Cloud Automation runs in OpenWork Cloud. If no desktop runner is connected when a desktop occurrence is due, that occurrence is recorded as missed. Creation makes an Automation active immediately and uses the owner’s current OpenWork Connect integrations. Deactivation stops future runs but does not cancel a run already in progress.
POST
/
v1
/
automations
/
{id}
/
activate
Activate an Automation
curl --request POST \
--url https://api.openworklabs.com/v1/automations/{id}/activate \
--header 'x-api-key: <api-key>'import requests
url = "https://api.openworklabs.com/v1/automations/{id}/activate"
headers = {"x-api-key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.openworklabs.com/v1/automations/{id}/activate', 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/automations/{id}/activate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.openworklabs.com/v1/automations/{id}/activate"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("x-api-key", "<api-key>")
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/automations/{id}/activate")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/automations/{id}/activate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"automation": {
"id": "<string>",
"organizationId": "<string>",
"ownerMemberId": "<string>",
"name": "<string>",
"state": "active",
"currentRevisionId": "<string>",
"nextDueAt": 4503599627370495,
"latestRunAt": 4503599627370495,
"needsAttentionReason": {
"code": "owner_membership_lost",
"message": "<string>",
"occurredAt": 4503599627370495
},
"createdAt": 4503599627370495,
"updatedAt": 4503599627370495,
"archivedAt": 4503599627370495,
"latestSuccessfulRunId": "<string>",
"latestSuccessfulResult": "<unknown>"
},
"revision": {
"id": "<string>",
"automationId": "<string>",
"version": 123,
"instructions": "<string>",
"schedule": {
"kind": "once",
"timezone": "<string>",
"at": 4503599627370495
},
"model": {
"providerId": "<string>",
"modelId": "<string>",
"variant": "<string>"
},
"maximumRuntimeMs": 1805000,
"digest": "<string>",
"createdAt": 4503599627370495,
"action": {
"kind": "agent",
"instructions": "<string>",
"model": {
"providerId": "<string>",
"modelId": "<string>",
"variant": "<string>"
}
},
"executionTarget": "desktop",
"workspaceId": "<string>"
},
"latestRun": {
"id": "<string>",
"automationId": "<string>",
"revisionId": "<string>",
"trigger": "scheduled",
"scheduledFor": 4503599627370495,
"idempotencyKey": "<string>",
"status": "queued",
"leaseOwner": "<string>",
"leaseExpiresAt": 4503599627370495,
"heartbeatAt": 4503599627370495,
"attemptCount": 1,
"executionTarget": "desktop",
"executionThread": {
"id": "<string>",
"threadKind": "automation",
"executionLocation": "desktop",
"automationId": "<string>",
"automationRunId": "<string>",
"engineKind": "<string>",
"nativeThreadId": "<string>",
"workspaceId": "<string>"
},
"providerId": "<string>",
"modelId": "<string>",
"startedAt": 4503599627370495,
"finishedAt": 4503599627370495,
"error": {
"code": "owner_membership_lost",
"message": "<string>",
"retryable": true
},
"resultSummary": "<string>",
"usage": {
"inputTokens": 4503599627370495,
"outputTokens": 4503599627370495,
"costMicros": 4503599627370495
},
"createdAt": 4503599627370495,
"updatedAt": 4503599627370495,
"modelVariant": "<string>",
"codemodeReceiptId": "<string>",
"validatedResult": "<unknown>",
"triggerContext": {
"kind": "calendar_meeting",
"eventId": "<string>",
"title": "<string>",
"start": 4503599627370495,
"end": 4503599627370495,
"attendeeDomains": [
"<string>"
],
"externalAttendees": 4503599627370495,
"link": "<string>"
}
}
}{
"error": "openwork_web_access_required",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Authorizations
denApiKeybearerAuth
Was this page helpful?