Inspect background task status
GET
/
background
/
tasks
/
{task_id}
/
status
Inspect background task status
curl --request GET \
--url http://localhost:8000/background/tasks/{task_id}/statusimport requests
url = "http://localhost:8000/background/tasks/{task_id}/status"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://localhost:8000/background/tasks/{task_id}/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8000",
CURLOPT_URL => "http://localhost:8000/background/tasks/{task_id}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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 := "http://localhost:8000/background/tasks/{task_id}/status"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:8000/background/tasks/{task_id}/status")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8000/background/tasks/{task_id}/status")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"active_runs": 123,
"agent_id": "<string>",
"enabled": true,
"latest_run": {
"agent_id": "<string>",
"query_snapshot": "<string>",
"session_id": "<string>",
"task_id": "<string>",
"trigger_type": "manual",
"workspace_path": "<string>",
"attempt": 0,
"cancel_requested_at": "2023-11-07T05:31:56Z",
"claimed_at": "2023-11-07T05:31:56Z",
"due_at": "2023-11-07T05:31:56Z",
"error": "<string>",
"finished_at": "2023-11-07T05:31:56Z",
"heartbeat_at": "2023-11-07T05:31:56Z",
"lease_expires_at": "2023-11-07T05:31:56Z",
"lease_generation": 0,
"lease_owner": "<string>",
"lease_token": "<string>",
"max_attempts": 1,
"metadata": {},
"occurrence_id": "<string>",
"queued_at": "2023-11-07T05:31:56Z",
"result_preview": "<string>",
"run_id": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"status": "queued",
"trigger_metadata": {},
"triggered_at": "2023-11-07T05:31:56Z"
},
"runs": 123,
"schedule": {
"type": "manual",
"end_at": "2023-11-07T05:31:56Z",
"expression": "<string>",
"jitter_seconds": 123,
"misfire_policy": "skip_missed",
"run_at": "2023-11-07T05:31:56Z",
"seconds": 123,
"start_at": "2023-11-07T05:31:56Z",
"timezone": "UTC"
},
"schedule_state": {
"task_id": "<string>",
"last_dispatched_at": "2023-11-07T05:31:56Z",
"last_due_at": "2023-11-07T05:31:56Z",
"misfire_cursor": "<string>",
"next_due_at": "2023-11-07T05:31:56Z",
"paused": false,
"paused_reason": "<string>",
"schedule_revision": 1,
"updated_at": "2023-11-07T05:31:56Z"
},
"status_counts": {},
"task_id": "<string>"
}{
"detail": "<unknown>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}{
"detail": "<unknown>"
}Path Parameters
Response
Successful Response
Inspectable status for one background task.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I
Inspect background task status
curl --request GET \
--url http://localhost:8000/background/tasks/{task_id}/statusimport requests
url = "http://localhost:8000/background/tasks/{task_id}/status"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://localhost:8000/background/tasks/{task_id}/status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8000",
CURLOPT_URL => "http://localhost:8000/background/tasks/{task_id}/status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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 := "http://localhost:8000/background/tasks/{task_id}/status"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:8000/background/tasks/{task_id}/status")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8000/background/tasks/{task_id}/status")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"active_runs": 123,
"agent_id": "<string>",
"enabled": true,
"latest_run": {
"agent_id": "<string>",
"query_snapshot": "<string>",
"session_id": "<string>",
"task_id": "<string>",
"trigger_type": "manual",
"workspace_path": "<string>",
"attempt": 0,
"cancel_requested_at": "2023-11-07T05:31:56Z",
"claimed_at": "2023-11-07T05:31:56Z",
"due_at": "2023-11-07T05:31:56Z",
"error": "<string>",
"finished_at": "2023-11-07T05:31:56Z",
"heartbeat_at": "2023-11-07T05:31:56Z",
"lease_expires_at": "2023-11-07T05:31:56Z",
"lease_generation": 0,
"lease_owner": "<string>",
"lease_token": "<string>",
"max_attempts": 1,
"metadata": {},
"occurrence_id": "<string>",
"queued_at": "2023-11-07T05:31:56Z",
"result_preview": "<string>",
"run_id": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"status": "queued",
"trigger_metadata": {},
"triggered_at": "2023-11-07T05:31:56Z"
},
"runs": 123,
"schedule": {
"type": "manual",
"end_at": "2023-11-07T05:31:56Z",
"expression": "<string>",
"jitter_seconds": 123,
"misfire_policy": "skip_missed",
"run_at": "2023-11-07T05:31:56Z",
"seconds": 123,
"start_at": "2023-11-07T05:31:56Z",
"timezone": "UTC"
},
"schedule_state": {
"task_id": "<string>",
"last_dispatched_at": "2023-11-07T05:31:56Z",
"last_due_at": "2023-11-07T05:31:56Z",
"misfire_cursor": "<string>",
"next_due_at": "2023-11-07T05:31:56Z",
"paused": false,
"paused_reason": "<string>",
"schedule_revision": 1,
"updated_at": "2023-11-07T05:31:56Z"
},
"status_counts": {},
"task_id": "<string>"
}{
"detail": "<unknown>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}{
"detail": "<unknown>"
}