curl --request GET \
--url https://api.lightsage.com/v2/tasks/{task_id} \
--header 'X-Lightsage-Api-Key: <api-key>'import requests
url = "https://api.lightsage.com/v2/tasks/{task_id}"
headers = {"X-Lightsage-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Lightsage-Api-Key': '<api-key>'}};
fetch('https://api.lightsage.com/v2/tasks/{task_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.lightsage.com/v2/tasks/{task_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-Lightsage-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://api.lightsage.com/v2/tasks/{task_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Lightsage-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://api.lightsage.com/v2/tasks/{task_id}")
.header("X-Lightsage-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lightsage.com/v2/tasks/{task_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Lightsage-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"action_date": "<string>",
"batch_number": 123,
"rank": 123,
"source_key": "<string>",
"task_type": "<string>",
"title": "<string>",
"why": "<string>",
"next_action": "<string>",
"execution_prompt": "<string>",
"effort": "<string>",
"status": "<string>",
"description": "<string>",
"content": "<string>",
"target_url": "<string>",
"content_status": "none",
"content_written_at": "<string>",
"reasoning": "<string>",
"evidence": {},
"score": 123,
"priority": "<string>",
"assignee_user_id": "<string>",
"function_area": "<string>",
"action_type": "<string>",
"source": "<string>",
"source_type": "<string>",
"source_refs": {},
"metadata": {},
"created_at": "<string>",
"updated_at": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Retrieve Task
Returns one persisted task and its execution prompt.
curl --request GET \
--url https://api.lightsage.com/v2/tasks/{task_id} \
--header 'X-Lightsage-Api-Key: <api-key>'import requests
url = "https://api.lightsage.com/v2/tasks/{task_id}"
headers = {"X-Lightsage-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Lightsage-Api-Key': '<api-key>'}};
fetch('https://api.lightsage.com/v2/tasks/{task_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.lightsage.com/v2/tasks/{task_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-Lightsage-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://api.lightsage.com/v2/tasks/{task_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Lightsage-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://api.lightsage.com/v2/tasks/{task_id}")
.header("X-Lightsage-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lightsage.com/v2/tasks/{task_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Lightsage-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"action_date": "<string>",
"batch_number": 123,
"rank": 123,
"source_key": "<string>",
"task_type": "<string>",
"title": "<string>",
"why": "<string>",
"next_action": "<string>",
"execution_prompt": "<string>",
"effort": "<string>",
"status": "<string>",
"description": "<string>",
"content": "<string>",
"target_url": "<string>",
"content_status": "none",
"content_written_at": "<string>",
"reasoning": "<string>",
"evidence": {},
"score": 123,
"priority": "<string>",
"assignee_user_id": "<string>",
"function_area": "<string>",
"action_type": "<string>",
"source": "<string>",
"source_type": "<string>",
"source_refs": {},
"metadata": {},
"created_at": "<string>",
"updated_at": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Path Parameters
Response
Successful Response
Sort order within the batch, ascending; values need not start at 1.
A finding key namespaced by source, such as api_perf:https://example.com/docs/cli.
A free-form label such as Redirect or Docs; this field is not an enum.
A free-form effort estimate such as Low or Medium; this field is not an enum.
The workflow status. New tasks start as new. A task is in_review while its content waits to go live, as an open pull request or a CMS draft; it is listed with in_progress tasks. added_to_sheet and snoozed tasks are listed only when status=all.
The task's Markdown write-up covering what went wrong, how to fix it, the impact, and the evidence. Null until the write-up is generated; see content_status.
The page the fix should be made on, when the task targets one.
Progress of the Markdown write-up in content.
none, writing, ready, failed When the write-up in content was last generated.
Supporting evidence with keys such as expected_lift, failure_traces, source_prompts, and source_urls.
Planner impact score; manually created tasks may be unscored.
A free-form source type such as api_performance; manually created tasks may not have a source.
Source references needed to understand or execute the task.
Additional task metadata, including source_key, impact_score, disposition, target_urls, edit_locations (where on the target page each change goes: url, anchor heading, placement of in, after, or before, and change), evidence_summary, source_start_date, and source_end_date.