USusesapient
Tasks

Retrieve Task

Changed on

Returns one persisted task and its execution prompt.

get/v1/tasks/{task_id}

Request

  • Base URL
    https://api.lightsage.com
  • Auth
    API key in header X-Lightsage-Api-Key

Path parameters

task_idstring required

Response

Successful Response

idstring required
action_datestring required
batch_numberinteger required
rankinteger required

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

source_keystring required

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

task_typestring required

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

titlestring required
whystring required
next_actionstring required
descriptionstring nullable
execution_promptstring required
contentstring nullable

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_urlstring nullable

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

content_status'none' | 'writing' | 'ready' | 'failed'

Progress of the Markdown write-up in content.

content_written_atstring nullable

When the write-up in content was last generated.

reasoningstring nullable
evidenceobject

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

scorenumber nullable

Planner impact score; manually created tasks may be unscored.

effortstring required

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

prioritystring nullable
statusstring 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.

assignee_user_idstring nullable
function_areastring nullable
action_typestring nullable
sourcestring nullable
source_typestring nullable

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

source_refsobject

Source references. For api_performance tasks, keys include kind, brand_id, failed_url, fail_count, and per-run traces.

metadataobject

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_atstring nullable
updated_atstring nullable

Changes

  • ed90d98158deRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status