curl --request GET \
--url https://api.example.com/api/crew-runs/{run_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/crew-runs/{run_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/crew-runs/{run_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://api.example.com/api/crew-runs/{run_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 => [
"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.example.com/api/crew-runs/{run_id}"
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.example.com/api/crew-runs/{run_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/crew-runs/{run_id}")
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{
"id": "<string>",
"correlation_id": "<string>",
"owner_id": "<string>",
"status": "pending",
"created_at": "<string>",
"crew_type": "<string>",
"crew_config": {
"agents": [
{
"id": "<string>",
"ref": {
"artifact_id": "<string>",
"version": "<string>"
},
"role": "",
"goal": "",
"backstory": ""
}
],
"tasks": [
{
"description": "<string>",
"agent_index": 0,
"expected_output": "",
"context": [
123
]
}
],
"id": "<string>",
"verbose": false,
"process": "sequential",
"layout": {},
"context_packs": [
{
"artifact_id": "<string>",
"version": "<string>",
"token_budget": 101
}
],
"repository": {
"repos": [
{
"artifact_id": "<string>",
"version": "<string>"
}
],
"branch_prefix": "nx1/",
"max_files": 5,
"max_lines": 200,
"may_open_pr": true,
"may_comment": false
}
},
"task_input": {},
"result": "<string>",
"error": "<string>",
"started_at": "<string>",
"completed_at": "<string>",
"parent_run_id": "<string>",
"replayed_from_task": 123,
"schedule_id": "<string>",
"run_trigger": "<string>",
"template_id": "<string>",
"resolved_pins": {},
"template_name": "<string>",
"run_as": "<string>",
"run_as_kind": "<string>",
"artifacts": []
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Get run
Get a single crew run by ID.
Any charts or dashboards the run created are returned in artifacts,
resolved against the analytics provider at read time.
curl --request GET \
--url https://api.example.com/api/crew-runs/{run_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/crew-runs/{run_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/crew-runs/{run_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://api.example.com/api/crew-runs/{run_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 => [
"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.example.com/api/crew-runs/{run_id}"
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.example.com/api/crew-runs/{run_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/crew-runs/{run_id}")
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{
"id": "<string>",
"correlation_id": "<string>",
"owner_id": "<string>",
"status": "pending",
"created_at": "<string>",
"crew_type": "<string>",
"crew_config": {
"agents": [
{
"id": "<string>",
"ref": {
"artifact_id": "<string>",
"version": "<string>"
},
"role": "",
"goal": "",
"backstory": ""
}
],
"tasks": [
{
"description": "<string>",
"agent_index": 0,
"expected_output": "",
"context": [
123
]
}
],
"id": "<string>",
"verbose": false,
"process": "sequential",
"layout": {},
"context_packs": [
{
"artifact_id": "<string>",
"version": "<string>",
"token_budget": 101
}
],
"repository": {
"repos": [
{
"artifact_id": "<string>",
"version": "<string>"
}
],
"branch_prefix": "nx1/",
"max_files": 5,
"max_lines": 200,
"may_open_pr": true,
"may_comment": false
}
},
"task_input": {},
"result": "<string>",
"error": "<string>",
"started_at": "<string>",
"completed_at": "<string>",
"parent_run_id": "<string>",
"replayed_from_task": 123,
"schedule_id": "<string>",
"run_trigger": "<string>",
"template_id": "<string>",
"resolved_pins": {},
"template_name": "<string>",
"run_as": "<string>",
"run_as_kind": "<string>",
"artifacts": []
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
ID of the run record.
Response
Successful Response
A persisted crew run plus the visualizations it produced.
Unique ID for this run record.
ID shared with the live run, used for polling while it runs.
Keycloak username of the user who started the run.
State of the run: pending, running, completed, or failed.
pending, running, completed, failed Creation time of the run. Represented as an ISO 8601 timestamp.
Preset crew type, or null for a custom crew.
The crew definition that ran. Null if parsing failed.
Show child attributes
Show child attributes
This run's task input.
The crew's output, present only on a successful run.
The failure reason, present only on a failed run.
Time the run started executing. Represented as an ISO 8601 timestamp. Null before it starts.
Time the run finished. Represented as an ISO 8601 timestamp. Null while it still runs.
The run this one restarted, when run_trigger is replay. Null otherwise.
The task index a replay started at. Null for other runs.
The crew schedule that started this run. Null for a run started directly.
What started the run: api, chat, schedule (a cron slot) or run_now. Null for runs from before this was recorded.
The crew template the run came from, if any.
Registry artifact id to the exact version that ran.
Show child attributes
Show child attributes
The crew template's name, if it came from one that still exists.
Who the run acted as, when that isn't owner_id: a service identity's service account.
identity for a service identity; null for the owner.
Show child attributes
Show child attributes
Was this page helpful?

