curl --request PUT \
--url https://api.openworklabs.com/v1/org/workbot-settings/teams/{teamId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"model": {
"inherit": true
},
"name": {
"inherit": true
},
"enabled": {
"inherit": true
},
"maxSteps": {
"inherit": true
}
}
'import requests
url = "https://api.openworklabs.com/v1/org/workbot-settings/teams/{teamId}"
payload = {
"model": { "inherit": True },
"name": { "inherit": True },
"enabled": { "inherit": True },
"maxSteps": { "inherit": True }
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
model: {inherit: true},
name: {inherit: true},
enabled: {inherit: true},
maxSteps: {inherit: true}
})
};
fetch('https://api.openworklabs.com/v1/org/workbot-settings/teams/{teamId}', 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/org/workbot-settings/teams/{teamId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'model' => [
'inherit' => true
],
'name' => [
'inherit' => true
],
'enabled' => [
'inherit' => true
],
'maxSteps' => [
'inherit' => true
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.openworklabs.com/v1/org/workbot-settings/teams/{teamId}"
payload := strings.NewReader("{\n \"model\": {\n \"inherit\": true\n },\n \"name\": {\n \"inherit\": true\n },\n \"enabled\": {\n \"inherit\": true\n },\n \"maxSteps\": {\n \"inherit\": true\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.put("https://api.openworklabs.com/v1/org/workbot-settings/teams/{teamId}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"model\": {\n \"inherit\": true\n },\n \"name\": {\n \"inherit\": true\n },\n \"enabled\": {\n \"inherit\": true\n },\n \"maxSteps\": {\n \"inherit\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/org/workbot-settings/teams/{teamId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"model\": {\n \"inherit\": true\n },\n \"name\": {\n \"inherit\": true\n },\n \"enabled\": {\n \"inherit\": true\n },\n \"maxSteps\": {\n \"inherit\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"organization": {
"model": "<string>",
"name": "<string>",
"enabled": true,
"maxSteps": 50000
},
"teams": [
{
"teamId": "<string>",
"teamName": "<string>",
"memberCount": 4503599627370495,
"model": {
"inherit": true
},
"name": {
"inherit": true
},
"enabled": {
"inherit": true
},
"conflictingMemberCount": 4503599627370495,
"maxSteps": {
"inherit": true
}
}
],
"canEdit": true
}{
"error": "unknown_model",
"message": "<string>"
}{
"error": "unauthorized"
}{
"error": "forbidden",
"reason": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "workbot_runner_unavailable",
"message": "<string>"
}Set a team's Workbot settings
Changes one team’s Workbot default model, Workbot name, whether Workbot is on for the team (enabled), or several; a setting left out is kept. For each, { inherit: true } makes the team use the organization’s value again and { inherit: false, value } sets the team’s own: a model from the caller’s supported, credential-ready AI Gateway models (null is the deployment’s default model), a name of 1 to 40 characters, or true or false for enabled. With Workbot’s step limit on (workbotStepLimit), maxSteps sets how many model calls Workbot may make on one request for the team’s members (1–100,000; null is the deployment’s default, 0 is no limit), from each chat’s next message; without it maxSteps answers 400. The team’s members get it from their next message or run, in Workbot, the Slack assistant and cloud Automations set to the cloud default; a member on several teams whose own values differ gets the organization’s. enabled covers the Workbot app and Your agent only, never the Slack assistant, Automations or the desktop app. A team’s model selects a model and never grants access to it. Requires the Manage OpenWork Models permission, which also governs the team’s Workbot name and switch, a recent sign-in and the Workbot settings per team feature.
curl --request PUT \
--url https://api.openworklabs.com/v1/org/workbot-settings/teams/{teamId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"model": {
"inherit": true
},
"name": {
"inherit": true
},
"enabled": {
"inherit": true
},
"maxSteps": {
"inherit": true
}
}
'import requests
url = "https://api.openworklabs.com/v1/org/workbot-settings/teams/{teamId}"
payload = {
"model": { "inherit": True },
"name": { "inherit": True },
"enabled": { "inherit": True },
"maxSteps": { "inherit": True }
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
model: {inherit: true},
name: {inherit: true},
enabled: {inherit: true},
maxSteps: {inherit: true}
})
};
fetch('https://api.openworklabs.com/v1/org/workbot-settings/teams/{teamId}', 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/org/workbot-settings/teams/{teamId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'model' => [
'inherit' => true
],
'name' => [
'inherit' => true
],
'enabled' => [
'inherit' => true
],
'maxSteps' => [
'inherit' => true
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.openworklabs.com/v1/org/workbot-settings/teams/{teamId}"
payload := strings.NewReader("{\n \"model\": {\n \"inherit\": true\n },\n \"name\": {\n \"inherit\": true\n },\n \"enabled\": {\n \"inherit\": true\n },\n \"maxSteps\": {\n \"inherit\": true\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.put("https://api.openworklabs.com/v1/org/workbot-settings/teams/{teamId}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"model\": {\n \"inherit\": true\n },\n \"name\": {\n \"inherit\": true\n },\n \"enabled\": {\n \"inherit\": true\n },\n \"maxSteps\": {\n \"inherit\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openworklabs.com/v1/org/workbot-settings/teams/{teamId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"model\": {\n \"inherit\": true\n },\n \"name\": {\n \"inherit\": true\n },\n \"enabled\": {\n \"inherit\": true\n },\n \"maxSteps\": {\n \"inherit\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"organization": {
"model": "<string>",
"name": "<string>",
"enabled": true,
"maxSteps": 50000
},
"teams": [
{
"teamId": "<string>",
"teamName": "<string>",
"memberCount": 4503599627370495,
"model": {
"inherit": true
},
"name": {
"inherit": true
},
"enabled": {
"inherit": true
},
"conflictingMemberCount": 4503599627370495,
"maxSteps": {
"inherit": true
}
}
],
"canEdit": true
}{
"error": "unknown_model",
"message": "<string>"
}{
"error": "unauthorized"
}{
"error": "forbidden",
"reason": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "workbot_runner_unavailable",
"message": "<string>"
}Authorizations
Organization API key passed as the x-api-key header. The raw key is the header value; do not prefix it with Bearer.
Path Parameters
Den TypeID with 'tem_' prefix and a 26-character base32 suffix.
30Body
Was this page helpful?