Tools are LLM-callable functions. They are used by the AI Reasoning step inside agents and by the chat agent in the dashboard. Each tool has a kind. Read tools fetch data. Write tools mutate state and run through your configured approval policy before running.Documentation Index
Fetch the complete documentation index at: https://colossal.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Customers
Read tools
get_customer_details
Get customer details by UID or email. Returns email, full name, created_at, and order count.
Input
The customer’s UUID
The customer’s email address
Write tools
create_customer
Create a new customer record.
Input
Customer email address.
Customer full name.
update_customer
Update a customer record.
Input
The customer’s database ID.
New email address.
New full name.
Insights
Read tools
query_insights
Query the workspace’s analytics data.
Input
Invoices
Read tools
get_invoice_details
Get invoice details by UID, including status, totals, line items, and billing info.
Input
The invoice’s UUID
Write tools
create_invoice
Create an invoice for a customer.
Input
The customer’s database ID.
List of line items, each with description, quantity, unit_price.
ISO 4217 currency code (default: usd). Default:
"usd".create_invoice_line_item
Append a line item to an existing invoice.
Input
The invoice’s UUID.
Line item title.
Quantity (>=1).
Unit price in the invoice’s smallest currency unit.
Optional product ID linking the item to a product.
Optional description.
Orders
Read tools
get_order_details
Get order details by UID including line items and customer info.
Input
The order’s UUID
get_order_history
Get a customer’s recent order history. Returns orders with totals, status, and line items.
Input
The customer’s database ID
Max orders to return (default 20) Default:
20.list_orders
Browse the most recent orders.
Input
Default:
10.Write tools
update_billing_address
Update the billing address on an order.
Input
The order’s UUID.
Street address line 1.
City name.
Postal/ZIP code.
ISO country code (e.g. ‘US’).
Optional secondary address line.
Optional state/region code.
update_order
Update fields on an order (whitelisted by the order’s workflow-updatable fields).
Input
The order’s database ID.
Dict of writable fields to apply (subject to the order’s
workflow-updatable whitelist).
update_order_metadata
Update an order’s integration metadata.
Input
The order’s database ID.
Metadata fields to merge into the order record.
update_order_status
Update an order’s status. Pauses for approval before running.
Input
The order’s database ID.
New status. Cannot be ‘refunded’ or ‘cancelled’ (those have dedicated flows).
update_shipping_address
Update the shipping address on an order.
Input
The order’s UUID.
Street address line 1.
City name.
Postal/ZIP code.
ISO country code (e.g. ‘US’).
Optional secondary address line.
Optional state/region code.
Payments
Read tools
get_payment_details
Get payment details by UID, including amount, status, and method.
Input
The payment’s UUID
Products
Read tools
get_product_details
Get product details by UID, including name, description, archive state, and default variant.
Input
The product’s UUID
get_workspace_products
Browse the workspace’s products.
Input
Write tools
archive_deliverable
Archive a product deliverable.
Input
The deliverable’s UUID.
archive_product
Archive a product so it stops appearing on the storefront.
Input
The product’s UUID.
create_deliverable
Create a new product deliverable.
Input
Deliverable type identifier.
Display name.
Optional type-specific configuration.
create_price
Create a new price for a product variant.
Input
The variant’s UUID.
Unit price.
ISO 4217 currency code (default: USD). Default:
"USD".Optional human-readable name for the price.
Optional ‘month’ or ‘year’ for subscriptions.
Whether to mark this as the default price for the variant. Default:
false.publish_product
Publish a product so it appears on the storefront.
Input
The product’s UUID.
set_default_price
Mark a price as the default for its variant.
Input
The price’s UUID.
unarchive_product
Unarchive a product.
Input
The product’s UUID.
update_deliverable
Update a product deliverable.
Input
The deliverable’s UUID.
Optional new name.
Optional new type identifier.
Optional new configuration.
Web
Read tools
fetch_page
Fetch the content of a public web page.
Input
web_search
Search the public web.
Input
Default:
5.