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

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

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/personas', 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/personas",
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/personas"

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/personas")
.header("X-API-Key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

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

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
{
  "personas": [
    {
      "resource_name": "personas/3zfmuDbVQsi4GaseDtiVcS",
      "id": "3zfmuDbVQsi4GaseDtiVcS",
      "name": "Friendly Customer",
      "create_time": "2025-01-24T10:00:00Z",
      "persona_prompt": "You are a friendly customer calling for technical support...",
      "voice_name": "aria",
      "language_code": "en-US",
      "background_sound": "office",
      "background_sound_volume": 0.3,
      "voice_volume": 1.25,
      "voice_speed": 0.85,
      "wait_seconds": 0.5,
      "conversation_initiation": "speak_first",
      "multi_language_stt": true,
      "hold_music_timeout_seconds": 15,
      "tags": [
        "voice",
        "english"
      ],
      "update_time": "2025-01-24T12:30:00Z"
    }
  ],
  "next_page_token": "eyJvZmZzZXQiOjUwfQ=="
}
{
"error": {
"code": "INVALID_ARGUMENT",
"message": "Invalid language_code 'en-ZZ'"
}
}
{
"error": {
"code": "UNAUTHENTICATED",
"message": "Missing or invalid API key"
}
}
{
"error": {
"code": "INTERNAL",
"message": "An unexpected error occurred"
}
}

Authorizations

X-API-Key
string
header
required

API key for authentication

Query Parameters

page_size
integer
default:50

Maximum number of personas to return (1-100)

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

Token for retrieving the next page of results

filter
string

Filter expression syntax.

Values may be unquoted or double-quoted. Values containing spaces must be quoted.

Supported fields:

  • name: Filter by persona name (e.g., name=Customer or name="Customer Support")
  • create_time: Filter by creation time (e.g., create_time>"2025-01-01T00:00:00Z")
  • update_time: Filter by update time

Examples:

  • name="Customer Support" (quoted - contains space)
  • create_time>"2025-01-01T00:00:00Z"
order_by
string

Field to order results by.

Supported fields: create_time, update_time, name

Formats:

  • Dash prefix: -create_time (descending)
  • Space separated: create_time desc (descending)
  • No prefix: create_time (ascending)
Example:

"-create_time"

tag_filters
string[]

Filter personas by tags. A resource matches when it has ALL the listed tags (AND-semantics).

Repeat the parameter for each tag (e.g., ?tag_filters=production&tag_filters=voice).

Maximum array length: 20

Response

Successful response

personas
object[]
required
next_page_token
string | null

Token for next page (null if no more pages)

Example:

"eyJvZmZzZXQiOjUwfQ=="