Skip to main content
GET
/
v1
/
templates
List templates
curl --request GET \
  --url https://api.coval.dev/v1/templates \
  --header 'X-API-Key: <api-key>'
import requests

url = "https://api.coval.dev/v1/templates"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.coval.dev/v1/templates', 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/templates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.coval.dev/v1/templates"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.coval.dev/v1/templates")
  .header("X-API-Key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.coval.dev/v1/templates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "templates": [
    {
      "id": "abc123def456ghi789jklm",
      "name": "templates/abc123def456ghi789jklm",
      "template_name": "Customer Support Voice Template",
      "description": "Standard voice simulation template",
      "simulation_type": "SIMULATOR_VOICE",
      "simulation_metadata": {
        "greeting": "Hello, how can I help you?"
      },
      "simulated_user_prompt": "You are a customer calling about a delayed delivery...",
      "agent_id": "3zfmuDbVQsi4GaseDtiVcS",
      "enabled_metrics": [
        "metric_abc123"
      ],
      "persona_ids": [
        "persona_xyz789"
      ],
      "test_set_id": null,
      "iteration_count": 10,
      "concurrency": 5,
      "sub_sample_size": null,
      "test_case_params_by_iteration": [],
      "create_time": "2025-10-14T12:00:00Z",
      "update_time": "2025-10-15T14:30:00Z"
    }
  ],
  "next_page_token": "eyJvZmZzZXQiOjUwfQ=="
}

Authorizations

​
X-API-Key
string
header
required

API key for authentication

Query Parameters

​
filter
string

Supported fields: simulation_type, template_name, agent_id, create_time, update_time

Operators: =, !=, >, <, >=, <=, AND, OR

Date format: ISO 8601 (e.g., 2025-10-01T00:00:00Z)

​
page_size
integer
default:50

Maximum number of results per page

Required range: 1 <= x <= 100
​
page_token
string

Opaque pagination token from previous response.

Do not decode or modify this token.

​
order_by
string
default:-create_time

Sort order specification.

Formats:

  1. Dash-prefix: -create_time (descending), template_name (ascending)
  2. Space-separated: create_time desc, template_name asc

Sortable fields: create_time, update_time, template_name, simulation_type

Response

Templates retrieved successfully

​
templates
object[]
required

List of template resources

​
next_page_token
string | null

Token for fetching next page (null if no more results)

Example:

"eyJvZmZzZXQiOjUwfQ=="