BizKitHub
DocsAPI ReferenceIssue/bff/issue/generate-summary
postIssueAdmin BFF

/bff/issue/generate-summary

Runs the summarizer on the current description and stores the result into pm__issue.ai_summary. Idempotent — safe to call repeatedly. Returns aiSummary: null when the description is empty or the LLM failed to produce output (in which case the column is nulled out).

IssuepostBffIssueGenerate-summary

Parameters

JSON body

Request body

application/json
issueKeystringRequired

Issue key to summarize.

ExamplePROJ-123

Response schema

1 status code documented

200Success
successbooleanRequired

Whether the request completed.

aiSummarystring | nullRequired
One of 2:
Variant 1
string

Newly-generated summary, or null when the description was empty or the LLM produced nothing usable.

Variant 2
null

Response example

application/json
{
  "success": false
}

Request example

POST /bff/issue/generate-summary

post
curl -X POST "https://api.bizkithub.com/bff/issue/generate-summary" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "issueKey": "PROJ-123"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key