# TypeScript SDK

This package is the core of the Venue CMS TypeScript SDK.

[![@venuecms/sdk](https://img.shields.io/badge/@venuecms/sdk-v0-passing?style=flat\&color=%23bfb8ef\&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F%40venuecms%2Fsdk)](https://www.npmjs.com/package/@venuecms/sdk)

To get started, you can install the SDK by running:

```bash
npm install @venuecms/sdk
```

Examples are strewn throughout the SDK reference which you can browse in the table of contents on the left.

If you are interested in Next.js make sure to use the `@venuecms/sdk-next` to take advantage of some extra optimizations and React components. The core SDK is included in that package as well so the reference will still apply.

For an example of a fully-built minimal application using this SDK, check out our template which we use in production and update frequently [here](https://github.com/venuecms/template-minimal).


---

# Agent Instructions: 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:

```
GET https://docs.venuecms.com/developers/sdk.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
