BizKitHub
DocsAPI ReferenceBff/bff/ai-agent-action/detail
getBffAdmin BFF

/bff/ai-agent-action/detail

Assistant action proposal for the confirmation card

bffgetBffAi-agent-actionDetail

Parameters

1 query

Query parameters

· 1
idstringRequired

Agent action external id (24 chars).

Length: 24–24
Exampleexample_id

Response schema

1 status code documented

200Success
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
{
  "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

GET /bff/ai-agent-action/detail

get
curl -X GET "https://api.bizkithub.com/bff/ai-agent-action/detail?id=example_id" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key