Skip to content

Tools of the assistant

A connected assistant only sees the tools the user is authorized for. This overview lists all tools, their meaning and the prerequisite. Tool names appear in answers and in the log; they are not needed in the conversation.


Orientation

Tool Meaning Prerequisite
get_company_info Description, terms, rules and contact of the company Role "connect"
get_usage Own limits and usage of the current hour Role "connect"

Read data

Tool Meaning Prerequisite
list_data_schemas All permitted data schemas Read data schemas
get_data_schema Fields of a data schema: required fields, types, references Read data schemas
search_data_objects Full-text search within a data schema Read data objects
list_records Browse the folder tree of a data schema Read data objects
filter_records Filter records by an indexed field value Read data objects
get_data_object Read one record completely, including references Read data objects
get_file Download link for a file of a record (valid 15 minutes) Read files

Analyze

Tool Meaning Prerequisite
list_tables Analytics tables that may be queried Analytics
query_records Run a SQL query (read only) Analytics, ad-hoc queries
get_query_result Fetch the result of a query Analytics, ad-hoc queries

Write data

Tool Meaning Prerequisite
create_record Create a record, with a dry run without saving Write data objects and role "write records directly"
update_record Change fields of a record Write data objects and role "write records directly"

Processes

Tool Meaning Prerequisite
list_processes Available processes Read processes
get_process_start_schema Start form of a process Read processes
start_process Start a process with a filled-in start form Start processes and role "start processes and complete tasks"
list_process_instances Cases of a process Process Explorer
get_process_instance Status of a case Process Explorer
my_start_events Own startable actions (like the "Start processes" card) Workspace
my_running_instances Own running cases Workspace
recent_process_activity Recent activity Workspace
process_stats Process statistics Workspace

Tasks

Tool Meaning Prerequisite
my_open_tasks Own open tasks Workspace
get_task Form and data of a task Workspace
complete_task Complete a task Work on tasks and role "start processes and complete tasks"

How answers are structured

Besides the data, every answer contains a note on what it means for the user, suggestions for sensible next steps and links into the Pantarey app. Truncated lists are marked as such. Writing tools validate the input before saving and refuse duplicate executions of the same request.


Tips

  • Use the dry run: Before creating a record, the assistant can have the input checked without saving.
  • Follow the links: Where the chat cannot continue – deleting, uploading files – the link leads straight to the right place in Pantarey.