# Firmhouse SDK

A JavaScript / TypeScript SDK for interacting with the Firmhouse GraphQL API in a structured and type-safe way. The Firmhouse SDK is designed to make it easier for developers to interact with the Firmhouse API by providing a fully typed interface and handling errors in a structured way.

### Features

* Fully typed SDK with TypeScript, so you don't have to worry about field names and types.
* Provides smooth IDE experience with auto-completion and type hints.
* Handles errors in a structured way.
* Supports both Storefront and Write access tokens and restricts operations based on the access type.
* Gives you the option to include/exclude related resources in the response, without writing messy GraphQL queries.

***

You can start using the Firmhouse SDK by checking out the [Getting Started](/sdks/firmhouse-sdk/getting-started.md) guide.

If you would like to browse our example projects or get a head start with boilerplates, check out the [Examples and Boilerplates](/sdks/firmhouse-sdk/examples-and-boilerplates.md) guide.


---

# 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://developer.firmhouse.com/sdks/firmhouse-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.
