Agent Insights Jobs

Update Agent Insights project guidance

Changed on

Saves the project guidance sent to every Agent Insights run, creating the job (disabled) if the project has none. Empty or whitespace-only clears it. The guidance version is bumped only when the text changes. 404 while guidance is not enabled.

put/v1/private/agent-insights/jobs/{projectId}/guidance

Request

  • Base URL
    http://localhost:5173/api
  • URL
    http://localhost:5173/api/v1/private/agent-insights/jobs/{projectId}/guidance
  • Auth
    none declared

Path parameters

projectIdstring uuid required

Request body

guidancestring required

Project guidance for Agent Insights runs. Empty or whitespace-only clears it

Response

Job with the saved guidance

idstring uuid
project_idstring uuid required
status'enabled' | 'disabled'
auto_first_run_enrolledboolean
auto_first_run_atstring date-time
last_scan_atstring date-time
last_failure_reasonstring
last_failure_detailstring
last_failed_atstring date-time
guidancestring

Project guidance sent to every run; null when none

guidance_updated_bystring

Who last saved the guidance

guidance_updated_atstring date-time

When the guidance was last saved

guidance_versioninteger

Bumped each time the guidance text changes; 0 = never saved

results_guidance_versioninteger

Guidance version the current results were produced with; null = no run since guidance existed

created_atstring date-time
created_bystring
last_updated_atstring date-time
last_updated_bystring

Changes