Scans
Beta

Generate an AI summary for a scan target

Generate an AI exploration or pentesting summary for a target of a DAST scan and return it. The target must belong to the scan. Generated summaries are also readable on the target through the scan targets endpoint.

post/scans/{scanId}/targets/ai-summaries

Request

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

Path parameters

scanIdstring uuid required

The scan ID

Example:00000000-0000-0000-0000-000000000000

Request body

targetIdstring uuid required

The ID of the target to summarize

kind'EXPLORATION' | 'PENTESTING' required

The kind of summary to generate

Example request

{
  "targetId": "00000000-0000-0000-0000-000000000001",
  "kind": "EXPLORATION"
}

Response

OK

summarystring required

The generated summary, in Markdown

Changes

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