curl --request GET \
--url https://agents.bigdata.com/v1/workflow/executions/{execution_id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://agents.bigdata.com/v1/workflow/executions/{execution_id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://agents.bigdata.com/v1/workflow/executions/{execution_id}', 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://agents.bigdata.com/v1/workflow/executions/{execution_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-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"
"net/http"
"io"
)
func main() {
url := "https://agents.bigdata.com/v1/workflow/executions/{execution_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://agents.bigdata.com/v1/workflow/executions/{execution_id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://agents.bigdata.com/v1/workflow/executions/{execution_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"date_created": "2023-11-07T05:31:56Z",
"execution_id": "<string>",
"is_owner": true,
"is_public": true,
"last_updated": "2023-11-07T05:31:56Z",
"name": "<string>",
"status": "pending",
"consumption": [
{
"input_tokens": 123,
"output_tokens": 123,
"type": "base",
"cached_tokens": 0
}
],
"events": [
{
"content": "<string>",
"message_id": "<string>",
"role": "assistant",
"type": "THINKING"
}
],
"template_id": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Get Execution
Retrieve a stored workflow execution by ID, including its status, resource consumption, and the full result stream replayed in order. This is how you read a run’s result after the streaming connection has closed.
curl --request GET \
--url https://agents.bigdata.com/v1/workflow/executions/{execution_id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://agents.bigdata.com/v1/workflow/executions/{execution_id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://agents.bigdata.com/v1/workflow/executions/{execution_id}', 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://agents.bigdata.com/v1/workflow/executions/{execution_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-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"
"net/http"
"io"
)
func main() {
url := "https://agents.bigdata.com/v1/workflow/executions/{execution_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://agents.bigdata.com/v1/workflow/executions/{execution_id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://agents.bigdata.com/v1/workflow/executions/{execution_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"date_created": "2023-11-07T05:31:56Z",
"execution_id": "<string>",
"is_owner": true,
"is_public": true,
"last_updated": "2023-11-07T05:31:56Z",
"name": "<string>",
"status": "pending",
"consumption": [
{
"input_tokens": 123,
"output_tokens": 123,
"type": "base",
"cached_tokens": 0
}
],
"events": [
{
"content": "<string>",
"message_id": "<string>",
"role": "assistant",
"type": "THINKING"
}
],
"template_id": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Authorizations
API key for authentication.
Path Parameters
Response
Successful Response
A stored workflow execution with its result stream replayed in order.
When the execution was created.
Unique identifier for the execution.
Whether the authenticated caller owns this execution.
Whether the execution is shared through a public link.
When the execution was last updated.
Human-readable name of the execution.
Current lifecycle status of the run.
pending, running, completed, error, cancelled Resource usage breakdown for the run.
Token usage for a specific model tier.
- TokenTierConsumption
- SearchConsumption
- StructuredDataConsumption
- SearchEndpointConsumption
Show child attributes
Show child attributes
The run's streamed messages, replayed in order — the same message types delivered live during execution (answer, grounding, charts, and so on). Null while the run is still in progress.
The agent's intermediate reasoning while researching.
- ThinkingMessage
- ActionMessage
- AnswerMessage
- CompleteMessage
- ErrorMessage
- AuditMessage
- GroundingMessage
- ChartMessage
- ToolErrorMessage
- PlanningMessage
- LlmRetryMessage
- StructuredOutputMessage
Show child attributes
Show child attributes
ID of the template that ran, if any.
Was this page helpful?