Skip to main content

​
Action precheck

Evaluate whether a supported external action is allowed and whether it would charge credits, without executing it. Use this endpoint when you need truth data such as allowed, should_charge, credits, reason_code, and action-specific detail before running an action.

​
Endpoint

POST /external/actions/precheck

​
Authentication

See Authentication

​
Success status code

200 OK

​
Request body

NameRequiredTypeNotes
action_typeYesstringAction code to evaluate.
paramsYesobjectAction-specific input payload.
localeNostringOptional locale hint.

​
Response example

{
  "ok": true,
  "action_type": "<action-code>",
  "allowed": true,
  "should_charge": false,
  "credits": 0,
  "reason_code": "ok",
  "detail": {
    "event_id": "139574",
    "access_mode": "preview",
    "preview_limit": 50
  }
}

​
Error responses

  • 400 Bad Request
  • 401 Unauthorized

​
Notes

  • Use this endpoint to check whether an action is allowed and whether it would consume credits.
  • detail returns context for the requested action, such as preview-access guidance or unlock-related information.