tools
tools

Preview tool execution

Preview what a tool will do without executing it.

Returns a preview card and guard check results.

post/api/tools/{tool_id}/preview

Request

  • Base URL: https://api.dialogbrain.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.dialogbrain.com/api/tools/{tool_id}/preview
  • Auth: none declared

Path parameters

tool_idstring required

Request body

tool_idstring required

ID of the tool to preview

paramsobject

Tool parameters

mode'draft' | 'auto' | 'supervised' | 'autonomous' | 'background_draft' | 'post_approval' | 'sandbox' | 'voice'

Execution modes for the AI agent.

thread_idstring nullable

Thread/channel ID for context

Response

Successful Response

object required

Changes

No recorded changes to this operation across all 5 revisions of this API.