BizKitHub
DocsAPI ReferenceBff/bff/ai-agent-action/cancel
postBffAdmin BFF

/bff/ai-agent-action/cancel

Decline an Assistant action

bffpostBffAi-agent-actionCancel

Parameters

JSON body

Request body

application/json
idstringRequired

Agent action external id (24 chars).

Length: 24–24

Response schema

1 status code documented

200Success
acceptedbooleanRequired
actionobjectRequired
idstringRequired
kindstringRequired
status"pending" | "executing" | "executed" | "failed" | "cancelled" | "expired"Required
previewobjectRequired
fieldsobject[]Required
Each array item:
keystringRequired
valuestringRequired
bodystringOptional
attachmentsobject[]Optional
Each array item:
namestringRequired
sizenumberRequired
warningsstring[]Optional
payloadHashstringRequired
expiresAtstringRequired
decidedAtstringOptional
executedAtstringOptional
resultobjectOptional
errorstringOptional

Response example

application/json
{
  "accepted": false,
  "action": {
    "id": "example_id",
    "kind": "example_kind",
    "preview": {
      "fields": [
        {
          "key": "example_key",
          "value": "example_value"
        }
      ],
      "body": "example_body",
      "attachments": [
        {
          "name": "example_name",
          "size": 0
        }
      ],
      "warnings": [
        "string"
      ]
    },
    "payloadHash": "example_payloadHash",
    "expiresAt": "example_expiresAt",
    "decidedAt": "example_decidedAt",
    "executedAt": "example_executedAt",
    "result": {},
    "error": "example_error"
  }
}

Request example

POST /bff/ai-agent-action/cancel

post
curl -X POST "https://api.bizkithub.com/bff/ai-agent-action/cancel" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "id": "example_id"
}'

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key