Invoke a pre-configured evaluation
curl --request POST \
--url https://api.qualifire.ai/api/v1/evaluation/invoke \
--header 'Content-Type: application/json' \
--header 'X-Qualifire-API-Key: <api-key>' \
--data '
{
"evaluation_id": "<string>",
"input": "<string>",
"output": "<string>",
"messages": [
{
"content": "<string>",
"tool_calls": [
{
"function": {
"name": "<string>",
"arguments": {}
},
"id": "<string>",
"type": "<string>"
}
]
}
],
"available_tools": [
{
"name": "<string>",
"description": "<string>",
"parameters": {}
}
],
"metadata": {}
}
'import requests
url = "https://api.qualifire.ai/api/v1/evaluation/invoke"
payload = {
"evaluation_id": "<string>",
"input": "<string>",
"output": "<string>",
"messages": [
{
"content": "<string>",
"tool_calls": [
{
"function": {
"name": "<string>",
"arguments": {}
},
"id": "<string>",
"type": "<string>"
}
]
}
],
"available_tools": [
{
"name": "<string>",
"description": "<string>",
"parameters": {}
}
],
"metadata": {}
}
headers = {
"X-Qualifire-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-Qualifire-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
evaluation_id: '<string>',
input: '<string>',
output: '<string>',
messages: [
{
content: '<string>',
tool_calls: [
{function: {name: '<string>', arguments: {}}, id: '<string>', type: '<string>'}
]
}
],
available_tools: [{name: '<string>', description: '<string>', parameters: {}}],
metadata: {}
})
};
fetch('https://api.qualifire.ai/api/v1/evaluation/invoke', 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.qualifire.ai/api/v1/evaluation/invoke",
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([
'evaluation_id' => '<string>',
'input' => '<string>',
'output' => '<string>',
'messages' => [
[
'content' => '<string>',
'tool_calls' => [
[
'function' => [
'name' => '<string>',
'arguments' => [
]
],
'id' => '<string>',
'type' => '<string>'
]
]
]
],
'available_tools' => [
[
'name' => '<string>',
'description' => '<string>',
'parameters' => [
]
]
],
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Qualifire-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.qualifire.ai/api/v1/evaluation/invoke"
payload := strings.NewReader("{\n \"evaluation_id\": \"<string>\",\n \"input\": \"<string>\",\n \"output\": \"<string>\",\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"tool_calls\": [\n {\n \"function\": {\n \"name\": \"<string>\",\n \"arguments\": {}\n },\n \"id\": \"<string>\",\n \"type\": \"<string>\"\n }\n ]\n }\n ],\n \"available_tools\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parameters\": {}\n }\n ],\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Qualifire-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.qualifire.ai/api/v1/evaluation/invoke")
.header("X-Qualifire-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"evaluation_id\": \"<string>\",\n \"input\": \"<string>\",\n \"output\": \"<string>\",\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"tool_calls\": [\n {\n \"function\": {\n \"name\": \"<string>\",\n \"arguments\": {}\n },\n \"id\": \"<string>\",\n \"type\": \"<string>\"\n }\n ]\n }\n ],\n \"available_tools\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parameters\": {}\n }\n ],\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qualifire.ai/api/v1/evaluation/invoke")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Qualifire-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"evaluation_id\": \"<string>\",\n \"input\": \"<string>\",\n \"output\": \"<string>\",\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"tool_calls\": [\n {\n \"function\": {\n \"name\": \"<string>\",\n \"arguments\": {}\n },\n \"id\": \"<string>\",\n \"type\": \"<string>\"\n }\n ]\n }\n ],\n \"available_tools\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parameters\": {}\n }\n ],\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"score": 123,
"evaluationResults": [
{
"type": "<string>",
"results": [
{
"name": "<string>",
"score": 123,
"label": "<string>",
"confidence_score": 123,
"reason": "<string>",
"flagged": true,
"quote": "<string>",
"data": "<string>"
}
]
}
]
}{
"error": "Invalid API key"
}{
"error": "Invalid API key"
}{
"error": "Invalid API key"
}Evaluations
Invoke
Invokes a pre-configured evaluation by its ID. The evaluation configuration (which checks to run, modes, assertions, etc.) is defined in the Qualifire dashboard.
POST
/
v1
/
evaluation
/
invoke
Invoke a pre-configured evaluation
curl --request POST \
--url https://api.qualifire.ai/api/v1/evaluation/invoke \
--header 'Content-Type: application/json' \
--header 'X-Qualifire-API-Key: <api-key>' \
--data '
{
"evaluation_id": "<string>",
"input": "<string>",
"output": "<string>",
"messages": [
{
"content": "<string>",
"tool_calls": [
{
"function": {
"name": "<string>",
"arguments": {}
},
"id": "<string>",
"type": "<string>"
}
]
}
],
"available_tools": [
{
"name": "<string>",
"description": "<string>",
"parameters": {}
}
],
"metadata": {}
}
'import requests
url = "https://api.qualifire.ai/api/v1/evaluation/invoke"
payload = {
"evaluation_id": "<string>",
"input": "<string>",
"output": "<string>",
"messages": [
{
"content": "<string>",
"tool_calls": [
{
"function": {
"name": "<string>",
"arguments": {}
},
"id": "<string>",
"type": "<string>"
}
]
}
],
"available_tools": [
{
"name": "<string>",
"description": "<string>",
"parameters": {}
}
],
"metadata": {}
}
headers = {
"X-Qualifire-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-Qualifire-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
evaluation_id: '<string>',
input: '<string>',
output: '<string>',
messages: [
{
content: '<string>',
tool_calls: [
{function: {name: '<string>', arguments: {}}, id: '<string>', type: '<string>'}
]
}
],
available_tools: [{name: '<string>', description: '<string>', parameters: {}}],
metadata: {}
})
};
fetch('https://api.qualifire.ai/api/v1/evaluation/invoke', 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.qualifire.ai/api/v1/evaluation/invoke",
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([
'evaluation_id' => '<string>',
'input' => '<string>',
'output' => '<string>',
'messages' => [
[
'content' => '<string>',
'tool_calls' => [
[
'function' => [
'name' => '<string>',
'arguments' => [
]
],
'id' => '<string>',
'type' => '<string>'
]
]
]
],
'available_tools' => [
[
'name' => '<string>',
'description' => '<string>',
'parameters' => [
]
]
],
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Qualifire-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.qualifire.ai/api/v1/evaluation/invoke"
payload := strings.NewReader("{\n \"evaluation_id\": \"<string>\",\n \"input\": \"<string>\",\n \"output\": \"<string>\",\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"tool_calls\": [\n {\n \"function\": {\n \"name\": \"<string>\",\n \"arguments\": {}\n },\n \"id\": \"<string>\",\n \"type\": \"<string>\"\n }\n ]\n }\n ],\n \"available_tools\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parameters\": {}\n }\n ],\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Qualifire-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.qualifire.ai/api/v1/evaluation/invoke")
.header("X-Qualifire-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"evaluation_id\": \"<string>\",\n \"input\": \"<string>\",\n \"output\": \"<string>\",\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"tool_calls\": [\n {\n \"function\": {\n \"name\": \"<string>\",\n \"arguments\": {}\n },\n \"id\": \"<string>\",\n \"type\": \"<string>\"\n }\n ]\n }\n ],\n \"available_tools\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parameters\": {}\n }\n ],\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qualifire.ai/api/v1/evaluation/invoke")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Qualifire-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"evaluation_id\": \"<string>\",\n \"input\": \"<string>\",\n \"output\": \"<string>\",\n \"messages\": [\n {\n \"content\": \"<string>\",\n \"tool_calls\": [\n {\n \"function\": {\n \"name\": \"<string>\",\n \"arguments\": {}\n },\n \"id\": \"<string>\",\n \"type\": \"<string>\"\n }\n ]\n }\n ],\n \"available_tools\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"parameters\": {}\n }\n ],\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"score": 123,
"evaluationResults": [
{
"type": "<string>",
"results": [
{
"name": "<string>",
"score": 123,
"label": "<string>",
"confidence_score": 123,
"reason": "<string>",
"flagged": true,
"quote": "<string>",
"data": "<string>"
}
]
}
]
}{
"error": "Invalid API key"
}{
"error": "Invalid API key"
}{
"error": "Invalid API key"
}Authorizations
Body
application/json
Evaluation invoke request
At least one of input, output, or messages must be provided.
The ID of the pre-configured evaluation to invoke
The input text (e.g., user prompt)
The output text (e.g., LLM response)
Conversation messages for multi-turn evaluation
Show child attributes
Show child attributes
List of tools available to the LLM
Show child attributes
Show child attributes
Optional key-value pairs (string values only) to attach to the evaluation invocation
Show child attributes
Show child attributes
⌘I