- Who can: any member of the brand. Integrations in the setup and the export need the “Manage Studio” permission.
- Where in Cargofy: Studio
What it is
The assistant reads how your account is set up and explains it: workflows, Digital Workers, data models, products and business flows. It finds out why a workflow run failed. It changes nothing: every tool on this page only reads.
What it can do
Why a workflow run failed, from start to finish
A dispatcher’s conversation with the assistant and Cargofy’s real answers. The terms are in the Glossary. The tools behind each step are in the table at the end. Dates and run counts on this page are examples.
1. Find the failed run
The workflow Demo: Run that fails failed at some point. Why?
The assistant reads the 20 latest runs of the workflow. One of them is “Failed”: the step “Heavier than 20 t?” failed. The assistant shows the error of that step.
2. Read the step that failed
Show me that step as it is now.
The assistant reads the workflow and shows the step “Heavier than 20 t?” as it is now: a condition on the request’s weight.
3. See what ran on one record
Which workflows ran on the request Kyiv → Lviv?
The assistant finds the request, then the runs of every workflow on it, with each run’s status and what started it: for example, “Demo: Check request manually” started from an interface and “Demo: Task title from the request” started by hand.
| Step | Tool | What the assistant sends |
|---|---|---|
| 1 | config-surfaces-list, then config-workflow-runs | the workflow’s id from the list as workflow_id, limit 20 |
| 2 | config-get | surface workflow, target_id; the node_id from failed_node is the step’s id in graph.nodes |
| 3 | entities-query, then config-workflow-runs | the record’s id as record_id, no workflow_id |
Get an overview
What does our Studio have? Which products and business flows are active?
config-surfaces-list lists every part of the setup by kind: workflows, Digital Workers, data models, interfaces, forms, products, business flows, superpowers, knowledge bases, integrations and roles. Each part comes with its ID and how many products and business flows use it. A workflow also shows whether it is published and how it starts: by an event, by hand or on a schedule.
products-list shows the products with their status and parts. business-flows-list shows the business flows with their steps in order. A product or flow you built has a name and a status, such as active. A built-in one comes with a key instead of a name and says whether it is switched on. The assistant names it as Cargofy shows it: tender is “Freight Procurement”, see the Glossary.
Look inside one part
How does Demo: Request dispatcher work, and which knowledge base does it use?
config-get reads one part in full, and which products and business flows use it. The assistant needs the part’s ID: it finds it by name in config-surfaces-list.
| Part | What the assistant reads |
|---|---|
| Digital Worker | job title, persona, instructions, capabilities, superpowers, knowledge bases, AI model, role, status, tools that need approval |
| Workflow | name, how it starts, its steps and the links between them, whether it is published |
| Data model | fields with their types and options |
| Superpower | what it allows, its context and instructions, which Digital Workers use it |
| Knowledge base | description, status, the names of its documents, which Digital Workers use it. Not the text of the documents |
| Product | its parts and its main data model |
| Role | its permissions |
Read workflow runs
Is Demo: Process shipment request stuck? Show its last runs.
config-workflow-runs shows the latest runs, newest first: the status, what started the run, the record it started on, start and finish time. A failed run names the step that stopped it and the error. It also lists steps that failed without stopping the run, the result of every call step and what each Digital Worker reported.
The assistant reads 5 runs unless it asks for more, 20 at most. To find a failure, ask for the last 20 runs.
| Status | Meaning |
|---|---|
completed | The run finished |
failed | A step stopped the run; failed_node names it |
waiting | A step waits, for example for its task to be done |
cancelled | Someone stopped the run |
A run marked is_test is a test run.
See what can start a workflow
Which tender events can start a workflow? Which integrations are connected?
config-events-list lists the events a workflow can start on: a record created, updated or deleted in each data model, a form step sent, tender events and events of integrations, such as an inbound email.
The tender events: “Tender created”, “Tender published”, “Carrier invited”, “Bid received”, “Bid retracted”, “Bid rejected”, “Bid revoked automatically”, “Bidding ended”, “Bidding ended without a winner”, “Winner selected”, “Automatic publication failed”, “Tender cancelled”, “Tender restored”, “Tender archived”. After the award: “Documents approved”, “Initial documents signed”, “Final documents signed”, “Route detailed”, “Truck and driver assigned”, “Trip started”, “Arrived at a stop”, “Payment method chosen”, “Add-on services chosen”, “Payment received”, “Feedback left”, and a problem reported on a shipment.
config-integrations-list lists your connected integrations with their status, such as connected, error or needs_reauth, and the operations each one runs. config-knowledge-bases-list lists your knowledge bases with their status.
Export a product
Export the business flow Demo: Shipment by request.
config-bundle-export returns the product or business flow with every part it uses: data models, Digital Workers, workflows, forms, interfaces, superpowers, knowledge bases and roles. The export comes back in the chat. A knowledge base comes with its name only, without its documents.
The assistant names a product by product: and its key, a business flow by flow: and its slug. It finds both in products-list and business-flows-list.
Glossary
The words of this page, what they mean in Cargofy and the name the assistant works with. Paste this table into the chat or add it to your assistant’s project knowledge: the assistant then reads your words the same way Cargofy does.
| Term | Meaning | The assistant sees |
|---|---|---|
| Part of the setup | One workflow, Digital Worker, data model, interface, form, product, business flow, superpower, knowledge base, integration or role | a surface and its targets with id |
| Digital Worker | An AI worker that does tasks and steps of workflows | the surface agent |
| Workflow | Steps that run when an event happens, by hand or on a schedule | the surface workflow; published, trigger_type: event, manual, schedule |
| Step | One block of a workflow: a condition, a task, a Digital Worker call and others | a node in graph.nodes with id, type, data; its title is data.label |
| Run | One time a workflow ran | an item of runs from config-workflow-runs |
| Run status | Where the run is | status: completed, failed, waiting, cancelled |
| What started the run | An event, a person, an interface button | trigger: event, manual, interface and others |
| Failed step | The step that stopped a run, with its error | failed_node: node_id, node_type, error |
| Record | One row of a data model, such as the request Kyiv → Lviv | trigger_record_id; record_id to read its runs |
| Product | A set of parts that runs one piece of your work | the surface product; kind composite for yours, native for built-in |
| Built-in product | A product of Cargofy, named by key | tender “Freight Procurement”, loadboard “LoadHub”, carrier_network “Carrier Network”, shipper_network “Shipper Network”, documents “Documents”, tracking “Tracking”, locations “Locations”, settlement “Settlement”, finance “Finance”, lanes “Lanes”, planner “Planner”, fleet “Fleets”, reports “Report”, go “Cargofy GO” |
| Business flow | Products in order around one data model | the surface business_flow; slug, steps |
| Where it is used | The products and business flows that hold a part | used_in, used_in_counts |
| Integration | An integration you built in Studio | the surface integration; needs “Manage Studio” |
| Connected integration | A connection to an outside system, with its operations | an item of config-integrations-list |
| Export | A product or business flow with all its parts | config-bundle-export with root product:<key> or flow:<slug> |
Limits
- The assistant cannot save a change, publish a workflow or start a run.
- It cannot import an export.
- It reads a part only by its ID, not by its name.
- It cannot read the text of a knowledge base document here.