Tool catalog

List the workspaces this token can act in, with the role and effective scopes it holds in each. Call this first, then pass a workspace subdomain to every other tool.

• workspaces array required
  each item: object

  • subdomain string required
  • name string required
  • role string required
  • scopes array required
    each item: string

Add a source that crawls a fixed list of URLs into a knowledge collection.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• collection_id integer required
• name string required
• urls any required

  Array of URLs, or a newline-separated string of URLs

• sync_frequency string optional one of manual daily weekly monthly

• source_id integer required
• name string required
• url_count integer required

Add a source that crawls an entire website into a knowledge collection.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• collection_id integer required
• name string required
• base_url string required
• max_pages integer optional
• sync_frequency string optional one of manual daily weekly monthly

• source_id integer required
• name string required
• base_url string required

Create a new knowledge collection in the workspace.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• name string required
• description string optional

• collection_id integer required
• name string required

Delete a knowledge document.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• document_id integer required

• document_id integer required
• deleted boolean required one of true

Delete a knowledge source and its documents.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• source_id integer required

• source_id integer required
• deleted boolean required one of true

Fetch the full text of one knowledge document by id.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• document_id integer required

• document_id integer required
• title string required
• content_type string required one of text markdown
• content string or null required

Re-queue a knowledge document for processing and embedding.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• document_id integer required

• document_id integer required
• status string required one of pending processing processed error

Search the workspace knowledge base and return relevant passages.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• query string required
• limit integer optional

• results array required
  each item: object

  • document_id integer required
  • title string required
  • content string required
  • score number required

Trigger an immediate re-sync of a knowledge source.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• source_id integer required

• source_id integer required
• status string required one of pending syncing active error

Update a knowledge collection's name or description.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• collection_id integer required
• name string optional
• description string optional

• collection_id integer required
• name string required
• description string or null required

Add a column to a workspace storage table.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• table string required
• name string required
• type string required
• encrypted boolean optional

• table string required
• columns array required
  each item: object

  • name string required
  • type string required
  • encrypted boolean required

Delete several rows from a workspace storage table, by lookup key or a search term.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• table string required
• lookup_keys array optional
  each item: string
• search string optional

• deleted_count integer required

Change which columns identify a row in a workspace storage table, rebuilding every row's key.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• table string required
• key_columns array required
  each item: string

• table string required
• key_columns array required
  each item: string

Create a new workspace storage table, optionally with columns.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• name string required
• description string optional
• columns array optional
  each item: object

  • name string optional
  • type string optional
  • encrypted boolean optional

• table string required
• columns array required
  each item: object

  • name string required
  • type string required
  • encrypted boolean required

Delete a row from a workspace storage table, found by its lookup key.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• table string required
• lookup_key string required

• lookup_key string required
• deleted boolean required

Delete a workspace storage table and all of its rows.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• table string required

• table string required
• deleted boolean required

Drop a column from a workspace storage table.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• table string required
• column string required

• table string required
• columns array required
  each item: object

  • name string required
  • type string required

Insert a row into a workspace storage table from a map of column name to value.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• table string required
• values object required

• lookup_key string or null required
• row object required

List the workspace storage tables and their columns.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• limit integer optional
• offset integer optional

• tables array required
  each item: object

  • name string required
  • description string or null required
  • row_count integer required
  • columns array required
    each item: object

    • name string required
    • type string required
• has_more boolean required

Read rows from a workspace storage table, optionally filtered by a search term.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• table string required
• search string optional
• limit integer optional
• offset integer optional

• rows array required
  each item: object

  • lookup_key string or null required
• has_more boolean required

Rename a column on a workspace storage table.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• table string required
• column string required
• new_name string required

• table string required
• columns array required
  each item: object

  • name string required
  • type string required

Update a row in a workspace storage table, found by its lookup key.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• table string required
• lookup_key string required
• values object required

• lookup_key string or null required
• row object required

Update a workspace storage table's name or description.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• table string required
• name string optional
• description string optional

• table string required
• description string or null required

Apply an ordered batch of surgical edits (add_node, update_node, delete_node, connect, disconnect) to a flow graph, atomically. Reference or shape errors reject the whole batch and save nothing; a graph that saves but fails validation is returned with valid:false and errors.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• definition_id integer required
• ops array required
  each item: one of

  add_node

  • op any required one of add_node
  • id string required
  • type string required
  • data object optional
  • position object optional
    • x number optional
    • y number optional

  update_node

  • op any required one of update_node
  • node_id string required
  • set object optional
  • unset array optional
    each item: string

  delete_node

  • op any required one of delete_node
  • node_id string required

  connect

  • op any required one of connect
  • source string required
  • target string required
  • source_handle string optional
  • target_handle string optional

  disconnect

  • op any required one of disconnect
  • edge_id string required

  disconnect

  • op any required one of disconnect
  • source string required
  • target string required
  • source_handle string optional
  • target_handle string optional

• applied array required
  each item: object

  • op string required
  • node_id string optional
  • edge_id string optional
  • edge_ids array optional
    each item: string
• status string required one of saved saved_with_errors
• valid boolean required
• error_summary string optional
• errors array required
  each item: string

Patch a deployment's platform_configuration with dotted set/unset paths, merged into the existing config and validated as a whole. Invalid config is refused and nothing is saved. Use flow.get_deployment to see the keys each platform expects.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• deployment_id integer required
• set object optional
• unset array optional

• deployment_id integer required
• serving boolean required
• platform_configuration object required

Create a new flow definition. Starts from a blank graph unless a template key is given (see flow.list_templates).

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• name string required
• description string optional
• template string optional
• personality string optional

• definition_id integer required
• name string required

Deploy a flow definition to a platform. Creating or activating a deployment on a connected platform (Intercom, WhatsApp, Telegram, Messenger, Instagram) triggers live side effects -- webhook setup, tag sync -- against that platform.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• definition_id integer required
• name string required
• platform string required
• version_strategy string optional
• deployed_version_id integer optional
• platform_connection_id integer optional
• active boolean optional

• deployment_id integer required
• serving boolean required

Delete a flow definition.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• definition_id integer required

• definition_id integer required
• deleted boolean required

Get a flow definition's graph (nodes and edges) and publication status.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• definition_id integer required

• id integer required
• name string required
• description string or null required
• data object required
  • nodes array required
  • edges array required
• publication_status string required
• can_publish boolean required
• latest_version_id integer or null required
• personality string required

Get one deployment's platform, status, version, connection, and current platform_configuration, plus per-platform config hints (which keys that platform expects).

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• deployment_id integer required

• id integer required
• name string required
• platform string required
• active boolean required
• serving boolean required
• version_strategy string required
• deployed_version_id integer or null required
• platform_connection object or null required
  • id integer required
  • platform string required
• platform_configuration object required
• config_hints object required
  • required array required
    each item: string
  • optional array required
    each item: string

List the workspace's deployments, optionally for one definition: id, name, platform, active/serving, version strategy.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• definition_id integer optional

• deployments array required
  each item: object

  • id integer required
  • name string required
  • platform string required
  • active boolean required
  • serving boolean required
  • version_strategy string required
  • definition_id integer required

List the node types available for building a flow, with their fields and defaults.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

List the flow templates flow.create_definition can start from. Pass a template's key as create_definition's `template`.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

Publish a flow definition's current draft as a new version, feeding live deployments on the latest strategy.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• definition_id integer required
• notes string optional

• version_id integer required
• content_hash string required
• published_at string required

Restore a flow definition's draft to a prior version's graph.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• version_id integer required

• definition_id integer required
• restored boolean required

Send a message to your bot in test mode and get its reply. Pass conversation_ref to continue.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• definition_id integer required
• message string required
• conversation_ref string optional

• reply string or null required
• conversation_ref string required

Update a flow definition's name, description, or bot personality. The graph is edited with flow.apply_graph_ops, not here.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• definition_id integer required
• name string optional
• description string optional
• personality string optional

• updated boolean required

Update a deployment: activate/deactivate it, change its version strategy or pinned version, or rename it. Activating a deployment on a connected platform triggers live side effects. Use flow.configure_deployment for platform_configuration.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• deployment_id integer required
• name string optional
• active boolean optional
• version_strategy string optional
• deployed_version_id integer optional

• deployment_id integer required
• serving boolean required

Fetch one conversation's transcript and context (deployment, definition, variables, contact). Add read:conversations_pii for contact email/phone and the visitor's submitted PII.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• conversation_id integer required

• transcript string required
• status string required
• platform string required
• test_mode boolean required
• started_at string or null required
• last_activity_at string or null required
• context object required
  • deployment object or null required
    • id integer required
    • name string or null required
    • platform string required
  • definition object or null required
    • id integer required
    • name string or null required
  • version object or null required
    • id integer required
    • content_hash string or null required
  • current_node_id string or null required
  • variables object required
  • contact object or null required
    • name string required
    • verified boolean required
    • email string or null optional
    • phone string or null optional
  • user_info object optional

List conversations in the workspace, with optional filters. Mirrors the customer dashboard's conversation list.

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• definition_id integer optional
• deployment_id integer optional
• status string optional
• platform string optional
• test_mode boolean optional
• limit integer optional
• offset integer optional

• conversations array required
  each item: object

  • id integer required
  • session_id string required
  • status string required
  • platform string required
  • test_mode boolean required
  • deployment_id integer or null required
  • definition_id integer or null required
  • started_at string or null required
  • last_activity_at string or null required
  • message_count integer required
  • contact object optional
    • name string required
    • email string or null optional
    • phone string or null optional
• has_more boolean required

Fetch the ordered node-execution trace and AI usage summary for one conversation, for debugging a flow run (including test-mode runs from flow.run).

• workspace string required

  Subdomain of the workspace to operate on. workspaces.list reports the ones this token can reach.

• conversation_id integer required
• limit integer optional
• offset integer optional

• steps array required
  each item: object

  • step_id integer required
  • processing_time_ms integer or null required
  • node_executions array required
    each item: object

    • node_id string required
    • node_label string required
    • node_type string required
    • execution_order integer required
    • processing_time_ms integer or null required
    • outgoing_handle string or null required
    • input_data object or null required
    • output_data object or null required
    • metadata object or null required
    • agent_executions array required
      each item: object

      • provider string required
      • model_id string required
      • status string or null required
      • input_tokens integer or null required
      • output_tokens integer or null required
      • cost number required
      • duration_seconds number or null required
      • error_message string or null required
    • rag_executions array required
      each item: object

      • query string required
      • search_type string or null required
      • chunks_retrieved_count integer or null required
      • search_duration_ms integer or null required
      • average_relevance_score number or null required
      • error_message string or null required
• ai_usage object or null required
  • total_calls integer required
  • total_input_tokens integer required
  • total_output_tokens integer required
  • total_tokens integer required
  • total_cost number required
  • by_model object required
• has_more boolean required