Sign in
Suggestion

Read a suggestion

Get a single suggestion by ID.

get/action_item/{actionItemId}/suggestions/{id}

Path parameters

actionItemIdstring required

The action item ID.

idstring required

The suggestion ID.

Response

The suggestion.

idstring

The unique suggestion ID.

slugstring

Auto-generated URL-friendly slug.

action_item_idstring

The parent action item ID.

status'pending' | 'approved' | 'applied' | 'failed' | 'rejected' | 'expired'

The current status.

created_bystring

The agent that created the suggestion.

ownerstring

The agent or system that will execute the fix.

confidencenumber

Confidence score between 0 and 1.

descriptionstring

A description of the proposed fix. Supports Markdown.

metadataobject

Machine-to-machine metadata for the executor.

user_metadataobject

Human-editable parameters.

user_metadata_configobject

JSON Schema for rendering user_metadata in the UI.

executed_atstring date

Date when the suggestion was executed.

expires_atstring date

Expiration date.

created_atstring date-time

Creation timestamp.

updated_atstring date-time

Last update timestamp.

Example response

{
  "id": "sUg123AbCdEf",
  "slug": "update-dockerfile-base-image",
  "action_item_id": "xYz789AbCdEf",
  "status": "pending",
  "created_by": "security-scanner-agent",
  "owner": "image-updater-agent",
  "confidence": 0.92,
  "description": "Update the Dockerfile base image to resolve CVE-2026-1234.",
  "metadata": {
    "repository": "org/my-api-service",
    "branch": "fix/cve-2026-1234"
  },
  "user_metadata": {
    "target_version": "20-alpine3.19"
  },
  "execution_result": {
    "success": true,
    "message": "Base image updated successfully.",
    "details": {
      "pull_request": "https://github.com/org/my-api-service/pull/42"
    }
  },
  "expires_at": "2026-05-15",
  "created_at": "2026-04-06T12:30:00.000Z",
  "updated_at": "2026-04-06T12:30:00.000Z"
}

Changes