Docs

Type a word or a question. Esc closes the search.

Sign in Start free

Generate an incident summary

Generates an AI summary artifact for the incident and returns its content, model usage and rating state.

POST https://app.upfour.io/v1/incidents/{incidentID}/ai/summary
POST https://app.upfour.io/v1/incidents/{incidentID}/ai/summary

A real request. Sending it changes data in your up4 account.

Authorization
AuthorizationA pls_ key. It stays in this browser tab. Needs incident.write.
Path
Headers

Sent directly from your browser to https://app.upfour.io/v1. Mutating calls get an automatic Idempotency-Key when the field is empty.

Request
Responsenot sent yet
Fill in a key and press Send request (⌘↵).
The answer appears here.
scope incident.write stable Idempotency-Key supported returns 201

Parameters

FieldTypeDescription
incidentID required uuid path parameter

Returns

A successful request returns 201 with application/json.

Response fields 1 top-level fields
FieldTypeDescription
data IncidentAIArtifact
IncidentAIArtifact · 16 fields
FieldTypeDescription
automatic boolean
billed_cost_cents integer
content_markdown string
created_at string (date-time)
generated_by uuid · nullable
id uuid
incident_id uuid
input_tokens integer
kind string one ofsummarypostmortem
model string
output_tokens integer
provider_cost_cents number
rated_at string (date-time) · nullable
rated_by uuid · nullable
rating integer · nullable 1 (helpful), -1 (not helpful) or null until rated.
updated_at string (date-time)

Errors

Only the errors this operation can return. Every error uses the same envelope.

Status Code Meaning
402 ai_billing_blocked AI features are switched off because the Company has no active credit. When: An AI summary or postmortem request while the Company has no active credit. Fix: Top up the credit, then retry. ai_billing_blocked: AI features are switched off while the Company is paused or in its grace window. A used-up monthly AI budget also answers 402, with the body {error, quota}.
422 ai_budget_above_platform_limit The monthly AI budget is above the platform limit. When: Saving an AI budget larger than the platform allows; details.limit gives the maximum. Fix: Set a budget at or below details.limit.
422 ai_call_cap_above_platform_limit The monthly AI call cap is above the platform limit. When: Saving an AI call cap larger than the platform allows; details.limit gives the maximum. Fix: Set a cap at or below details.limit.
400 bad_request The request is malformed or fails validation.
409 conflict The request conflicts with the current state.
404 not_found The requested resource does not exist or is outside the caller's scope.
403 permission_denied The credentials do not permit this action.
503 service_unavailable The service or a required dependency is temporarily unavailable.

Every call can also return unauthorized (401), rate_limit_exceeded (429) or internal_error (500 / 502). See Responses and errors.