BizKitHub
DocsAPI ReferenceIssue/bff/issue/run-ai-workflow
postIssueAdmin BFF

/bff/issue/run-ai-workflow

Manually triggers the AI issue-resolving agent on a single issue. The agent reads the issue, comments, reporter contact and any read-only tools it needs, then may post a comment, change status, change priority, or reassign to a member (each at most once per turn). Returns the write actions performed so the caller can invalidate its cache. This endpoint does NOT re-run the base workflow, so the reporter is never notified twice about issue creation. When the ticket carries pm__issue.human_only = true, the agent aborts and returns skipped: 'human_only'.

IssuepostBffIssueRun-ai-workflow

Parameters

JSON body

Request body

application/json
issueKeystringRequired

Issue key to process.

ExamplePROJ-123

Response schema

1 status code documented

200Success
successbooleanRequired

Whether the agent ran successfully.

skipped"spam" | "human_only" | nullRequired
One of 2:
Variant 1
"spam" | "human_only"
Variant 2
null
actionsobject | object | object | object[]Required

Ordered list of write actions the agent performed during this run. Empty when the agent decided not to act.

Each array item:
object | object | object | object
One of 4:
Variant 1
kind"comment"Required
commentIdstringRequired

Server-side comment id (matches selectIssueCommentList item.id).

messagestringRequired

Comment body as posted.

Variant 2
kind"status"Required
toStatusIdnumberRequired
toStatusLabelstringRequired
toCategoryCodestringRequired
Variant 3
kind"priority"Required
toPrioritynumberRequired

1=low, 2=normal, 3=high, 4=critical, 5=blocker.

Variant 4
kind"assign"Required
toContactIdnumberRequired

shop__contact.id of the newly-assigned member.

toMemberNamestringRequired

Display name of the assigned member.

reasoningstringRequired

The AI's short justification for this assignment. Also embedded in the notification e-mail.

Response example

application/json
{
  "success": false,
  "actions": []
}

Request example

POST /bff/issue/run-ai-workflow

post
curl -X POST "https://api.bizkithub.com/bff/issue/run-ai-workflow" \
  -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