ESescape
Issues

Generate AI remediation for an issue

Trigger the asynchronous generation of AI remediation for an issue. Generation only schedules a job: read the result back with GET /v3/issues/{issueId}, on remediation for the full issue-panel remediation or on aiRemediationSummary for the short overview summary. Generating the full remediation clears the previous remediation and its feedback immediately. Generating the summary replaces the previous summary, and resets its rating, only once the generation job succeeds. Identical requests repeated within a short window are ignored and return generated: false.

post/issues/{issueId}/ai-remediation

Request

  • Base URL
    https://public.escape.tech/v3
  • Auth
    API key in header X-ESCAPE-API-KEY

Path parameters

issueIdstring uuid required

The issue ID

Example:00000000-0000-0000-0000-000000000000

Request body

kind'remediation' | 'summary'

Which AI remediation artefact to act on: remediation for the full issue-panel remediation, summary for the short overview summary.

Response

OK

kind'remediation' | 'summary' required

The AI remediation that was requested

generatedboolean required

Whether the generation request was accepted. False when an identical request is already in flight.

clearedboolean required

Whether this trigger synchronously cleared an existing full remediation (and its feedback). Always false for the summary kind, which is replaced asynchronously once the generation job succeeds.

Changes

No recorded changes to this operation across all 1 revision of this API.