> For the complete documentation index, see [llms.txt](https://requiply.gitbook.io/requiply-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://requiply.gitbook.io/requiply-docs/knowledge/developer-documentation/developer-docs.md).

# Overview

`@requiply/api-sdk` is Requiply's framework-agnostic TypeScript client for the public rental API. Use it to build storefronts, server applications, serverless functions, and internal integrations without assembling HTTP requests by hand.

{% hint style="warning" %}
The package is configured for public npm access, but `@requiply/api-sdk` is not currently available from the public npm registry. Installation will return `404 Not Found` until the first public release is published.
{% endhint %}

The SDK supports Node.js 18 or later and modern browsers with `fetch`. It can also be used from frameworks such as Next.js and Nuxt. Dedicated `@requiply/next` and `@requiply/nuxt` packages are planned, but are not currently available.

## SDK or REST API?

* **TypeScript SDK:** Provides typed inputs and responses, bearer authentication, query serialization, request options, and `RequiplyError`.
* **Direct REST API:** Sends HTTP requests below `{baseUrl}/api/public/v1`. Use direct REST access when your runtime cannot consume the ESM package.

The SDK is the recommended integration path for JavaScript and TypeScript applications.

## Start here

* [Install the SDK](/requiply-docs/knowledge/developer-documentation/typescript-sdk/installation.md)
* [Configure authentication and API keys](/requiply-docs/knowledge/developer-documentation/authentication-and-api-keys.md)
* [Build your first server and storefront integrations](/requiply-docs/knowledge/developer-documentation/typescript-sdk/quick-start.md)
* [Browse the SDK resource guides](/requiply-docs/knowledge/developer-documentation/typescript-sdk.md)
* [Check REST API reference availability](/requiply-docs/knowledge/developer-documentation/api-reference.md)

## Package links

* [npm: `@requiply/api-sdk`](https://www.npmjs.com/package/@requiply/api-sdk) (publication pending)
* [GitHub source repository](https://github.com/Requiply/RequiplyNPM)


---

# 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://requiply.gitbook.io/requiply-docs/knowledge/developer-documentation/developer-docs.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.