v1

latestOpenAPI 3.0.02026-07-241220330.3 KB

AI Analysis

Generate an AI analysis summary

Kicks off asynchronous AI summary generation for the given resource token. Returns 202 immediately if generation was enqueued, or 200 with the existing summary if one has already been generated for the resource.

An ai_analysis_completed webhook is delivered once generation finishes. To receive webhooks instead of polling, see Webhook Events.

post/ai-analysis

Request body

resource_tokenstring required

Token of the resource to summarize. Accepts an Evaluation (L-), Journey Application (JA-), or Investigation (INV-) token.

Example request

{
  "resource_token": "L-aBcDeFgHiJkLmNoPqRsT"
}

Response

A summary already exists for this resource.

summarystring required

Generated AI summary text.

summary_message_uuidstring required

UUID of the LLM message that produced the summary.

created_atstring date-time required

ISO 8601 timestamp when the summary was first created.

updated_atstring date-time required

ISO 8601 timestamp when the summary was last updated.

resource_type'evaluation' | 'journey_application' | 'investigation' required

Type of resource the summary belongs to.

is_staleboolean required

Whether the summary predates a material change to the underlying resource and may be out of date.

Example response

{
  "summary": "The applicant...",
  "summary_message_uuid": "3f9a2b1c-4d5e-6f70-8192-a3b4c5d6e7f8",
  "created_at": "2026-06-18T00:00:00.000Z",
  "updated_at": "2026-06-18T00:00:00.000Z",
  "resource_type": "evaluation"
}