Skip to main content
PATCH
/
run-templates
/
{run_template_id}
Update run template
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",
    "id": "abc123def456ghi789jklm",
    "display_name": "Updated Template Name",
    "description": "",
    "agent_id": "gk3jK9mPq2xRt5vW8yZaBc",
    "persona_id": "hL4kL0nQr3ySt6vX9zAcDd",
    "test_set_id": "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

X-API-Key
string
header
required

API key for authentication

Path Parameters

run_template_id
string
required

Run template resource ID

Pattern: ^[A-Za-z0-9]{22}$

Body

application/json

Partial update request (PATCH semantics - only provided fields are updated)

display_name
string

Human-readable template name

Required string length: 1 - 200
Example:

"Updated Template Name"

description
string

Optional description

Example:

"Updated description"

agent_id
string

Agent to test

Pattern: ^[A-Za-z0-9]{22}$
Example:

"gk3jK9mPq2xRt5vW8yZaBc"

persona_id
string

Simulated persona to use

Pattern: ^[A-Za-z0-9]{22}$
Example:

"hL4kL0nQr3ySt6vX9zAcDd"

test_set_id
string

Test set containing test cases

Pattern: ^[A-Za-z0-9]{8}$
Example:

"aB1cD2eF"

metric_ids
string[]

Metrics to evaluate (null = no change, [] = use agent defaults)

Example:
["iM5lM1oRs4zTu7wY0aBdEe"]
mutation_ids
string[]

Mutations for A/B testing (null = no change, [] = clear)

Example:
[]
iteration_count
integer

Number of times to run each test case

Required range: 1 <= x <= 100
Example:

5

concurrency
integer

Number of simulations to run concurrently

Required range: 1 <= x <= 50
Example:

10

sub_sample_size
integer

Number of test cases to randomly sample

Required range: x >= 0
Example:

20

sub_sample_seed
integer | null

Random seed for reproducible sub-sampling

Example:

123456

metadata
object

Custom metadata (null = no change, {} = clear)

Example:
{ "updated": true }
tags
string[] | null

Tags to associate with this run template. Null or omitted leaves tags unchanged. Pass [] to clear all tags.

Example:
["nightly"]

Response

Run template updated successfully

run_template
object
required

Run template configuration resource.