workflows
Create workflows runs
Requires scopes: runs:write
POST
/
api
/
workflows
/
{id}
/
runs
Create workflows runs
curl --request POST \
--url https://evalgate.com/api/workflows/{id}/runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"traceId": 123,
"metadata": {},
"input": {}
}
'import requests
url = "https://evalgate.com/api/workflows/{id}/runs"
payload = {
"traceId": 123,
"metadata": {},
"input": {}
}
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({traceId: 123, metadata: {}, input: {}})
};
fetch('https://evalgate.com/api/workflows/{id}/runs', 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/workflows/{id}/runs",
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([
'traceId' => 123,
'metadata' => [
],
'input' => [
]
]),
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/workflows/{id}/runs"
payload := strings.NewReader("{\n \"traceId\": 123,\n \"metadata\": {},\n \"input\": {}\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/workflows/{id}/runs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"traceId\": 123,\n \"metadata\": {},\n \"input\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://evalgate.com/api/workflows/{id}/runs")
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 \"traceId\": 123,\n \"metadata\": {},\n \"input\": {}\n}"
response = http.request(request)
puts response.read_body{
"status": "<string>",
"id": 123,
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {
"trigger": "<string>",
"environment": "<string>",
"evaluationId": 123,
"autonomyLevel": "manual",
"approvalMode": "<string>",
"hookCount": 123,
"checkpointed": false,
"agentWorkflowType": "<string>",
"sessionId": "<string>",
"workflowProfile": {
"recipeTitle": "<string>",
"workflowClass": "approval_gated_mutation",
"autonomyLevel": "manual",
"approvalMode": "none",
"memoryMode": "none",
"backgroundExecution": true,
"requiredHooks": [
"session_start"
],
"linkedFailureModes": [
"<string>"
],
"successMetrics": [
"<string>"
],
"guardrails": [
"<string>"
],
"recommendedIterations": 123,
"source": "coverage_gap"
},
"hookInvocations": [
{
"hook": "session_start",
"blocked": true,
"latencyMs": 123,
"detail": "<string>"
}
],
"approvalDecisions": [
{
"actionType": "<string>",
"riskLevel": "medium",
"recommendedDisposition": "deny",
"finalDisposition": "rejected",
"rationale": "<string>"
}
],
"memoryEvents": [
{
"layer": "session",
"operation": "read",
"sourceId": "<string>",
"detail": "<string>"
}
],
"checkpoints": [
{
"kind": "manual",
"restorable": true,
"label": "<string>"
}
],
"debugSnapshots": [
{
"stepIndex": 123,
"label": "<string>",
"activeHooks": [
"session_start"
],
"memoryRefs": [
"<string>"
],
"approvalState": "<string>",
"summary": "<string>"
}
],
"runtimeSummary": {
"executionMode": "analysis_only",
"finalStatus": "completed",
"stopReason": "<string>",
"approvalState": "<string>",
"hookCount": 123,
"memoryReadCount": 123,
"checkpointCreated": true,
"handoffCount": 123,
"debugSnapshotCount": 123,
"decisionCount": 123,
"workflowRunId": 123,
"traceId": 123
}
},
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"traceId": 123,
"input": {},
"output": {},
"workflowId": 123,
"totalCost": "<string>",
"totalDurationMs": 123,
"agentCount": 123,
"handoffCount": 123,
"retryCount": 123,
"errorMessage": "<string>",
"trigger": "<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
Response
Successful response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I
Create workflows runs
curl --request POST \
--url https://evalgate.com/api/workflows/{id}/runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"traceId": 123,
"metadata": {},
"input": {}
}
'import requests
url = "https://evalgate.com/api/workflows/{id}/runs"
payload = {
"traceId": 123,
"metadata": {},
"input": {}
}
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({traceId: 123, metadata: {}, input: {}})
};
fetch('https://evalgate.com/api/workflows/{id}/runs', 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/workflows/{id}/runs",
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([
'traceId' => 123,
'metadata' => [
],
'input' => [
]
]),
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/workflows/{id}/runs"
payload := strings.NewReader("{\n \"traceId\": 123,\n \"metadata\": {},\n \"input\": {}\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/workflows/{id}/runs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"traceId\": 123,\n \"metadata\": {},\n \"input\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://evalgate.com/api/workflows/{id}/runs")
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 \"traceId\": 123,\n \"metadata\": {},\n \"input\": {}\n}"
response = http.request(request)
puts response.read_body{
"status": "<string>",
"id": 123,
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"metadata": {
"trigger": "<string>",
"environment": "<string>",
"evaluationId": 123,
"autonomyLevel": "manual",
"approvalMode": "<string>",
"hookCount": 123,
"checkpointed": false,
"agentWorkflowType": "<string>",
"sessionId": "<string>",
"workflowProfile": {
"recipeTitle": "<string>",
"workflowClass": "approval_gated_mutation",
"autonomyLevel": "manual",
"approvalMode": "none",
"memoryMode": "none",
"backgroundExecution": true,
"requiredHooks": [
"session_start"
],
"linkedFailureModes": [
"<string>"
],
"successMetrics": [
"<string>"
],
"guardrails": [
"<string>"
],
"recommendedIterations": 123,
"source": "coverage_gap"
},
"hookInvocations": [
{
"hook": "session_start",
"blocked": true,
"latencyMs": 123,
"detail": "<string>"
}
],
"approvalDecisions": [
{
"actionType": "<string>",
"riskLevel": "medium",
"recommendedDisposition": "deny",
"finalDisposition": "rejected",
"rationale": "<string>"
}
],
"memoryEvents": [
{
"layer": "session",
"operation": "read",
"sourceId": "<string>",
"detail": "<string>"
}
],
"checkpoints": [
{
"kind": "manual",
"restorable": true,
"label": "<string>"
}
],
"debugSnapshots": [
{
"stepIndex": 123,
"label": "<string>",
"activeHooks": [
"session_start"
],
"memoryRefs": [
"<string>"
],
"approvalState": "<string>",
"summary": "<string>"
}
],
"runtimeSummary": {
"executionMode": "analysis_only",
"finalStatus": "completed",
"stopReason": "<string>",
"approvalState": "<string>",
"hookCount": 123,
"memoryReadCount": 123,
"checkpointCreated": true,
"handoffCount": 123,
"debugSnapshotCount": 123,
"decisionCount": 123,
"workflowRunId": 123,
"traceId": 123
}
},
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"traceId": 123,
"input": {},
"output": {},
"workflowId": 123,
"totalCost": "<string>",
"totalDurationMs": 123,
"agentCount": 123,
"handoffCount": 123,
"retryCount": 123,
"errorMessage": "<string>",
"trigger": "<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
}
}
}