improvement
Create improvement contracts
Requires scopes: runs:write
POST
/
api
/
improvement
/
cycles
/
{cycleId}
/
contracts
Create improvement contracts
curl --request POST \
--url https://evalgate.com/api/improvement/cycles/{cycleId}/contracts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"scenarioKey": "<string>",
"autonomyLevel": 123,
"intent": "<string>",
"repeatsPerCase": 123,
"useScenarioDefaults": false,
"partitions": [
{
"role": "regression",
"memberKeys": [
"<string>"
]
}
],
"maxTrials": 123,
"candidateModels": [
"<string>"
]
}
'import requests
url = "https://evalgate.com/api/improvement/cycles/{cycleId}/contracts"
payload = {
"scenarioKey": "<string>",
"autonomyLevel": 123,
"intent": "<string>",
"repeatsPerCase": 123,
"useScenarioDefaults": False,
"partitions": [
{
"role": "regression",
"memberKeys": ["<string>"]
}
],
"maxTrials": 123,
"candidateModels": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
scenarioKey: '<string>',
autonomyLevel: 123,
intent: '<string>',
repeatsPerCase: 123,
useScenarioDefaults: false,
partitions: [{role: 'regression', memberKeys: ['<string>']}],
maxTrials: 123,
candidateModels: ['<string>']
})
};
fetch('https://evalgate.com/api/improvement/cycles/{cycleId}/contracts', 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://evalgate.com/api/improvement/cycles/{cycleId}/contracts",
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([
'scenarioKey' => '<string>',
'autonomyLevel' => 123,
'intent' => '<string>',
'repeatsPerCase' => 123,
'useScenarioDefaults' => false,
'partitions' => [
[
'role' => 'regression',
'memberKeys' => [
'<string>'
]
]
],
'maxTrials' => 123,
'candidateModels' => [
'<string>'
]
]),
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://evalgate.com/api/improvement/cycles/{cycleId}/contracts"
payload := strings.NewReader("{\n \"scenarioKey\": \"<string>\",\n \"autonomyLevel\": 123,\n \"intent\": \"<string>\",\n \"repeatsPerCase\": 123,\n \"useScenarioDefaults\": false,\n \"partitions\": [\n {\n \"role\": \"regression\",\n \"memberKeys\": [\n \"<string>\"\n ]\n }\n ],\n \"maxTrials\": 123,\n \"candidateModels\": [\n \"<string>\"\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://evalgate.com/api/improvement/cycles/{cycleId}/contracts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"scenarioKey\": \"<string>\",\n \"autonomyLevel\": 123,\n \"intent\": \"<string>\",\n \"repeatsPerCase\": 123,\n \"useScenarioDefaults\": false,\n \"partitions\": [\n {\n \"role\": \"regression\",\n \"memberKeys\": [\n \"<string>\"\n ]\n }\n ],\n \"maxTrials\": 123,\n \"candidateModels\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://evalgate.com/api/improvement/cycles/{cycleId}/contracts")
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 \"scenarioKey\": \"<string>\",\n \"autonomyLevel\": 123,\n \"intent\": \"<string>\",\n \"repeatsPerCase\": 123,\n \"useScenarioDefaults\": false,\n \"partitions\": [\n {\n \"role\": \"regression\",\n \"memberKeys\": [\n \"<string>\"\n ]\n }\n ],\n \"maxTrials\": 123,\n \"candidateModels\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"contract": {
"id": "<string>",
"cycleId": "<string>",
"status": "draft",
"contractHash": "<string>",
"intent": "<string>",
"contract": {
"contractHash": "<string>",
"schemaVersion": 1,
"compiler": "evalgate-intent-v1",
"intent": {
"text": "<string>",
"clauses": [
{
"text": "<string>",
"status": "recognized",
"interpretedAs": [
"<string>"
]
}
]
},
"objective": {
"kind": "reduce_failure_mode",
"failureMode": "<string>",
"primaryMetric": "<string>"
},
"quality": {
"protectedMetrics": [
"<string>"
],
"nonInferiorityMargins": {},
"criticalSlices": [
"<string>"
],
"safetyRequirements": [
"<string>"
],
"guardrails": {}
},
"surfaces": {
"editable": [
{
"kind": "prompt",
"paths": [
"<string>"
]
}
],
"immutablePaths": [
"<string>"
]
},
"identities": {
"grader": "<string>",
"cases": "<string>",
"baseline": "<string>",
"policy": "<string>"
},
"populations": {
"development": "<string>",
"selection": "<string>",
"confirmation": "<string>"
},
"budget": {
"searchUsd": 123,
"executionUsd": 123,
"confirmationUsd": 123,
"maxTrials": 123
},
"stopConditions": {},
"isolation": {
"required": "process"
},
"authority": {
"optimizer": [
"propose",
"test"
],
"evalgate": [
"qualify"
],
"human": [
"adopt",
"merge"
]
},
"assumptions": [
"<string>"
]
},
"summary": [
"<string>"
],
"compiledBy": "<string>",
"approvedBy": "<string>",
"approvedAt": "<string>",
"createdAt": "<string>"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}Authorizations
Organization-scoped EvalGate API key. Discover the supported agent scopes at /.well-known/oauth-protected-resource. Per-operation grants are listed in x-evalgate-required-scopes; OpenAPI bearer security requirement arrays remain empty as required for non-OAuth schemes.
Path Parameters
Body
application/json
Available options:
false Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Successful response
Show child attributes
Show child attributes
⌘I
Create improvement contracts
curl --request POST \
--url https://evalgate.com/api/improvement/cycles/{cycleId}/contracts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"scenarioKey": "<string>",
"autonomyLevel": 123,
"intent": "<string>",
"repeatsPerCase": 123,
"useScenarioDefaults": false,
"partitions": [
{
"role": "regression",
"memberKeys": [
"<string>"
]
}
],
"maxTrials": 123,
"candidateModels": [
"<string>"
]
}
'import requests
url = "https://evalgate.com/api/improvement/cycles/{cycleId}/contracts"
payload = {
"scenarioKey": "<string>",
"autonomyLevel": 123,
"intent": "<string>",
"repeatsPerCase": 123,
"useScenarioDefaults": False,
"partitions": [
{
"role": "regression",
"memberKeys": ["<string>"]
}
],
"maxTrials": 123,
"candidateModels": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
scenarioKey: '<string>',
autonomyLevel: 123,
intent: '<string>',
repeatsPerCase: 123,
useScenarioDefaults: false,
partitions: [{role: 'regression', memberKeys: ['<string>']}],
maxTrials: 123,
candidateModels: ['<string>']
})
};
fetch('https://evalgate.com/api/improvement/cycles/{cycleId}/contracts', 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://evalgate.com/api/improvement/cycles/{cycleId}/contracts",
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([
'scenarioKey' => '<string>',
'autonomyLevel' => 123,
'intent' => '<string>',
'repeatsPerCase' => 123,
'useScenarioDefaults' => false,
'partitions' => [
[
'role' => 'regression',
'memberKeys' => [
'<string>'
]
]
],
'maxTrials' => 123,
'candidateModels' => [
'<string>'
]
]),
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://evalgate.com/api/improvement/cycles/{cycleId}/contracts"
payload := strings.NewReader("{\n \"scenarioKey\": \"<string>\",\n \"autonomyLevel\": 123,\n \"intent\": \"<string>\",\n \"repeatsPerCase\": 123,\n \"useScenarioDefaults\": false,\n \"partitions\": [\n {\n \"role\": \"regression\",\n \"memberKeys\": [\n \"<string>\"\n ]\n }\n ],\n \"maxTrials\": 123,\n \"candidateModels\": [\n \"<string>\"\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://evalgate.com/api/improvement/cycles/{cycleId}/contracts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"scenarioKey\": \"<string>\",\n \"autonomyLevel\": 123,\n \"intent\": \"<string>\",\n \"repeatsPerCase\": 123,\n \"useScenarioDefaults\": false,\n \"partitions\": [\n {\n \"role\": \"regression\",\n \"memberKeys\": [\n \"<string>\"\n ]\n }\n ],\n \"maxTrials\": 123,\n \"candidateModels\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://evalgate.com/api/improvement/cycles/{cycleId}/contracts")
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 \"scenarioKey\": \"<string>\",\n \"autonomyLevel\": 123,\n \"intent\": \"<string>\",\n \"repeatsPerCase\": 123,\n \"useScenarioDefaults\": false,\n \"partitions\": [\n {\n \"role\": \"regression\",\n \"memberKeys\": [\n \"<string>\"\n ]\n }\n ],\n \"maxTrials\": 123,\n \"candidateModels\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"contract": {
"id": "<string>",
"cycleId": "<string>",
"status": "draft",
"contractHash": "<string>",
"intent": "<string>",
"contract": {
"contractHash": "<string>",
"schemaVersion": 1,
"compiler": "evalgate-intent-v1",
"intent": {
"text": "<string>",
"clauses": [
{
"text": "<string>",
"status": "recognized",
"interpretedAs": [
"<string>"
]
}
]
},
"objective": {
"kind": "reduce_failure_mode",
"failureMode": "<string>",
"primaryMetric": "<string>"
},
"quality": {
"protectedMetrics": [
"<string>"
],
"nonInferiorityMargins": {},
"criticalSlices": [
"<string>"
],
"safetyRequirements": [
"<string>"
],
"guardrails": {}
},
"surfaces": {
"editable": [
{
"kind": "prompt",
"paths": [
"<string>"
]
}
],
"immutablePaths": [
"<string>"
]
},
"identities": {
"grader": "<string>",
"cases": "<string>",
"baseline": "<string>",
"policy": "<string>"
},
"populations": {
"development": "<string>",
"selection": "<string>",
"confirmation": "<string>"
},
"budget": {
"searchUsd": 123,
"executionUsd": 123,
"confirmationUsd": 123,
"maxTrials": 123
},
"stopConditions": {},
"isolation": {
"required": "process"
},
"authority": {
"optimizer": [
"propose",
"test"
],
"evalgate": [
"qualify"
],
"human": [
"adopt",
"merge"
]
},
"assumptions": [
"<string>"
]
},
"summary": [
"<string>"
],
"compiledBy": "<string>",
"approvedBy": "<string>",
"approvedAt": "<string>",
"createdAt": "<string>"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"redaction": {
"applied": true,
"fieldCount": 1,
"secretCount": 1
}
}
}