curl --request PATCH \
--url https://app.harmonica.chat/api/v1/templates/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"description": "<string>",
"icon": "<string>",
"facilitation_prompt": "<string>",
"default_session_name": "<string>",
"default_goal": "<string>",
"default_critical": "<string>",
"default_context": "<string>",
"is_public": true,
"force": true
}
'import requests
url = "https://app.harmonica.chat/api/v1/templates/{id}"
payload = {
"title": "<string>",
"description": "<string>",
"icon": "<string>",
"facilitation_prompt": "<string>",
"default_session_name": "<string>",
"default_goal": "<string>",
"default_critical": "<string>",
"default_context": "<string>",
"is_public": True,
"force": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
description: '<string>',
icon: '<string>',
facilitation_prompt: '<string>',
default_session_name: '<string>',
default_goal: '<string>',
default_critical: '<string>',
default_context: '<string>',
is_public: true,
force: true
})
};
fetch('https://app.harmonica.chat/api/v1/templates/{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://app.harmonica.chat/api/v1/templates/{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([
'title' => '<string>',
'description' => '<string>',
'icon' => '<string>',
'facilitation_prompt' => '<string>',
'default_session_name' => '<string>',
'default_goal' => '<string>',
'default_critical' => '<string>',
'default_context' => '<string>',
'is_public' => true,
'force' => true
]),
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://app.harmonica.chat/api/v1/templates/{id}"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"facilitation_prompt\": \"<string>\",\n \"default_session_name\": \"<string>\",\n \"default_goal\": \"<string>\",\n \"default_critical\": \"<string>\",\n \"default_context\": \"<string>\",\n \"is_public\": true,\n \"force\": true\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://app.harmonica.chat/api/v1/templates/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"facilitation_prompt\": \"<string>\",\n \"default_session_name\": \"<string>\",\n \"default_goal\": \"<string>\",\n \"default_critical\": \"<string>\",\n \"default_context\": \"<string>\",\n \"is_public\": true,\n \"force\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.harmonica.chat/api/v1/templates/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"facilitation_prompt\": \"<string>\",\n \"default_session_name\": \"<string>\",\n \"default_goal\": \"<string>\",\n \"default_critical\": \"<string>\",\n \"default_context\": \"<string>\",\n \"is_public\": true,\n \"force\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"template_type": "<string>",
"cross_pollination_default": true,
"is_public": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"icon": "<string>",
"facilitation_prompt": "<string>",
"default_session_name": "<string>",
"default_goal": "<string>",
"default_critical": "<string>",
"default_context": "<string>",
"chain_config": {
"steps": [
{
"id": "<string>",
"title": "<string>",
"description": "<string>",
"facilitation_prompt": "<string>",
"default_session_name": "<string>",
"context_mode": "none",
"context_template": "<string>",
"individual_memory": true,
"roles": [
{
"slug": "<string>",
"label": "<string>",
"weight": "normal"
}
],
"assignment_strategy": "explicit",
"completion_criteria": {
"type": "host_continue"
},
"dimension_ownership": [
"<string>"
],
"pre_survey_config": [
{
"key": "<string>",
"label": "<string>",
"type": "Short field",
"required": true,
"options": [
"<string>"
],
"derive_options_from": "previous_step"
}
]
}
],
"output_artifact": "wardley",
"project_summary_prompt": "<string>"
},
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_by": "<string>",
"archived_at": "2023-11-07T05:31:56Z",
"source_provenance": {
"spec_id": "<string>",
"spec_version": "<string>",
"registry": "<string>",
"install_hash": "<string>",
"installed_at": "2023-11-07T05:31:56Z",
"installed_by": "<string>"
}
}{
"error": {
"code": "unauthorized",
"message": "<string>"
}
}{
"error": {
"code": "unauthorized",
"message": "Invalid or missing API key"
}
}{
"error": {
"code": "unauthorized",
"message": "<string>"
}
}{
"error": {
"code": "unauthorized",
"message": "<string>"
}
}Update template
Updates a template. Caller must be the owner, a workspace admin (for workspace-scoped templates), or a global admin.
Set template_type: chain with a chain_config to convert a single
template into a chain, or send chain_config to edit an existing
chain (HAR-1098). Subject to the same per-plan step cap as chain launch.
curl --request PATCH \
--url https://app.harmonica.chat/api/v1/templates/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"description": "<string>",
"icon": "<string>",
"facilitation_prompt": "<string>",
"default_session_name": "<string>",
"default_goal": "<string>",
"default_critical": "<string>",
"default_context": "<string>",
"is_public": true,
"force": true
}
'import requests
url = "https://app.harmonica.chat/api/v1/templates/{id}"
payload = {
"title": "<string>",
"description": "<string>",
"icon": "<string>",
"facilitation_prompt": "<string>",
"default_session_name": "<string>",
"default_goal": "<string>",
"default_critical": "<string>",
"default_context": "<string>",
"is_public": True,
"force": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
description: '<string>',
icon: '<string>',
facilitation_prompt: '<string>',
default_session_name: '<string>',
default_goal: '<string>',
default_critical: '<string>',
default_context: '<string>',
is_public: true,
force: true
})
};
fetch('https://app.harmonica.chat/api/v1/templates/{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://app.harmonica.chat/api/v1/templates/{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([
'title' => '<string>',
'description' => '<string>',
'icon' => '<string>',
'facilitation_prompt' => '<string>',
'default_session_name' => '<string>',
'default_goal' => '<string>',
'default_critical' => '<string>',
'default_context' => '<string>',
'is_public' => true,
'force' => true
]),
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://app.harmonica.chat/api/v1/templates/{id}"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"facilitation_prompt\": \"<string>\",\n \"default_session_name\": \"<string>\",\n \"default_goal\": \"<string>\",\n \"default_critical\": \"<string>\",\n \"default_context\": \"<string>\",\n \"is_public\": true,\n \"force\": true\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://app.harmonica.chat/api/v1/templates/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"facilitation_prompt\": \"<string>\",\n \"default_session_name\": \"<string>\",\n \"default_goal\": \"<string>\",\n \"default_critical\": \"<string>\",\n \"default_context\": \"<string>\",\n \"is_public\": true,\n \"force\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.harmonica.chat/api/v1/templates/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"facilitation_prompt\": \"<string>\",\n \"default_session_name\": \"<string>\",\n \"default_goal\": \"<string>\",\n \"default_critical\": \"<string>\",\n \"default_context\": \"<string>\",\n \"is_public\": true,\n \"force\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"template_type": "<string>",
"cross_pollination_default": true,
"is_public": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"icon": "<string>",
"facilitation_prompt": "<string>",
"default_session_name": "<string>",
"default_goal": "<string>",
"default_critical": "<string>",
"default_context": "<string>",
"chain_config": {
"steps": [
{
"id": "<string>",
"title": "<string>",
"description": "<string>",
"facilitation_prompt": "<string>",
"default_session_name": "<string>",
"context_mode": "none",
"context_template": "<string>",
"individual_memory": true,
"roles": [
{
"slug": "<string>",
"label": "<string>",
"weight": "normal"
}
],
"assignment_strategy": "explicit",
"completion_criteria": {
"type": "host_continue"
},
"dimension_ownership": [
"<string>"
],
"pre_survey_config": [
{
"key": "<string>",
"label": "<string>",
"type": "Short field",
"required": true,
"options": [
"<string>"
],
"derive_options_from": "previous_step"
}
]
}
],
"output_artifact": "wardley",
"project_summary_prompt": "<string>"
},
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_by": "<string>",
"archived_at": "2023-11-07T05:31:56Z",
"source_provenance": {
"spec_id": "<string>",
"spec_version": "<string>",
"registry": "<string>",
"install_hash": "<string>",
"installed_at": "2023-11-07T05:31:56Z",
"installed_by": "<string>"
}
}{
"error": {
"code": "unauthorized",
"message": "<string>"
}
}{
"error": {
"code": "unauthorized",
"message": "Invalid or missing API key"
}
}{
"error": {
"code": "unauthorized",
"message": "<string>"
}
}{
"error": {
"code": "unauthorized",
"message": "<string>"
}
}Authorizations
API key authentication. Pass your key as a Bearer token.
Keys use the format hm_live_<32 hex chars>.
Generate keys from your Harmonica dashboard settings.
Path Parameters
Body
All fields optional; at least one must be provided.
Set to 'chain' to convert a single template into a chain (chain_config required) (HAR-1098).
single, chain Multi-step chain definition (used when template_type is 'chain'). Validated server-side (HAR-915): at least one step, unique step ids, valid role / assignment / completion shapes.
Show child attributes
Show child attributes
Spec identity for a registry re-install; the server stamps install_hash + timestamps (HAR-1108).
Show child attributes
Show child attributes
Overwrite a template that has local edits since install (HAR-1108).
Response
Updated template
single or chain
Chain definition for chain templates; null for single templates (HAR-1098).
Show child attributes
Show child attributes
Provenance for a template installed from the OFL method-specs registry; null for admin-authored templates (HAR-1108).
Show child attributes
Show child attributes