> For the complete documentation index, see [llms.txt](https://docs.hyper-space.io/hyperspace-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hyper-space.io/hyperspace-docs/flows/setting-up/installing-the-hyperspace-api-client.md).

# Installing the Hyperspace API Client

You can access the Hyperspace database by installing Hyperspace's Client API into your local environment. This piece of code serves as a local client, enabling seamless communication with the Hyperspace services. This allows you to upload and manage your data, and access Vector, Classic and Hybrid similarity search capabilities.

Accessing the Hyperspace API requires credentials, provided by Hyperspace.

**To install the Hyperspace client –**

Run the following shell command in your code or your data terminal –

{% tabs %}
{% tab title="Python" %}
{% code lineNumbers="true" %}

```python
pip install hyperspace-py
```

{% endcode %}
{% endtab %}

{% tab title="Java" %}
Instruction are available under <https://github.com/hyper-space-io/hyperspace-java>
{% endtab %}

{% tab title="JavaScript" %}
{% code lineNumbers="true" %}

```javascript
npm install https://github.com/hyper-space-io/hyperspace-js
```

{% endcode %}
{% endtab %}
{% endtabs %}

**Where –**

* <mark style="color:purple;">hyperspace-py</mark> is the name of the Hyperspace's Client API that you downloaded.

Wait until the message **Successfully Installed** is displayed.


---

# 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.hyper-space.io/hyperspace-docs/flows/setting-up/installing-the-hyperspace-api-client.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.