C3 AI Documentation Home

Access Your Environment

Modern browsers come equipped with built-in development tools designed to facilitate work with JavaScript and other web technologies. These tools encompass the C3 AI Console, which resembles a shell interface, as well as utilities for DOM inspection, debugging, and network activity analysis.

Through the C3 Agentic AI Platform, you can interact with the C3 AI Console to effectively engage with your environment. The C3 AI Console is designed to offer an array of useful features:

  • Application data retrieval, filtration, and updating
  • Expression testing capabilities
  • Documentation search functionality

See the full list of C3 AI Console functions.

Access to the C3 AI Console

In your browser, navigate to https://{c3_cluster_url}/{application}/console/index.html}, and you will be prompted for your credentials. If you do not know the url for your environment, ask your C3 AI administrator.

In the following examples we assume you have deployed a package that has the SmartBulb Type, which keeps track of data about a smart bulb, such as its wattage and lumens.

Access documentation

Use the C3 AI Console to get in-depth documentation for a particular Type:

JavaScript
// Open documentation for the package
c3Doc()

// Open reference documentation for the `SmartBulb` Type
c3ShowType(SmartBulb)

Query and explore data

You can query and preview data from the C3 AI Console:

JavaScript
// Fetch smart bulbs with 10 watts or less, and display them in a table
c3Grid(SmartBulb.fetch({filter: "wattage <= 10"}))

// Fetch smart bulb with ID 'SMBLB1', and display the result in a tree format
c3Tree(SmartBulb.fetch({filter: "id == 'SMBLB1'"}))

Create and manipulate data

All Type methods are accessible from the C3 AI Console using JavaScript, so you can also create and update application data:

JavaScript
// Create instance without persisting it
var bulb1 = SmartBulb.make({ id: "SMBLB1", bulbType: "LED", manufacturer: "Philips" });

// Create and persist new smart bulb
var bulb1 = SmartBulb.make({ id: "SMBLB1", bulbType: "LED", manufacturer: "Philips" }).create();

// Update a field
SmartBulb.make({ id: "SMBLB1", manufacturer: {id: "Philips"} }).merge({include : "manufacturer" });
Was this page helpful?