> For the complete documentation index, see [llms.txt](https://docs.pentaho.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pentaho.com/pba-ctools/pentaho-cdf-api/welcome-to-the-cdf-api-documentation.md).

# Welcome to the CDF API Documentation

## Some Links to Get Started

* If you're interested in details about the Dashboard objects, start in the `Dashboard` class. From there you can jump to the specific classes and their details.
* If you want to review the methods for the base component classes, start `here`. This module defines the `BaseComponent` class (from where all other components inherit) and the `UnmanagedComponent` (from where most of the default components inherit).
* If you want to know more about the component lifecycle, there's a good write up about the Unmanaged lifecycle `here`. For other documentation about the subject, in your Pentaho installation, navigate to Plugin Samples `->` CDF `->` Documentation `->` lifecycle and also Plugin Samples `->` CDF `->` Documentation `->` concepts.
* If you want to know about all existing CDF components and their properties, that's also available in your Pentaho installation. Navigate to Plugin Samples `->` CDF `->` Require Samples `->` Documentation `->` Component Reference `->` Core Components. There's a sample and a property listing for all of them there.

## API Structure

[cdf](/pba-ctools/pentaho-cdf-api/cdf.md)

* [components](/pba-ctools/pentaho-cdf-api/components.md)
* [dashboard](/pba-ctools/pentaho-cdf-api/dashboard.md)
* [queries](/pba-ctools/pentaho-cdf-api/queries.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.pentaho.com/pba-ctools/pentaho-cdf-api/welcome-to-the-cdf-api-documentation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.