Retrieve a named simulation attribute
curl --request GET \
--url https://api.coval.dev/v1/simulations/{simulation_id}/attributes/{attribute_name} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.coval.dev/v1/simulations/{simulation_id}/attributes/{attribute_name}"
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/simulations/{simulation_id}/attributes/{attribute_name}', 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/simulations/{simulation_id}/attributes/{attribute_name}",
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/simulations/{simulation_id}/attributes/{attribute_name}"
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/simulations/{simulation_id}/attributes/{attribute_name}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coval.dev/v1/simulations/{simulation_id}/attributes/{attribute_name}")
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"pro"Simulated Conversations
Retrieve a named simulation attribute
Returns an exact, case-sensitive top-level attribute from the simulation's
current active test case. Names are literal keys, including dots, rather
than paths. URL-encode names when necessary.
Requires simulations:read permission. The simulation, run, test case and
test set must be accessible in the authenticated organization and workspace.
A resolved workspace is required. Select one with X-Coval-Workspace-Id
when the organization has no default workspace. Legacy unassigned rows
are accessible only through the default workspace.
Monitoring conversations and deleted runs are excluded. This endpoint can
be used while a simulation is running or after it finishes.
JSON values return directly without an envelope. Null is a successful JSON
value, while an absent attribute returns 404. Changes to the test case are
visible on subsequent requests. This endpoint does not capture a snapshot
or persist tool-call events.
An object with type: image_ref is reserved for image references and must
contain attachment: <name>, matching exactly one media attachment on the
test case. Image responses contain raw PNG/JPEG bytes, with a maximum size
of 4 MiB. Ordinary objects without that marker return unchanged.
This deliberately returns content instead of an AIP-131 resource envelope:
customer tool handlers consume the fixture directly, including image bytes.
Both JSON and image response content are limited to 4 MiB.
GET
/
simulations
/
{simulation_id}
/
attributes
/
{attribute_name}
Retrieve a named simulation attribute
curl --request GET \
--url https://api.coval.dev/v1/simulations/{simulation_id}/attributes/{attribute_name} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.coval.dev/v1/simulations/{simulation_id}/attributes/{attribute_name}"
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/simulations/{simulation_id}/attributes/{attribute_name}', 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/simulations/{simulation_id}/attributes/{attribute_name}",
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/simulations/{simulation_id}/attributes/{attribute_name}"
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/simulations/{simulation_id}/attributes/{attribute_name}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coval.dev/v1/simulations/{simulation_id}/attributes/{attribute_name}")
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"pro"Authorizations
API key for authentication.
Path Parameters
Maximum string length:
512Maximum string length:
512Response
object | null | any[] | string | number | boolean
The attribute value or referenced image. Responses use Cache-Control no-store.
Any native JSON value. Null is a present attribute value.
Was this page helpful?