> ## Documentation Index
> Fetch the complete documentation index at: https://docs.veecle.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# ask

> Look up how Chiplab works: supported boards, the upload and run flow, credits, and chip-specific fixes learned from real runs.

**You**

`ask` looks up how Chiplab works: which boards are supported, how to upload and run firmware, and how credits are used. It also returns chip-specific gotchas and validated fixes collected from real simulation runs. For general chip documentation, such as how a peripheral works, use the vendor reference manual.

## Ask your agent

```text theme={null}
Which UART does stm32f4_discovery write to?
```

```text theme={null}
Why is my captured output empty?
```

## What you get back

A short answer in plain text. When the answer comes from the docs, it includes links to those pages.

**Agents**

`ask` answers one natural-language question about Chiplab and returns plain text.

## Parameters

**query** `string` *required*

A natural language question about Chiplab.

## Example call

```json theme={null}
{ "query": "Which UART does stm32f4_discovery write to?" }
```

## Response

**(string)** `string`

A plain-text answer from the Chiplab assistant. When relevant, the answer includes links to the specific documentation pages it drew from.

## How it works

Chiplab routes each question to an assistant with access to the most relevant sections of the [knowledge corpus](/introduction#knowledge-corpus) and composes a focused answer.
The assistant is scoped to Chiplab usage topics, so every answer is grounded in platform documentation.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.