> For the complete documentation index, see [llms.txt](https://docs.spice.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.spice.ai/docs/portal/playground.md).

# Playground

The **Playground** runs queries, searches, and model requests against an app from the browser, with no local setup. Open it by navigating to an app and clicking **Playground** in the app navigation bar.

Most of the Playground requires the app to have a spicepod. Until then, only **SQL Query** is available.

## Interactive tools

| Tool            | Description                                                                                                                      |
| --------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| **SQL Query**   | A SQL editor with table, column, and keyword suggestions. See [SQL Query](/docs/portal/playground/sql-query-editor.md).          |
| **Text-to-SQL** | Ask a question in natural language and review the SQL Spice generates. See [Text-to-SQL](/docs/portal/playground/nsql-query.md). |
| **AI Chat**     | Chat with a model configured in the app, with access to its datasets. See [AI Chat](/docs/portal/playground/ai-chat.md).         |
| **Search**      | Run search queries against the app's datasets.                                                                                   |

## APIs

The **APIs** section provides a console for each runtime API. Requests are built from the options on the page and sent to the app's own endpoint using its API key, and a matching `curl` command can be copied for use outside the Portal.

* **Query** — SQL over HTTP.
* **Search** — search over the app's datasets.
* **AI Completions** and **AI Responses** — model inference.
* **NSQL** and **NSQL Context** — natural-language querying, and the context block Spice supplies to the model. See [Text-to-SQL API](https://github.com/spicehq/docs/tree/trunk/cloud/api/nsql.md).
* **Metrics** — runtime metrics in Prometheus format. See [Metrics API](https://github.com/spicehq/docs/tree/trunk/cloud/api/metrics.md).
* **Control-Plane** — app and deployment operations.

See the [API Reference](https://github.com/spicehq/docs/tree/trunk/cloud/api/README.md) for the full contract behind each one.

## SDKs & CLI

The **SDKs & CLI** section generates connection snippets pre-filled with the app's endpoint, for **C#**, **Go**, **Java**, **Node.js**, **Python**, and **Rust**, plus the **Spice CLI** and **cURL**.


---

# 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.spice.ai/docs/portal/playground.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.