Skip to main content
GET
Retrieve Task

Authorizations

X-Lightsage-Api-Key
string
header
required

Path Parameters

task_id
string
required

Response

Successful Response

id
string
required
action_date
string
required
batch_number
integer
required
rank
integer
required

Sort order within the batch, ascending; values need not start at 1.

source_key
string
required

A finding key namespaced by source, such as api_perf:https://example.com/docs/cli.

task_type
string
required

A free-form label such as Redirect or Docs; this field is not an enum.

title
string
required
why
string
required
next_action
string
required
execution_prompt
string
required
effort
string
required

A free-form effort estimate such as Low or Medium; this field is not an enum.

status
string
required

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.

description
string | null
content
string | null

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.

target_url
string | null

The page the fix should be made on, when the task targets one.

content_status
enum<string>
default:none

Progress of the Markdown write-up in content.

Available options:
none,
writing,
ready,
failed
content_written_at
string | null

When the write-up in content was last generated.

reasoning
string | null
evidence
Evidence · object

Supporting evidence with keys such as expected_lift, failure_traces, source_prompts, and source_urls.

score
number | null

Planner impact score; manually created tasks may be unscored.

priority
string | null
assignee_user_id
string | null
function_area
string | null
action_type
string | null
source
string | null
source_type
string | null

A free-form source type such as api_performance; manually created tasks may not have a source.

source_refs
Source Refs · object

Source references needed to understand or execute the task.

metadata
Metadata · object

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.

created_at
string | null
updated_at
string | null