Workflows
Compare two debug attempts
Read an attempt beside an earlier finished attempt of the same node.
GET
/
api
/
v3
/
workflow-debug-attempts
/
{attemptId}
/
comparison
Compare two debug attempts
curl --request GET \
--url https://api.forge.gloo.com/api/v3/workflow-debug-attempts/{attemptId}/comparison \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.forge.gloo.com/api/v3/workflow-debug-attempts/{attemptId}/comparison"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.forge.gloo.com/api/v3/workflow-debug-attempts/{attemptId}/comparison', 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.forge.gloo.com/api/v3/workflow-debug-attempts/{attemptId}/comparison",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.forge.gloo.com/api/v3/workflow-debug-attempts/{attemptId}/comparison"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.forge.gloo.com/api/v3/workflow-debug-attempts/{attemptId}/comparison")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.forge.gloo.com/api/v3/workflow-debug-attempts/{attemptId}/comparison")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"attempt": {
"attemptId": "<string>",
"workflowId": "<string>",
"draftId": "<string>",
"targetNodeId": "<string>",
"sourceRunId": "<string>",
"sourceVersionId": "<string>",
"status": "preparing",
"targetSnapshot": "<unknown>",
"targetSnapshotHash": "<string>",
"resolvedInputs": [
"<unknown>"
],
"effectPlan": [
"<unknown>"
],
"blockers": [
{
"code": "<string>",
"message": "<string>",
"inputKey": "<string>",
"operationKey": "<string>",
"candidateMappings": [
{
"sourceNodeId": "<string>",
"outputKey": "<string>"
}
]
}
],
"traceId": "<string>",
"createdAt": 123,
"updatedAt": 123,
"targetLogicalNodeId": "<string>",
"workflowArguments": "<unknown>",
"planHash": "<string>",
"preparationExpiresAt": 123,
"launchRequestId": "<string>",
"output": "<unknown>",
"validation": {
"ok": true,
"errors": [
"<string>"
]
},
"error": {
"code": "<string>",
"message": "<string>",
"phase": "<string>"
},
"inputTokens": 123,
"outputTokens": 123,
"computeSeconds": 123,
"costUsd": 123,
"manifest": [
{
"relativePath": "<string>",
"sizeBytes": 123,
"sha256": "<string>",
"status": "pending",
"mimeType": "<string>",
"fileId": "<string>"
}
],
"captures": [
{
"sequenceNo": 123,
"operationKey": "<string>",
"adapterKey": "<string>",
"destination": "<string>",
"request": "<unknown>",
"createdAt": 123,
"response": "<unknown>"
}
],
"queuedAt": 123,
"startedAt": 123,
"completedAt": 123,
"cancelRequestedAt": 123
},
"baseline": {
"attemptId": "<string>",
"workflowId": "<string>",
"draftId": "<string>",
"targetNodeId": "<string>",
"sourceRunId": "<string>",
"sourceVersionId": "<string>",
"status": "preparing",
"targetSnapshot": "<unknown>",
"targetSnapshotHash": "<string>",
"resolvedInputs": [
"<unknown>"
],
"effectPlan": [
"<unknown>"
],
"blockers": [
{
"code": "<string>",
"message": "<string>",
"inputKey": "<string>",
"operationKey": "<string>",
"candidateMappings": [
{
"sourceNodeId": "<string>",
"outputKey": "<string>"
}
]
}
],
"traceId": "<string>",
"createdAt": 123,
"updatedAt": 123,
"targetLogicalNodeId": "<string>",
"workflowArguments": "<unknown>",
"planHash": "<string>",
"preparationExpiresAt": 123,
"launchRequestId": "<string>",
"output": "<unknown>",
"validation": {
"ok": true,
"errors": [
"<string>"
]
},
"error": {
"code": "<string>",
"message": "<string>",
"phase": "<string>"
},
"inputTokens": 123,
"outputTokens": 123,
"computeSeconds": 123,
"costUsd": 123,
"manifest": [
{
"relativePath": "<string>",
"sizeBytes": 123,
"sha256": "<string>",
"status": "pending",
"mimeType": "<string>",
"fileId": "<string>"
}
],
"captures": [
{
"sequenceNo": 123,
"operationKey": "<string>",
"adapterKey": "<string>",
"destination": "<string>",
"request": "<unknown>",
"createdAt": 123,
"response": "<unknown>"
}
],
"queuedAt": 123,
"startedAt": 123,
"completedAt": 123,
"cancelRequestedAt": 123
}
},
"meta": {
"requestId": "<string>",
"hasMore": true,
"nextCursor": "<string>",
"asOf": 123
}
}{
"error": {
"code": "bad_request",
"message": "<string>",
"docUrl": "<string>",
"reason": "requester_unavailable",
"requiredPermission": "<string>",
"personRequired": true,
"decisionId": "<string>",
"capHeadroom": {
"remainingCents": 123,
"capCents": 123,
"consumedCents": 123,
"estimateCents": 123
},
"details": [
{
"path": "<string>",
"param": "<string>",
"message": "<string>",
"code": "required"
}
]
},
"meta": {
"requestId": "<string>",
"hasMore": true,
"nextCursor": "<string>",
"asOf": 123
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"docUrl": "<string>",
"reason": "requester_unavailable",
"requiredPermission": "<string>",
"personRequired": true,
"decisionId": "<string>",
"capHeadroom": {
"remainingCents": 123,
"capCents": 123,
"consumedCents": 123,
"estimateCents": 123
},
"details": [
{
"path": "<string>",
"param": "<string>",
"message": "<string>",
"code": "required"
}
]
},
"meta": {
"requestId": "<string>",
"hasMore": true,
"nextCursor": "<string>",
"asOf": 123
}
}{
"error": {
"code": "forbidden",
"message": "<string>",
"docUrl": "<string>",
"reason": "requester_unavailable",
"requiredPermission": "<string>",
"personRequired": true,
"decisionId": "<string>",
"capHeadroom": {
"remainingCents": 123,
"capCents": 123,
"consumedCents": 123,
"estimateCents": 123
},
"details": [
{
"path": "<string>",
"param": "<string>",
"message": "<string>",
"code": "required"
}
]
},
"meta": {
"requestId": "<string>",
"hasMore": true,
"nextCursor": "<string>",
"asOf": 123
}
}{
"error": {
"code": "resource_missing",
"message": "<string>",
"docUrl": "<string>",
"reason": "requester_unavailable",
"requiredPermission": "<string>",
"personRequired": true,
"decisionId": "<string>",
"capHeadroom": {
"remainingCents": 123,
"capCents": 123,
"consumedCents": 123,
"estimateCents": 123
},
"details": [
{
"path": "<string>",
"param": "<string>",
"message": "<string>",
"code": "required"
}
]
},
"meta": {
"requestId": "<string>",
"hasMore": true,
"nextCursor": "<string>",
"asOf": 123
}
}{
"error": {
"code": "conflict",
"message": "<string>",
"docUrl": "<string>",
"reason": "requester_unavailable",
"requiredPermission": "<string>",
"personRequired": true,
"decisionId": "<string>",
"capHeadroom": {
"remainingCents": 123,
"capCents": 123,
"consumedCents": 123,
"estimateCents": 123
},
"details": [
{
"path": "<string>",
"param": "<string>",
"message": "<string>",
"code": "required"
}
]
},
"meta": {
"requestId": "<string>",
"hasMore": true,
"nextCursor": "<string>",
"asOf": 123
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"docUrl": "<string>",
"reason": "requester_unavailable",
"requiredPermission": "<string>",
"personRequired": true,
"decisionId": "<string>",
"capHeadroom": {
"remainingCents": 123,
"capCents": 123,
"consumedCents": 123,
"estimateCents": 123
},
"details": [
{
"path": "<string>",
"param": "<string>",
"message": "<string>",
"code": "required"
}
]
},
"meta": {
"requestId": "<string>",
"hasMore": true,
"nextCursor": "<string>",
"asOf": 123
}
}{
"error": {
"code": "internal_error",
"message": "<string>",
"docUrl": "<string>",
"reason": "requester_unavailable",
"requiredPermission": "<string>",
"personRequired": true,
"decisionId": "<string>",
"capHeadroom": {
"remainingCents": 123,
"capCents": 123,
"consumedCents": 123,
"estimateCents": 123
},
"details": [
{
"path": "<string>",
"param": "<string>",
"message": "<string>",
"code": "required"
}
]
},
"meta": {
"requestId": "<string>",
"hasMore": true,
"nextCursor": "<string>",
"asOf": 123
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"docUrl": "<string>",
"reason": "requester_unavailable",
"requiredPermission": "<string>",
"personRequired": true,
"decisionId": "<string>",
"capHeadroom": {
"remainingCents": 123,
"capCents": 123,
"consumedCents": 123,
"estimateCents": 123
},
"details": [
{
"path": "<string>",
"param": "<string>",
"message": "<string>",
"code": "required"
}
]
},
"meta": {
"requestId": "<string>",
"hasMore": true,
"nextCursor": "<string>",
"asOf": 123
}
}The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.
v2 compatibility notes
GET /api/v2/workflows/compareDebugAttempts
Returns an attempt beside baselineId, an earlier finished attempt of yours of the same node. Any other pair is a 404. An attempt never carries its agent thread or its creator.
Authentication
Personal key, External App credential or platform API key. Requires permissionworkflows:use, and the credential’s scopes must also reach workflows:read (a 403 naming it otherwise). Both are decided at the workflow’s home org unit. A debug attempt is personal, as in the Console: you debug drafts you created and read attempts you started. With a Personal key that is its owner; an External App or a platform key is its own creator (externalApp:<id>, apiKey:<id>). When draft debugging (workflow_debug_execution) is off for you (a Personal key’s owner) or for the deployment (an app or platform key), the route answers 409 conflict.
Query parameters
Responses
200 with data.attempt and data.baseline.
Errors
| Status | Code | When |
|---|---|---|
400 | bad_request | A parameter is missing, empty or repeated. |
403 | permission_denied | The credential lacks workflows:use or workflows:read. |
404 | resource_missing | ”Debug attempt not found”: either attempt is not yours or not reachable, or the pair is not an earlier finished attempt of the same node. |
409 | conflict | Draft debugging is off. |
Example
curl "$FORGE_BASE/api/v2/workflows/compareDebugAttempts?id=workflowDebugAttempts:a2&baselineId=workflowDebugAttempts:a1" \
-H "Authorization: Bearer $FORGE_PERSONAL_KEY"
Authorizations
BearerAuthPlatformApiKeyPersonalKey
Path Parameters
Query Parameters
⌘I
Compare two debug attempts
curl --request GET \
--url https://api.forge.gloo.com/api/v3/workflow-debug-attempts/{attemptId}/comparison \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.forge.gloo.com/api/v3/workflow-debug-attempts/{attemptId}/comparison"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.forge.gloo.com/api/v3/workflow-debug-attempts/{attemptId}/comparison', 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.forge.gloo.com/api/v3/workflow-debug-attempts/{attemptId}/comparison",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.forge.gloo.com/api/v3/workflow-debug-attempts/{attemptId}/comparison"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.forge.gloo.com/api/v3/workflow-debug-attempts/{attemptId}/comparison")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.forge.gloo.com/api/v3/workflow-debug-attempts/{attemptId}/comparison")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"attempt": {
"attemptId": "<string>",
"workflowId": "<string>",
"draftId": "<string>",
"targetNodeId": "<string>",
"sourceRunId": "<string>",
"sourceVersionId": "<string>",
"status": "preparing",
"targetSnapshot": "<unknown>",
"targetSnapshotHash": "<string>",
"resolvedInputs": [
"<unknown>"
],
"effectPlan": [
"<unknown>"
],
"blockers": [
{
"code": "<string>",
"message": "<string>",
"inputKey": "<string>",
"operationKey": "<string>",
"candidateMappings": [
{
"sourceNodeId": "<string>",
"outputKey": "<string>"
}
]
}
],
"traceId": "<string>",
"createdAt": 123,
"updatedAt": 123,
"targetLogicalNodeId": "<string>",
"workflowArguments": "<unknown>",
"planHash": "<string>",
"preparationExpiresAt": 123,
"launchRequestId": "<string>",
"output": "<unknown>",
"validation": {
"ok": true,
"errors": [
"<string>"
]
},
"error": {
"code": "<string>",
"message": "<string>",
"phase": "<string>"
},
"inputTokens": 123,
"outputTokens": 123,
"computeSeconds": 123,
"costUsd": 123,
"manifest": [
{
"relativePath": "<string>",
"sizeBytes": 123,
"sha256": "<string>",
"status": "pending",
"mimeType": "<string>",
"fileId": "<string>"
}
],
"captures": [
{
"sequenceNo": 123,
"operationKey": "<string>",
"adapterKey": "<string>",
"destination": "<string>",
"request": "<unknown>",
"createdAt": 123,
"response": "<unknown>"
}
],
"queuedAt": 123,
"startedAt": 123,
"completedAt": 123,
"cancelRequestedAt": 123
},
"baseline": {
"attemptId": "<string>",
"workflowId": "<string>",
"draftId": "<string>",
"targetNodeId": "<string>",
"sourceRunId": "<string>",
"sourceVersionId": "<string>",
"status": "preparing",
"targetSnapshot": "<unknown>",
"targetSnapshotHash": "<string>",
"resolvedInputs": [
"<unknown>"
],
"effectPlan": [
"<unknown>"
],
"blockers": [
{
"code": "<string>",
"message": "<string>",
"inputKey": "<string>",
"operationKey": "<string>",
"candidateMappings": [
{
"sourceNodeId": "<string>",
"outputKey": "<string>"
}
]
}
],
"traceId": "<string>",
"createdAt": 123,
"updatedAt": 123,
"targetLogicalNodeId": "<string>",
"workflowArguments": "<unknown>",
"planHash": "<string>",
"preparationExpiresAt": 123,
"launchRequestId": "<string>",
"output": "<unknown>",
"validation": {
"ok": true,
"errors": [
"<string>"
]
},
"error": {
"code": "<string>",
"message": "<string>",
"phase": "<string>"
},
"inputTokens": 123,
"outputTokens": 123,
"computeSeconds": 123,
"costUsd": 123,
"manifest": [
{
"relativePath": "<string>",
"sizeBytes": 123,
"sha256": "<string>",
"status": "pending",
"mimeType": "<string>",
"fileId": "<string>"
}
],
"captures": [
{
"sequenceNo": 123,
"operationKey": "<string>",
"adapterKey": "<string>",
"destination": "<string>",
"request": "<unknown>",
"createdAt": 123,
"response": "<unknown>"
}
],
"queuedAt": 123,
"startedAt": 123,
"completedAt": 123,
"cancelRequestedAt": 123
}
},
"meta": {
"requestId": "<string>",
"hasMore": true,
"nextCursor": "<string>",
"asOf": 123
}
}{
"error": {
"code": "bad_request",
"message": "<string>",
"docUrl": "<string>",
"reason": "requester_unavailable",
"requiredPermission": "<string>",
"personRequired": true,
"decisionId": "<string>",
"capHeadroom": {
"remainingCents": 123,
"capCents": 123,
"consumedCents": 123,
"estimateCents": 123
},
"details": [
{
"path": "<string>",
"param": "<string>",
"message": "<string>",
"code": "required"
}
]
},
"meta": {
"requestId": "<string>",
"hasMore": true,
"nextCursor": "<string>",
"asOf": 123
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"docUrl": "<string>",
"reason": "requester_unavailable",
"requiredPermission": "<string>",
"personRequired": true,
"decisionId": "<string>",
"capHeadroom": {
"remainingCents": 123,
"capCents": 123,
"consumedCents": 123,
"estimateCents": 123
},
"details": [
{
"path": "<string>",
"param": "<string>",
"message": "<string>",
"code": "required"
}
]
},
"meta": {
"requestId": "<string>",
"hasMore": true,
"nextCursor": "<string>",
"asOf": 123
}
}{
"error": {
"code": "forbidden",
"message": "<string>",
"docUrl": "<string>",
"reason": "requester_unavailable",
"requiredPermission": "<string>",
"personRequired": true,
"decisionId": "<string>",
"capHeadroom": {
"remainingCents": 123,
"capCents": 123,
"consumedCents": 123,
"estimateCents": 123
},
"details": [
{
"path": "<string>",
"param": "<string>",
"message": "<string>",
"code": "required"
}
]
},
"meta": {
"requestId": "<string>",
"hasMore": true,
"nextCursor": "<string>",
"asOf": 123
}
}{
"error": {
"code": "resource_missing",
"message": "<string>",
"docUrl": "<string>",
"reason": "requester_unavailable",
"requiredPermission": "<string>",
"personRequired": true,
"decisionId": "<string>",
"capHeadroom": {
"remainingCents": 123,
"capCents": 123,
"consumedCents": 123,
"estimateCents": 123
},
"details": [
{
"path": "<string>",
"param": "<string>",
"message": "<string>",
"code": "required"
}
]
},
"meta": {
"requestId": "<string>",
"hasMore": true,
"nextCursor": "<string>",
"asOf": 123
}
}{
"error": {
"code": "conflict",
"message": "<string>",
"docUrl": "<string>",
"reason": "requester_unavailable",
"requiredPermission": "<string>",
"personRequired": true,
"decisionId": "<string>",
"capHeadroom": {
"remainingCents": 123,
"capCents": 123,
"consumedCents": 123,
"estimateCents": 123
},
"details": [
{
"path": "<string>",
"param": "<string>",
"message": "<string>",
"code": "required"
}
]
},
"meta": {
"requestId": "<string>",
"hasMore": true,
"nextCursor": "<string>",
"asOf": 123
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"docUrl": "<string>",
"reason": "requester_unavailable",
"requiredPermission": "<string>",
"personRequired": true,
"decisionId": "<string>",
"capHeadroom": {
"remainingCents": 123,
"capCents": 123,
"consumedCents": 123,
"estimateCents": 123
},
"details": [
{
"path": "<string>",
"param": "<string>",
"message": "<string>",
"code": "required"
}
]
},
"meta": {
"requestId": "<string>",
"hasMore": true,
"nextCursor": "<string>",
"asOf": 123
}
}{
"error": {
"code": "internal_error",
"message": "<string>",
"docUrl": "<string>",
"reason": "requester_unavailable",
"requiredPermission": "<string>",
"personRequired": true,
"decisionId": "<string>",
"capHeadroom": {
"remainingCents": 123,
"capCents": 123,
"consumedCents": 123,
"estimateCents": 123
},
"details": [
{
"path": "<string>",
"param": "<string>",
"message": "<string>",
"code": "required"
}
]
},
"meta": {
"requestId": "<string>",
"hasMore": true,
"nextCursor": "<string>",
"asOf": 123
}
}{
"error": {
"code": "unauthorized",
"message": "<string>",
"docUrl": "<string>",
"reason": "requester_unavailable",
"requiredPermission": "<string>",
"personRequired": true,
"decisionId": "<string>",
"capHeadroom": {
"remainingCents": 123,
"capCents": 123,
"consumedCents": 123,
"estimateCents": 123
},
"details": [
{
"path": "<string>",
"param": "<string>",
"message": "<string>",
"code": "required"
}
]
},
"meta": {
"requestId": "<string>",
"hasMore": true,
"nextCursor": "<string>",
"asOf": 123
}
}
