curl --request PATCH \
--url https://api.coval.dev/v1/run-templates/{run_template_id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"display_name": "Updated Template Name",
"iteration_count": 5,
"metadata": {
"updated": true
}
}
'import requests
url = "https://api.coval.dev/v1/run-templates/{run_template_id}"
payload = {
"display_name": "Updated Template Name",
"iteration_count": 5,
"metadata": { "updated": True }
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
display_name: 'Updated Template Name',
iteration_count: 5,
metadata: {updated: true}
})
};
fetch('https://api.coval.dev/v1/run-templates/{run_template_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.coval.dev/v1/run-templates/{run_template_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([
'display_name' => 'Updated Template Name',
'iteration_count' => 5,
'metadata' => [
'updated' => 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.coval.dev/v1/run-templates/{run_template_id}"
payload := strings.NewReader("{\n \"display_name\": \"Updated Template Name\",\n \"iteration_count\": 5,\n \"metadata\": {\n \"updated\": true\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.coval.dev/v1/run-templates/{run_template_id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"display_name\": \"Updated Template Name\",\n \"iteration_count\": 5,\n \"metadata\": {\n \"updated\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coval.dev/v1/run-templates/{run_template_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"display_name\": \"Updated Template Name\",\n \"iteration_count\": 5,\n \"metadata\": {\n \"updated\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"run_template": {
"name": "run-templates/abc123def456ghi789jklm",
"created_at": "2025-10-14T12:00:00Z",
"created_by": "01J000000000000000000000001",
"updated_at": "2025-10-15T14:30:00Z",
"updated_by": "01J000000000000000000000002",
"id": "abc123def456ghi789jklm",
"display_name": "Updated Template Name",
"description": "",
"agent_ids": [
"gk3jK9mPq2xRt5vW8yZaBc"
],
"persona_ids": [
"hL4kL0nQr3ySt6vX9zAcDd"
],
"test_set_ids": [
"aB1cD2eF"
],
"metric_ids": [],
"mutation_ids": [],
"iteration_count": 5,
"concurrency": 1,
"sub_sample_size": 0,
"sub_sample_seed": null,
"metadata": {
"updated": true
},
"create_time": "2025-10-14T12:00:00Z",
"update_time": "2025-10-15T14:30:00Z"
}
}{
"error": {
"code": "INVALID_ARGUMENT",
"message": "Invalid request parameter",
"details": [
{
"field": "agent_id",
"description": "Agent not found or not accessible"
}
]
}
}{
"error": {
"code": "UNAUTHENTICATED",
"message": "Authentication failed",
"details": [
{
"field": "X-API-Key",
"description": "Invalid or missing API key"
}
]
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Template not found",
"details": [
{
"field": "run_template_id",
"description": "Run template not found or not accessible by your organization"
}
]
}
}{
"error": {
"code": "INTERNAL",
"message": "Internal server error",
"details": [
{
"description": "An unexpected error occurred"
}
]
}
}Update run template
Update specific fields of an existing run template. Only provided fields are updated.
curl --request PATCH \
--url https://api.coval.dev/v1/run-templates/{run_template_id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"display_name": "Updated Template Name",
"iteration_count": 5,
"metadata": {
"updated": true
}
}
'import requests
url = "https://api.coval.dev/v1/run-templates/{run_template_id}"
payload = {
"display_name": "Updated Template Name",
"iteration_count": 5,
"metadata": { "updated": True }
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
display_name: 'Updated Template Name',
iteration_count: 5,
metadata: {updated: true}
})
};
fetch('https://api.coval.dev/v1/run-templates/{run_template_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.coval.dev/v1/run-templates/{run_template_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([
'display_name' => 'Updated Template Name',
'iteration_count' => 5,
'metadata' => [
'updated' => 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.coval.dev/v1/run-templates/{run_template_id}"
payload := strings.NewReader("{\n \"display_name\": \"Updated Template Name\",\n \"iteration_count\": 5,\n \"metadata\": {\n \"updated\": true\n }\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.coval.dev/v1/run-templates/{run_template_id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"display_name\": \"Updated Template Name\",\n \"iteration_count\": 5,\n \"metadata\": {\n \"updated\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coval.dev/v1/run-templates/{run_template_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"display_name\": \"Updated Template Name\",\n \"iteration_count\": 5,\n \"metadata\": {\n \"updated\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"run_template": {
"name": "run-templates/abc123def456ghi789jklm",
"created_at": "2025-10-14T12:00:00Z",
"created_by": "01J000000000000000000000001",
"updated_at": "2025-10-15T14:30:00Z",
"updated_by": "01J000000000000000000000002",
"id": "abc123def456ghi789jklm",
"display_name": "Updated Template Name",
"description": "",
"agent_ids": [
"gk3jK9mPq2xRt5vW8yZaBc"
],
"persona_ids": [
"hL4kL0nQr3ySt6vX9zAcDd"
],
"test_set_ids": [
"aB1cD2eF"
],
"metric_ids": [],
"mutation_ids": [],
"iteration_count": 5,
"concurrency": 1,
"sub_sample_size": 0,
"sub_sample_seed": null,
"metadata": {
"updated": true
},
"create_time": "2025-10-14T12:00:00Z",
"update_time": "2025-10-15T14:30:00Z"
}
}{
"error": {
"code": "INVALID_ARGUMENT",
"message": "Invalid request parameter",
"details": [
{
"field": "agent_id",
"description": "Agent not found or not accessible"
}
]
}
}{
"error": {
"code": "UNAUTHENTICATED",
"message": "Authentication failed",
"details": [
{
"field": "X-API-Key",
"description": "Invalid or missing API key"
}
]
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Template not found",
"details": [
{
"field": "run_template_id",
"description": "Run template not found or not accessible by your organization"
}
]
}
}{
"error": {
"code": "INTERNAL",
"message": "Internal server error",
"details": [
{
"description": "An unexpected error occurred"
}
]
}
}Authorizations
API key for authentication
Headers
Workspace that scopes this operation. When omitted, the organization's active default workspace is used when one can be resolved.
1 - 26Path Parameters
Run template resource ID
^[A-Za-z0-9]{22}$Body
Partial update request (PATCH semantics - only provided fields are updated)
Human-readable template name
1 - 200"Updated Template Name"
Optional description
"Updated description"
Agents to test. Omit to leave unchanged.
1^[A-Za-z0-9]{22}$["gk3jK9mPq2xRt5vW8yZaBc"]
Simulated personas to use. Omit to leave unchanged.
1^[A-Za-z0-9]{22}$["hL4kL0nQr3ySt6vX9zAcDd"]
Test sets containing test cases. Omit to leave unchanged.
1^[A-Za-z0-9]{8}$["aB1cD2eF"]
Metrics to evaluate (null = no change, [] = use agent defaults)
["iM5lM1oRs4zTu7wY0aBdEe"]
Mutations for A/B testing (null = no change, [] = clear)
[]
Number of times to run each test case
1 <= x <= 1005
Number of simulations to run concurrently
1 <= x <= 5010
Number of test cases to randomly sample
x >= 020
Random seed for reproducible sub-sampling
123456
Optional test cases to run from the selected test sets
1 - 100 elementsCustom metadata (null = no change, {} = clear)
{ "updated": true }
Tags to associate with this run template. Null or omitted leaves tags unchanged. Pass [] to clear all tags.
["nightly"]
Response
Run template updated successfully
Run template configuration resource.
Show child attributes
Show child attributes
Was this page helpful?