Create Custom Eval
curl --request POST \
--url https://api.lightsage.com/v1/api-performance/custom-evals \
--header 'Content-Type: application/json' \
--header 'X-Lightsage-Api-Key: <api-key>' \
--data '
{
"prompt": "<string>",
"prompt_template": "<string>",
"category_name": "<string>",
"description": "<string>",
"tag": "<string>",
"competitor": "<string>",
"prompt_competitor_group": "<string>",
"eval": {
"custom_prompt": "<string>",
"expected_behavior": "<string>",
"starting_project_id": "<string>",
"include_env_vars": true,
"env_profile_ids": [
"<string>"
],
"model_ids": [
"<string>"
],
"compare_skills": true,
"skill_ids": [
"<string>"
],
"mcp_enabled": true,
"run_context": {},
"enabled": true
}
}
'import requests
url = "https://api.lightsage.com/v1/api-performance/custom-evals"
payload = {
"prompt": "<string>",
"prompt_template": "<string>",
"category_name": "<string>",
"description": "<string>",
"tag": "<string>",
"competitor": "<string>",
"prompt_competitor_group": "<string>",
"eval": {
"custom_prompt": "<string>",
"expected_behavior": "<string>",
"starting_project_id": "<string>",
"include_env_vars": True,
"env_profile_ids": ["<string>"],
"model_ids": ["<string>"],
"compare_skills": True,
"skill_ids": ["<string>"],
"mcp_enabled": True,
"run_context": {},
"enabled": True
}
}
headers = {
"X-Lightsage-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Lightsage-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
prompt: '<string>',
prompt_template: '<string>',
category_name: '<string>',
description: '<string>',
tag: '<string>',
competitor: '<string>',
prompt_competitor_group: '<string>',
eval: {
custom_prompt: '<string>',
expected_behavior: '<string>',
starting_project_id: '<string>',
include_env_vars: true,
env_profile_ids: ['<string>'],
model_ids: ['<string>'],
compare_skills: true,
skill_ids: ['<string>'],
mcp_enabled: true,
run_context: {},
enabled: true
}
})
};
fetch('https://api.lightsage.com/v1/api-performance/custom-evals', 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.lightsage.com/v1/api-performance/custom-evals",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'prompt' => '<string>',
'prompt_template' => '<string>',
'category_name' => '<string>',
'description' => '<string>',
'tag' => '<string>',
'competitor' => '<string>',
'prompt_competitor_group' => '<string>',
'eval' => [
'custom_prompt' => '<string>',
'expected_behavior' => '<string>',
'starting_project_id' => '<string>',
'include_env_vars' => true,
'env_profile_ids' => [
'<string>'
],
'model_ids' => [
'<string>'
],
'compare_skills' => true,
'skill_ids' => [
'<string>'
],
'mcp_enabled' => true,
'run_context' => [
],
'enabled' => true
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Lightsage-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.lightsage.com/v1/api-performance/custom-evals"
payload := strings.NewReader("{\n \"prompt\": \"<string>\",\n \"prompt_template\": \"<string>\",\n \"category_name\": \"<string>\",\n \"description\": \"<string>\",\n \"tag\": \"<string>\",\n \"competitor\": \"<string>\",\n \"prompt_competitor_group\": \"<string>\",\n \"eval\": {\n \"custom_prompt\": \"<string>\",\n \"expected_behavior\": \"<string>\",\n \"starting_project_id\": \"<string>\",\n \"include_env_vars\": true,\n \"env_profile_ids\": [\n \"<string>\"\n ],\n \"model_ids\": [\n \"<string>\"\n ],\n \"compare_skills\": true,\n \"skill_ids\": [\n \"<string>\"\n ],\n \"mcp_enabled\": true,\n \"run_context\": {},\n \"enabled\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Lightsage-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.post("https://api.lightsage.com/v1/api-performance/custom-evals")
.header("X-Lightsage-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"prompt\": \"<string>\",\n \"prompt_template\": \"<string>\",\n \"category_name\": \"<string>\",\n \"description\": \"<string>\",\n \"tag\": \"<string>\",\n \"competitor\": \"<string>\",\n \"prompt_competitor_group\": \"<string>\",\n \"eval\": {\n \"custom_prompt\": \"<string>\",\n \"expected_behavior\": \"<string>\",\n \"starting_project_id\": \"<string>\",\n \"include_env_vars\": true,\n \"env_profile_ids\": [\n \"<string>\"\n ],\n \"model_ids\": [\n \"<string>\"\n ],\n \"compare_skills\": true,\n \"skill_ids\": [\n \"<string>\"\n ],\n \"mcp_enabled\": true,\n \"run_context\": {},\n \"enabled\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lightsage.com/v1/api-performance/custom-evals")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Lightsage-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"prompt\": \"<string>\",\n \"prompt_template\": \"<string>\",\n \"category_name\": \"<string>\",\n \"description\": \"<string>\",\n \"tag\": \"<string>\",\n \"competitor\": \"<string>\",\n \"prompt_competitor_group\": \"<string>\",\n \"eval\": {\n \"custom_prompt\": \"<string>\",\n \"expected_behavior\": \"<string>\",\n \"starting_project_id\": \"<string>\",\n \"include_env_vars\": true,\n \"env_profile_ids\": [\n \"<string>\"\n ],\n \"model_ids\": [\n \"<string>\"\n ],\n \"compare_skills\": true,\n \"skill_ids\": [\n \"<string>\"\n ],\n \"mcp_enabled\": true,\n \"run_context\": {},\n \"enabled\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"prompt": "<string>",
"prompt_template": "<string>",
"description": "<string>",
"tag": "<string>",
"competitor": "<string>",
"prompt_competitor": "<string>",
"prompt_competitor_group": "<string>",
"category": {},
"eval": {
"id": "<string>",
"operation_id": "<string>",
"eval_type": "<string>",
"source_id": "<string>",
"source": {
"id": "<string>",
"type": "<string>",
"label": "<string>"
},
"prompt": "<string>",
"custom_prompt": "<string>",
"expected_behavior": "<string>",
"starting_project_id": "<string>",
"docs_mode": "default",
"include_env_vars": true,
"env_profile_ids": [
"<string>"
],
"model_ids": [
"<string>"
],
"compare_skills": false,
"skills_mode": "none",
"skills_enabled": false,
"skill_ids": [
"<string>"
],
"mcp_enabled": false,
"run_context": {},
"enabled": true
},
"created_at": "<string>",
"updated_at": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}API Performance
Create Custom Eval
POST
/
v1
/
api-performance
/
custom-evals
Create Custom Eval
curl --request POST \
--url https://api.lightsage.com/v1/api-performance/custom-evals \
--header 'Content-Type: application/json' \
--header 'X-Lightsage-Api-Key: <api-key>' \
--data '
{
"prompt": "<string>",
"prompt_template": "<string>",
"category_name": "<string>",
"description": "<string>",
"tag": "<string>",
"competitor": "<string>",
"prompt_competitor_group": "<string>",
"eval": {
"custom_prompt": "<string>",
"expected_behavior": "<string>",
"starting_project_id": "<string>",
"include_env_vars": true,
"env_profile_ids": [
"<string>"
],
"model_ids": [
"<string>"
],
"compare_skills": true,
"skill_ids": [
"<string>"
],
"mcp_enabled": true,
"run_context": {},
"enabled": true
}
}
'import requests
url = "https://api.lightsage.com/v1/api-performance/custom-evals"
payload = {
"prompt": "<string>",
"prompt_template": "<string>",
"category_name": "<string>",
"description": "<string>",
"tag": "<string>",
"competitor": "<string>",
"prompt_competitor_group": "<string>",
"eval": {
"custom_prompt": "<string>",
"expected_behavior": "<string>",
"starting_project_id": "<string>",
"include_env_vars": True,
"env_profile_ids": ["<string>"],
"model_ids": ["<string>"],
"compare_skills": True,
"skill_ids": ["<string>"],
"mcp_enabled": True,
"run_context": {},
"enabled": True
}
}
headers = {
"X-Lightsage-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Lightsage-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
prompt: '<string>',
prompt_template: '<string>',
category_name: '<string>',
description: '<string>',
tag: '<string>',
competitor: '<string>',
prompt_competitor_group: '<string>',
eval: {
custom_prompt: '<string>',
expected_behavior: '<string>',
starting_project_id: '<string>',
include_env_vars: true,
env_profile_ids: ['<string>'],
model_ids: ['<string>'],
compare_skills: true,
skill_ids: ['<string>'],
mcp_enabled: true,
run_context: {},
enabled: true
}
})
};
fetch('https://api.lightsage.com/v1/api-performance/custom-evals', 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.lightsage.com/v1/api-performance/custom-evals",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'prompt' => '<string>',
'prompt_template' => '<string>',
'category_name' => '<string>',
'description' => '<string>',
'tag' => '<string>',
'competitor' => '<string>',
'prompt_competitor_group' => '<string>',
'eval' => [
'custom_prompt' => '<string>',
'expected_behavior' => '<string>',
'starting_project_id' => '<string>',
'include_env_vars' => true,
'env_profile_ids' => [
'<string>'
],
'model_ids' => [
'<string>'
],
'compare_skills' => true,
'skill_ids' => [
'<string>'
],
'mcp_enabled' => true,
'run_context' => [
],
'enabled' => true
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Lightsage-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.lightsage.com/v1/api-performance/custom-evals"
payload := strings.NewReader("{\n \"prompt\": \"<string>\",\n \"prompt_template\": \"<string>\",\n \"category_name\": \"<string>\",\n \"description\": \"<string>\",\n \"tag\": \"<string>\",\n \"competitor\": \"<string>\",\n \"prompt_competitor_group\": \"<string>\",\n \"eval\": {\n \"custom_prompt\": \"<string>\",\n \"expected_behavior\": \"<string>\",\n \"starting_project_id\": \"<string>\",\n \"include_env_vars\": true,\n \"env_profile_ids\": [\n \"<string>\"\n ],\n \"model_ids\": [\n \"<string>\"\n ],\n \"compare_skills\": true,\n \"skill_ids\": [\n \"<string>\"\n ],\n \"mcp_enabled\": true,\n \"run_context\": {},\n \"enabled\": true\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Lightsage-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.post("https://api.lightsage.com/v1/api-performance/custom-evals")
.header("X-Lightsage-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"prompt\": \"<string>\",\n \"prompt_template\": \"<string>\",\n \"category_name\": \"<string>\",\n \"description\": \"<string>\",\n \"tag\": \"<string>\",\n \"competitor\": \"<string>\",\n \"prompt_competitor_group\": \"<string>\",\n \"eval\": {\n \"custom_prompt\": \"<string>\",\n \"expected_behavior\": \"<string>\",\n \"starting_project_id\": \"<string>\",\n \"include_env_vars\": true,\n \"env_profile_ids\": [\n \"<string>\"\n ],\n \"model_ids\": [\n \"<string>\"\n ],\n \"compare_skills\": true,\n \"skill_ids\": [\n \"<string>\"\n ],\n \"mcp_enabled\": true,\n \"run_context\": {},\n \"enabled\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lightsage.com/v1/api-performance/custom-evals")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Lightsage-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"prompt\": \"<string>\",\n \"prompt_template\": \"<string>\",\n \"category_name\": \"<string>\",\n \"description\": \"<string>\",\n \"tag\": \"<string>\",\n \"competitor\": \"<string>\",\n \"prompt_competitor_group\": \"<string>\",\n \"eval\": {\n \"custom_prompt\": \"<string>\",\n \"expected_behavior\": \"<string>\",\n \"starting_project_id\": \"<string>\",\n \"include_env_vars\": true,\n \"env_profile_ids\": [\n \"<string>\"\n ],\n \"model_ids\": [\n \"<string>\"\n ],\n \"compare_skills\": true,\n \"skill_ids\": [\n \"<string>\"\n ],\n \"mcp_enabled\": true,\n \"run_context\": {},\n \"enabled\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"prompt": "<string>",
"prompt_template": "<string>",
"description": "<string>",
"tag": "<string>",
"competitor": "<string>",
"prompt_competitor": "<string>",
"prompt_competitor_group": "<string>",
"category": {},
"eval": {
"id": "<string>",
"operation_id": "<string>",
"eval_type": "<string>",
"source_id": "<string>",
"source": {
"id": "<string>",
"type": "<string>",
"label": "<string>"
},
"prompt": "<string>",
"custom_prompt": "<string>",
"expected_behavior": "<string>",
"starting_project_id": "<string>",
"docs_mode": "default",
"include_env_vars": true,
"env_profile_ids": [
"<string>"
],
"model_ids": [
"<string>"
],
"compare_skills": false,
"skills_mode": "none",
"skills_enabled": false,
"skill_ids": [
"<string>"
],
"mcp_enabled": false,
"run_context": {},
"enabled": true
},
"created_at": "<string>",
"updated_at": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Body
application/json
Optional template used to render prompt before storing. Available variables: Company name {{company_name}}; Company domain {{company_domain}}.
Optional display tag for this custom eval.
Competitor ID to render this custom eval against.
Base custom eval ID that this competitor variant belongs to.
Show child attributes
Show child attributes
Response
Successful Response
Template used to render prompt before storing. Available variables: Company name {{company_name}}; Company domain {{company_domain}}.
Show child attributes
Show child attributes
⌘I