A tool is one action the assistant can take in Cargofy. The assistant picks the tool by itself from your request.
Cargofy marks every tool that changes data, so your assistant can ask you before it runs one. Who can use a tool is on its page: some tools follow your role, others are open to every member of the brand.
Tools are grouped by the Cargofy product they serve. What you do with them in each product, step by step, is in the product pages: Freight Procurement, Fleets, Locations and the others.
Records
Used by every product: find, read, create, update and delete records of any object, and run their business actions.
| Tool | What it does | Changes data |
|---|---|---|
entities-list | Lists every kind of object the assistant can work with in your brand: system objects and your data models, with what each one allows (query, get, create, update, delete) and its business actions | no |
entities-schema | Shows one object’s fields, relations, what your role allows on it and its business actions, with the input each action takes | no |
entities-query | Finds records of one object by filters, sort and text search, page by page | no |
entities-get | Reads one record by its ID | no |
entities-create | Creates a record and, in the same step, links it to other records | yes |
entities-update | Changes the fields you name in one record | yes |
entities-delete | Deletes one record | yes |
entities-run-operation | Runs a business action of one record | yes |
Freight Procurement
Shipments and their route.
| Tool | What it does | Changes data |
|---|---|---|
shipments-fill_waypoints | Sets the whole route of a draft shipment: the new points replace the old ones, in your order | yes |
LoadHub and Carrier Network
The load board and your carriers.
| Tool | What it does | Changes data |
|---|---|---|
carriers-list | Lists your confirmed carriers with their rating, and the carriers whose packet you rejected with your message | no |
loadboard-list | Lists the loads on LoadHub | no |
loadboard-place-bid | Places your brand’s bid on a tender | yes |
loadboard-retract-bid | Withdraws your brand’s bid on a tender | yes |
Locations
Import warehouses and addresses.
| Tool | What it does | Changes data |
|---|---|---|
facilities-import | Imports locations from a table you give the assistant, with your mapping of columns to location fields | yes |
Tasks and Digital Workers
Create and work on tasks. The assistant acts as you.
| Tool | What it does | Changes data |
|---|---|---|
tasks-list | Finds tasks of your brand | no |
tasks-get | Reads one task and how many subtasks it has | no |
tasks-create | Creates a task as you | yes |
tasks-update | Changes a task | yes |
tasks-assign | Assigns a task to a person or a Digital Worker of your brand | yes |
tasks-comment | Adds a comment to a task as you | yes |
tasks-read-attachment | Reads a file attached to a task | no |
tasks-add-attachment | Attaches a file to a task or to one of its comments | yes |
Memory
Save and find facts.
| Tool | What it does | Changes data |
|---|---|---|
knowledge-search | Searches memory: saved facts, summaries of past sessions and digests of the account’s activity | no |
memory-search | Searches saved facts, past episodes and digests in memory | no |
memory-add | Saves a fact to memory, for you or for the whole account | yes |
memory-forget | Forgets a saved fact in two steps: a search returns up to five candidates, then the assistant forgets the one you choose | yes |
Email and integrations
Send email and see your integrations.
| Tool | What it does | Changes data |
|---|---|---|
integration-custom-list | Lists your brand’s published custom integrations with their connections, actions with input fields, and events | no |
notify-email | Sends a plain-text email from Cargofy to the address you give | yes |
config-integrations-list | Lists the integration connections workflows can use, with their status, actions and events | no |
integration-actions | One tool per action of each connected integration | for actions that send or write |
Studio
Read how your account is set up. These tools change nothing.
| Tool | What it does | Changes data |
|---|---|---|
config-surfaces-list | Lists every part of your account setup: workflows, Digital Workers, data models, interfaces, forms, products, business flows, superpowers, knowledge bases, integrations and roles, with how many products and business flows use each | no |
config-get | Reads one part of your setup in full, and which products and business flows use it | no |
config-events-list | Lists the events a workflow can start from: data model record changes, form steps, product events and integration events, with a sample of each event’s data | no |
config-knowledge-bases-list | Lists your knowledge bases | no |
config-workflow-runs | Shows the latest workflow runs, newest first: status, what started each run, the record, the step that failed with its error, calls and what Digital Workers reported | no |
config-bundle-export | Exports a product or a business flow with everything it uses: data models, Digital Workers, workflows, forms, interfaces, roles | no |
products-list | Lists your products with their status, data models and members | no |
business-flows-list | Lists your business flows with their steps | no |