Replace a procedure's contents
curl --request PATCH \
--url https://api.example.com/sop/{sop_id} \
--header 'Content-Type: application/json' \
--header 'x-user-id: <x-user-id>' \
--data '
{
"data": {
"name": "<string>",
"steps": [
{
"subject": "<string>",
"description": "<string>",
"executor": {
"agent_id": "<string>",
"session_key": "<string>"
},
"version": "v1",
"verifier": {
"agent": {
"agent_id": "<string>",
"session_key": "<string>"
},
"type": "agent",
"criteria": ""
},
"max_attempts": 3
}
],
"description": "",
"workspace_grain": "run",
"session_settings": {}
}
}
'import requests
url = "https://api.example.com/sop/{sop_id}"
payload = { "data": {
"name": "<string>",
"steps": [
{
"subject": "<string>",
"description": "<string>",
"executor": {
"agent_id": "<string>",
"session_key": "<string>"
},
"version": "v1",
"verifier": {
"agent": {
"agent_id": "<string>",
"session_key": "<string>"
},
"type": "agent",
"criteria": ""
},
"max_attempts": 3
}
],
"description": "",
"workspace_grain": "run",
"session_settings": {}
} }
headers = {
"x-user-id": "<x-user-id>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-user-id': '<x-user-id>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: {
name: '<string>',
steps: [
{
subject: '<string>',
description: '<string>',
executor: {agent_id: '<string>', session_key: '<string>'},
version: 'v1',
verifier: {
agent: {agent_id: '<string>', session_key: '<string>'},
type: 'agent',
criteria: ''
},
max_attempts: 3
}
],
description: '',
workspace_grain: 'run',
session_settings: {}
}
})
};
fetch('https://api.example.com/sop/{sop_id}', 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.example.com/sop/{sop_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
'name' => '<string>',
'steps' => [
[
'subject' => '<string>',
'description' => '<string>',
'executor' => [
'agent_id' => '<string>',
'session_key' => '<string>'
],
'version' => 'v1',
'verifier' => [
'agent' => [
'agent_id' => '<string>',
'session_key' => '<string>'
],
'type' => 'agent',
'criteria' => ''
],
'max_attempts' => 3
]
],
'description' => '',
'workspace_grain' => 'run',
'session_settings' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-user-id: <x-user-id>"
],
]);
$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.example.com/sop/{sop_id}"
payload := strings.NewReader("{\n \"data\": {\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"subject\": \"<string>\",\n \"description\": \"<string>\",\n \"executor\": {\n \"agent_id\": \"<string>\",\n \"session_key\": \"<string>\"\n },\n \"version\": \"v1\",\n \"verifier\": {\n \"agent\": {\n \"agent_id\": \"<string>\",\n \"session_key\": \"<string>\"\n },\n \"type\": \"agent\",\n \"criteria\": \"\"\n },\n \"max_attempts\": 3\n }\n ],\n \"description\": \"\",\n \"workspace_grain\": \"run\",\n \"session_settings\": {}\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-user-id", "<x-user-id>")
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.patch("https://api.example.com/sop/{sop_id}")
.header("x-user-id", "<x-user-id>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"subject\": \"<string>\",\n \"description\": \"<string>\",\n \"executor\": {\n \"agent_id\": \"<string>\",\n \"session_key\": \"<string>\"\n },\n \"version\": \"v1\",\n \"verifier\": {\n \"agent\": {\n \"agent_id\": \"<string>\",\n \"session_key\": \"<string>\"\n },\n \"type\": \"agent\",\n \"criteria\": \"\"\n },\n \"max_attempts\": 3\n }\n ],\n \"description\": \"\",\n \"workspace_grain\": \"run\",\n \"session_settings\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/sop/{sop_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-user-id"] = '<x-user-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"subject\": \"<string>\",\n \"description\": \"<string>\",\n \"executor\": {\n \"agent_id\": \"<string>\",\n \"session_key\": \"<string>\"\n },\n \"version\": \"v1\",\n \"verifier\": {\n \"agent\": {\n \"agent_id\": \"<string>\",\n \"session_key\": \"<string>\"\n },\n \"type\": \"agent\",\n \"criteria\": \"\"\n },\n \"max_attempts\": 3\n }\n ],\n \"description\": \"\",\n \"workspace_grain\": \"run\",\n \"session_settings\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"user_id": "<string>",
"data": {
"name": "<string>",
"steps": [
{
"subject": "<string>",
"description": "<string>",
"executor": {
"agent_id": "<string>",
"session_key": "<string>"
},
"version": "v1",
"verifier": {
"agent": {
"agent_id": "<string>",
"session_key": "<string>"
},
"type": "agent",
"criteria": ""
},
"max_attempts": 3
}
],
"description": "",
"workspace_grain": "run",
"session_settings": {}
},
"id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}sop
Replace a procedure's contents
Rewrite a procedure; runs keep the copy they started with.
Args:
sop_id (str):
The procedure to update.
body (UpdateSOPRequest):
The procedure as it should now read.
user_id (str):
Injected authenticated user id.
storage (StorageBase):
Injected storage backend.
Returns:
SOPRecord:
The procedure as stored.
Raises:
HTTPException:
422 if a run of it could not open its sessions.
PATCH
/
sop
/
{sop_id}
Replace a procedure's contents
curl --request PATCH \
--url https://api.example.com/sop/{sop_id} \
--header 'Content-Type: application/json' \
--header 'x-user-id: <x-user-id>' \
--data '
{
"data": {
"name": "<string>",
"steps": [
{
"subject": "<string>",
"description": "<string>",
"executor": {
"agent_id": "<string>",
"session_key": "<string>"
},
"version": "v1",
"verifier": {
"agent": {
"agent_id": "<string>",
"session_key": "<string>"
},
"type": "agent",
"criteria": ""
},
"max_attempts": 3
}
],
"description": "",
"workspace_grain": "run",
"session_settings": {}
}
}
'import requests
url = "https://api.example.com/sop/{sop_id}"
payload = { "data": {
"name": "<string>",
"steps": [
{
"subject": "<string>",
"description": "<string>",
"executor": {
"agent_id": "<string>",
"session_key": "<string>"
},
"version": "v1",
"verifier": {
"agent": {
"agent_id": "<string>",
"session_key": "<string>"
},
"type": "agent",
"criteria": ""
},
"max_attempts": 3
}
],
"description": "",
"workspace_grain": "run",
"session_settings": {}
} }
headers = {
"x-user-id": "<x-user-id>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-user-id': '<x-user-id>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: {
name: '<string>',
steps: [
{
subject: '<string>',
description: '<string>',
executor: {agent_id: '<string>', session_key: '<string>'},
version: 'v1',
verifier: {
agent: {agent_id: '<string>', session_key: '<string>'},
type: 'agent',
criteria: ''
},
max_attempts: 3
}
],
description: '',
workspace_grain: 'run',
session_settings: {}
}
})
};
fetch('https://api.example.com/sop/{sop_id}', 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.example.com/sop/{sop_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
'name' => '<string>',
'steps' => [
[
'subject' => '<string>',
'description' => '<string>',
'executor' => [
'agent_id' => '<string>',
'session_key' => '<string>'
],
'version' => 'v1',
'verifier' => [
'agent' => [
'agent_id' => '<string>',
'session_key' => '<string>'
],
'type' => 'agent',
'criteria' => ''
],
'max_attempts' => 3
]
],
'description' => '',
'workspace_grain' => 'run',
'session_settings' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-user-id: <x-user-id>"
],
]);
$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.example.com/sop/{sop_id}"
payload := strings.NewReader("{\n \"data\": {\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"subject\": \"<string>\",\n \"description\": \"<string>\",\n \"executor\": {\n \"agent_id\": \"<string>\",\n \"session_key\": \"<string>\"\n },\n \"version\": \"v1\",\n \"verifier\": {\n \"agent\": {\n \"agent_id\": \"<string>\",\n \"session_key\": \"<string>\"\n },\n \"type\": \"agent\",\n \"criteria\": \"\"\n },\n \"max_attempts\": 3\n }\n ],\n \"description\": \"\",\n \"workspace_grain\": \"run\",\n \"session_settings\": {}\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-user-id", "<x-user-id>")
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.patch("https://api.example.com/sop/{sop_id}")
.header("x-user-id", "<x-user-id>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"subject\": \"<string>\",\n \"description\": \"<string>\",\n \"executor\": {\n \"agent_id\": \"<string>\",\n \"session_key\": \"<string>\"\n },\n \"version\": \"v1\",\n \"verifier\": {\n \"agent\": {\n \"agent_id\": \"<string>\",\n \"session_key\": \"<string>\"\n },\n \"type\": \"agent\",\n \"criteria\": \"\"\n },\n \"max_attempts\": 3\n }\n ],\n \"description\": \"\",\n \"workspace_grain\": \"run\",\n \"session_settings\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/sop/{sop_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-user-id"] = '<x-user-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"name\": \"<string>\",\n \"steps\": [\n {\n \"subject\": \"<string>\",\n \"description\": \"<string>\",\n \"executor\": {\n \"agent_id\": \"<string>\",\n \"session_key\": \"<string>\"\n },\n \"version\": \"v1\",\n \"verifier\": {\n \"agent\": {\n \"agent_id\": \"<string>\",\n \"session_key\": \"<string>\"\n },\n \"type\": \"agent\",\n \"criteria\": \"\"\n },\n \"max_attempts\": 3\n }\n ],\n \"description\": \"\",\n \"workspace_grain\": \"run\",\n \"session_settings\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"user_id": "<string>",
"data": {
"name": "<string>",
"steps": [
{
"subject": "<string>",
"description": "<string>",
"executor": {
"agent_id": "<string>",
"session_key": "<string>"
},
"version": "v1",
"verifier": {
"agent": {
"agent_id": "<string>",
"session_key": "<string>"
},
"type": "agent",
"criteria": ""
},
"max_attempts": 3
}
],
"description": "",
"workspace_grain": "run",
"session_settings": {}
},
"id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Headers
Caller's user ID. Temporary header-based identity; will be replaced by JWT auth.
Path Parameters
Body
application/json
Request body for replacing a procedure's contents.
The procedure as it should now read.
Show child attributes
Show child attributes