cURL
curl -X POST 'https://api.gumloop.com/api/v1/evaluations' \
-H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"organization_id": "ORG_ID",
"name": "Support tone",
"config": {
"criteria": [
{"name": "Greets the customer", "prompt": "Did the agent greet the customer by name?", "priority": "needs_review"}
]
}
}'from gumloop import Gumloop
client = Gumloop(access_token="YOUR_ACCESS_TOKEN")
created = client.evaluations.create(
organization_id="ORG_ID",
name="Support tone",
config={
"criteria": [
{
"name": "Greets the customer",
"prompt": "Did the agent greet the customer by name?",
"priority": "needs_review",
}
]
},
)
print(created.evaluation.id)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
organization_id: '<string>',
name: '<string>',
scope: 'organization',
description: '<string>',
enabled: true,
config: {
model_name: '<string>',
language: '<string>',
include_auto_tags: true,
session_types: ['<string>'],
criteria: [{name: '<string>', prompt: '<string>', id: '<string>', enabled: true}],
tags: [{name: '<string>', description: '<string>'}],
data_points: [{name: '<string>', id: '<string>', description: '<string>'}],
sentiment: {},
notifications: {}
}
})
};
fetch('https://api.gumloop.com/api/v1/evaluations', 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.gumloop.com/api/v1/evaluations",
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([
'organization_id' => '<string>',
'name' => '<string>',
'scope' => 'organization',
'description' => '<string>',
'enabled' => true,
'config' => [
'model_name' => '<string>',
'language' => '<string>',
'include_auto_tags' => true,
'session_types' => [
'<string>'
],
'criteria' => [
[
'name' => '<string>',
'prompt' => '<string>',
'id' => '<string>',
'enabled' => true
]
],
'tags' => [
[
'name' => '<string>',
'description' => '<string>'
]
],
'data_points' => [
[
'name' => '<string>',
'id' => '<string>',
'description' => '<string>'
]
],
'sentiment' => [
],
'notifications' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.gumloop.com/api/v1/evaluations"
payload := strings.NewReader("{\n \"organization_id\": \"<string>\",\n \"name\": \"<string>\",\n \"scope\": \"organization\",\n \"description\": \"<string>\",\n \"enabled\": true,\n \"config\": {\n \"model_name\": \"<string>\",\n \"language\": \"<string>\",\n \"include_auto_tags\": true,\n \"session_types\": [\n \"<string>\"\n ],\n \"criteria\": [\n {\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"id\": \"<string>\",\n \"enabled\": true\n }\n ],\n \"tags\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"data_points\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"sentiment\": {},\n \"notifications\": {}\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.gumloop.com/api/v1/evaluations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"organization_id\": \"<string>\",\n \"name\": \"<string>\",\n \"scope\": \"organization\",\n \"description\": \"<string>\",\n \"enabled\": true,\n \"config\": {\n \"model_name\": \"<string>\",\n \"language\": \"<string>\",\n \"include_auto_tags\": true,\n \"session_types\": [\n \"<string>\"\n ],\n \"criteria\": [\n {\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"id\": \"<string>\",\n \"enabled\": true\n }\n ],\n \"tags\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"data_points\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"sentiment\": {},\n \"notifications\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gumloop.com/api/v1/evaluations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"organization_id\": \"<string>\",\n \"name\": \"<string>\",\n \"scope\": \"organization\",\n \"description\": \"<string>\",\n \"enabled\": true,\n \"config\": {\n \"model_name\": \"<string>\",\n \"language\": \"<string>\",\n \"include_auto_tags\": true,\n \"session_types\": [\n \"<string>\"\n ],\n \"criteria\": [\n {\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"id\": \"<string>\",\n \"enabled\": true\n }\n ],\n \"tags\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"data_points\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"sentiment\": {},\n \"notifications\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"evaluation": {
"id": "1c1b3c8e-7d61-4c1e-9c66-4a8d2f1e0b7a",
"scope": "organization",
"agent_id": null,
"organization_id": "org_4f8c92ab",
"name": "Support tone",
"description": "Customer-facing agents stay polite and on topic.",
"enabled": true,
"targets": [
{
"type": "team",
"id": "team_4f8c92ab"
}
],
"covered_agent_count": 12,
"config": {
"model_name": "auto",
"frequency": "debounced",
"language": "auto",
"include_auto_tags": true,
"session_types": [
"chat",
"slack"
],
"criteria": [
{
"id": "crit_1",
"name": "Greets the customer",
"prompt": "Did the agent greet the customer by name?",
"type": "voice_tone",
"priority": "needs_review",
"enabled": true
}
],
"tags": [],
"data_points": []
},
"run_summary": {
"evaluated_count": 48,
"graded_count": 47,
"pass_count": 41,
"needs_review_count": 4,
"needs_attention_count": 2,
"failed_count": 1,
"success_rate": 0.872,
"last_run_at": "2026-09-03T21:40:00+00:00"
},
"creator": {
"id": "user_1a2b3c",
"first_name": "Ada",
"last_name": "Lovelace",
"email": "ada@acme.com",
"profile_picture": null
},
"created_at": "2026-09-01T12:00:00+00:00",
"updated_at": "2026-09-03T21:40:00+00:00"
}
}Create evaluation
Creates an organization evaluation. A new evaluation has no targets, so it cannot start enabled: set targets with PUT /evaluations/{evaluation_id}/targets, then enable it with PATCH /evaluations/{evaluation_id}.
Rubric values are validated strictly: an unknown frequency, criterion priority, type, data point data_type, or session type, a criterion without name and prompt, or a duplicate tag name returns 400 invalid_request with the offending paths in error.details.fields.
POST
/
evaluations
cURL
curl -X POST 'https://api.gumloop.com/api/v1/evaluations' \
-H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"organization_id": "ORG_ID",
"name": "Support tone",
"config": {
"criteria": [
{"name": "Greets the customer", "prompt": "Did the agent greet the customer by name?", "priority": "needs_review"}
]
}
}'from gumloop import Gumloop
client = Gumloop(access_token="YOUR_ACCESS_TOKEN")
created = client.evaluations.create(
organization_id="ORG_ID",
name="Support tone",
config={
"criteria": [
{
"name": "Greets the customer",
"prompt": "Did the agent greet the customer by name?",
"priority": "needs_review",
}
]
},
)
print(created.evaluation.id)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
organization_id: '<string>',
name: '<string>',
scope: 'organization',
description: '<string>',
enabled: true,
config: {
model_name: '<string>',
language: '<string>',
include_auto_tags: true,
session_types: ['<string>'],
criteria: [{name: '<string>', prompt: '<string>', id: '<string>', enabled: true}],
tags: [{name: '<string>', description: '<string>'}],
data_points: [{name: '<string>', id: '<string>', description: '<string>'}],
sentiment: {},
notifications: {}
}
})
};
fetch('https://api.gumloop.com/api/v1/evaluations', 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.gumloop.com/api/v1/evaluations",
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([
'organization_id' => '<string>',
'name' => '<string>',
'scope' => 'organization',
'description' => '<string>',
'enabled' => true,
'config' => [
'model_name' => '<string>',
'language' => '<string>',
'include_auto_tags' => true,
'session_types' => [
'<string>'
],
'criteria' => [
[
'name' => '<string>',
'prompt' => '<string>',
'id' => '<string>',
'enabled' => true
]
],
'tags' => [
[
'name' => '<string>',
'description' => '<string>'
]
],
'data_points' => [
[
'name' => '<string>',
'id' => '<string>',
'description' => '<string>'
]
],
'sentiment' => [
],
'notifications' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.gumloop.com/api/v1/evaluations"
payload := strings.NewReader("{\n \"organization_id\": \"<string>\",\n \"name\": \"<string>\",\n \"scope\": \"organization\",\n \"description\": \"<string>\",\n \"enabled\": true,\n \"config\": {\n \"model_name\": \"<string>\",\n \"language\": \"<string>\",\n \"include_auto_tags\": true,\n \"session_types\": [\n \"<string>\"\n ],\n \"criteria\": [\n {\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"id\": \"<string>\",\n \"enabled\": true\n }\n ],\n \"tags\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"data_points\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"sentiment\": {},\n \"notifications\": {}\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.gumloop.com/api/v1/evaluations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"organization_id\": \"<string>\",\n \"name\": \"<string>\",\n \"scope\": \"organization\",\n \"description\": \"<string>\",\n \"enabled\": true,\n \"config\": {\n \"model_name\": \"<string>\",\n \"language\": \"<string>\",\n \"include_auto_tags\": true,\n \"session_types\": [\n \"<string>\"\n ],\n \"criteria\": [\n {\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"id\": \"<string>\",\n \"enabled\": true\n }\n ],\n \"tags\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"data_points\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"sentiment\": {},\n \"notifications\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gumloop.com/api/v1/evaluations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"organization_id\": \"<string>\",\n \"name\": \"<string>\",\n \"scope\": \"organization\",\n \"description\": \"<string>\",\n \"enabled\": true,\n \"config\": {\n \"model_name\": \"<string>\",\n \"language\": \"<string>\",\n \"include_auto_tags\": true,\n \"session_types\": [\n \"<string>\"\n ],\n \"criteria\": [\n {\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"id\": \"<string>\",\n \"enabled\": true\n }\n ],\n \"tags\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"data_points\": [\n {\n \"name\": \"<string>\",\n \"id\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"sentiment\": {},\n \"notifications\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"evaluation": {
"id": "1c1b3c8e-7d61-4c1e-9c66-4a8d2f1e0b7a",
"scope": "organization",
"agent_id": null,
"organization_id": "org_4f8c92ab",
"name": "Support tone",
"description": "Customer-facing agents stay polite and on topic.",
"enabled": true,
"targets": [
{
"type": "team",
"id": "team_4f8c92ab"
}
],
"covered_agent_count": 12,
"config": {
"model_name": "auto",
"frequency": "debounced",
"language": "auto",
"include_auto_tags": true,
"session_types": [
"chat",
"slack"
],
"criteria": [
{
"id": "crit_1",
"name": "Greets the customer",
"prompt": "Did the agent greet the customer by name?",
"type": "voice_tone",
"priority": "needs_review",
"enabled": true
}
],
"tags": [],
"data_points": []
},
"run_summary": {
"evaluated_count": 48,
"graded_count": 47,
"pass_count": 41,
"needs_review_count": 4,
"needs_attention_count": 2,
"failed_count": 1,
"success_rate": 0.872,
"last_run_at": "2026-09-03T21:40:00+00:00"
},
"creator": {
"id": "user_1a2b3c",
"first_name": "Ada",
"last_name": "Lovelace",
"email": "ada@acme.com",
"profile_picture": null
},
"created_at": "2026-09-01T12:00:00+00:00",
"updated_at": "2026-09-03T21:40:00+00:00"
}
}Authorizations
Body
application/json
Unique among the organization's active evaluations.
Required string length:
1 - 256Available options:
organization Maximum string length:
4000Must be omitted or false on create; a new evaluation has no targets yet.
What and how the evaluation grades. Entries in criteria, tags, and data_points accept additional fields as the product evolves.
Show child attributes
Show child attributes
Response
The created evaluation.
Show child attributes
Show child attributes
Example:
{
"id": "1c1b3c8e-7d61-4c1e-9c66-4a8d2f1e0b7a",
"scope": "organization",
"agent_id": null,
"organization_id": "org_4f8c92ab",
"name": "Support tone",
"description": "Customer-facing agents stay polite and on topic.",
"enabled": true,
"targets": [{ "type": "team", "id": "team_4f8c92ab" }],
"covered_agent_count": 12,
"config": {
"model_name": "auto",
"frequency": "debounced",
"language": "auto",
"include_auto_tags": true,
"session_types": ["chat", "slack"],
"criteria": [
{
"id": "crit_1",
"name": "Greets the customer",
"prompt": "Did the agent greet the customer by name?",
"type": "voice_tone",
"priority": "needs_review",
"enabled": true
}
],
"tags": [],
"data_points": []
},
"run_summary": {
"evaluated_count": 48,
"graded_count": 47,
"pass_count": 41,
"needs_review_count": 4,
"needs_attention_count": 2,
"failed_count": 1,
"success_rate": 0.872,
"last_run_at": "2026-09-03T21:40:00+00:00"
},
"creator": {
"id": "user_1a2b3c",
"first_name": "Ada",
"last_name": "Lovelace",
"email": "ada@acme.com",
"profile_picture": null
},
"created_at": "2026-09-01T12:00:00+00:00",
"updated_at": "2026-09-03T21:40:00+00:00"
}
Was this page helpful?