🚀 Getting started

Start using the Wren AI Cloud API in minutes – from getting your API key to making your first call.

Welcome to the Wren AI Cloud API! This guide will walk you through how to authenticate and begin using the available endpoints.

1. Get Your API Key

To authenticate your requests, you'll need an API key.

Go to API → API Keys from the top navigation bar and generate your key.
Use this key in the Authorization header as a Bearer token:

bash

Authorization: Bearer YOUR_API_KEY

2. Start Using the API

Once you have your API key, you're ready to start using the Wren AI endpoints.
All endpoints are available under the base path: https://cloud.getwren.ai/api/v1

3. Explore the API

Use the left-hand menu to browse the available endpoints:

• Query & Answering – Convert natural language questions into SQL queries and summaries.
• Chart Generation – Create Vega-Lite charts from query results.
• Streaming Interface – Use Server-Sent Events (SSE) to get real-time feedback as the query is processed.
• Metadata Introspection – Access deployed models, schema relationships, and virtual views.
• Knowledge – The Knowledge feature in Wren AI allows you to store and manage verified information that helps the AI generate more accurate and consistent responses. This feature is particularly useful for domain-specific context and frequently asked questions. Learn more.

That’s all you need to get started!