> For the complete documentation index, see [llms.txt](https://docs.redivis.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.redivis.com/api/client-libraries/redivis-js/reference/redivis.md).

# redivis

## *module* <mark style="color:purple;">redivis</mark>

The redivis module, available via `import redivis from 'redivis'` (or `import * as redivis from 'redivis'`). Through this module and its methods, you can create, update, delete, query, and read from various resources on Redivis, as well as manage authentication and configuration.

## Methods

| Method                                                                                                                                              | Description                                                                                                                                |
| --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| [**`redivis.authorize`**](https://docs.redivis.com/api/client-libraries/redivis-js/reference/redivis/redivis.authorize.md)(\[options])              | Authenticate with Redivis. Optional, since requests authenticate automatically when needed.                                                |
| [**`redivis.config`**](https://docs.redivis.com/api/client-libraries/redivis-js/reference/redivis/redivis.config.md)(\[options])                    | Set library-wide defaults (e.g., a default workflow), and return the current configuration.                                                |
| [**`redivis.currentUser`**](https://docs.redivis.com/api/client-libraries/redivis-js/reference/redivis/redivis.currentuser.md)()                    | Return the currently authenticated [User](https://docs.redivis.com/api/client-libraries/redivis-js/reference/user.md).                     |
| [**`redivis.currentWorkflow`**](https://docs.redivis.com/api/client-libraries/redivis-js/reference/redivis/redivis.currentworkflow.md)()            | Return the [default workflow](https://docs.redivis.com/api/client-libraries/redivis-js/reference.md#environment-variables), if one is set. |
| [**`redivis.dataset`**](https://docs.redivis.com/api/client-libraries/redivis-js/reference/redivis/redivis.dataset.md)(name\[, options])            | Construct a new [Dataset](https://docs.redivis.com/api/client-libraries/redivis-js/reference/dataset.md) instance.                         |
| [**`redivis.datasource`**](https://docs.redivis.com/api/client-libraries/redivis-js/reference/redivis/redivis.datasource.md)(source\[, options])    | Construct a new [Datasource](https://docs.redivis.com/api/client-libraries/redivis-js/reference/datasource.md) instance.                   |
| [**`redivis.deauthorize`**](https://docs.redivis.com/api/client-libraries/redivis-js/reference/redivis/redivis.deauthorize.md)()                    | Clear any credentials, including those cached on disk.                                                                                     |
| [**`redivis.isAuthorized`**](https://docs.redivis.com/api/client-libraries/redivis-js/reference/redivis/redivis.isauthorized.md)()                  | Whether credentials are available, without logging in.                                                                                     |
| [**`redivis.makeApiRequest`**](https://docs.redivis.com/api/client-libraries/redivis-js/reference/redivis/redivis.makeapirequest.md)(options)       | Call the Redivis API directly (for advanced use cases).                                                                                    |
| [**`redivis.notebook`**](https://docs.redivis.com/api/client-libraries/redivis-js/reference/redivis/redivis.notebook.md)(name\[, options])          | Construct a new [Notebook](https://docs.redivis.com/api/client-libraries/redivis-js/reference/notebook.md) instance.                       |
| [**`redivis.organization`**](https://docs.redivis.com/api/client-libraries/redivis-js/reference/redivis/redivis.organization.md)(name)              | Construct a new [Organization](https://docs.redivis.com/api/client-libraries/redivis-js/reference/organization.md) instance.               |
| [**`redivis.parameter`**](https://docs.redivis.com/api/client-libraries/redivis-js/reference/redivis/redivis.parameter.md)(name\[, options])        | Construct a new [Parameter](https://docs.redivis.com/api/client-libraries/redivis-js/reference/parameter.md) instance.                     |
| [**`redivis.query`**](https://docs.redivis.com/api/client-libraries/redivis-js/reference/redivis/redivis.query.md)(query\[, options])               | Construct a SQL [Query](https://docs.redivis.com/api/client-libraries/redivis-js/reference/query.md).                                      |
| [**`redivis.setApiProxy`**](https://docs.redivis.com/api/client-libraries/redivis-js/reference/redivis/redivis.setapiproxy.md)(baseUrl\[, options]) | Send all API requests through a proxy, such as your own server.                                                                            |
| [**`redivis.table`**](https://docs.redivis.com/api/client-libraries/redivis-js/reference/redivis/redivis.table.md)(name\[, options])                | Construct a new [Table](https://docs.redivis.com/api/client-libraries/redivis-js/reference/table.md) instance.                             |
| [**`redivis.transform`**](https://docs.redivis.com/api/client-libraries/redivis-js/reference/redivis/redivis.transform.md)(\[name, options])        | Construct a new [Transform](https://docs.redivis.com/api/client-libraries/redivis-js/reference/transform.md) instance.                     |
| [**`redivis.user`**](https://docs.redivis.com/api/client-libraries/redivis-js/reference/redivis/redivis.user.md)(name)                              | Construct a new [User](https://docs.redivis.com/api/client-libraries/redivis-js/reference/user.md) instance.                               |
| [**`redivis.workflow`**](https://docs.redivis.com/api/client-libraries/redivis-js/reference/redivis/redivis.workflow.md)(name\[, options])          | Construct a new [Workflow](https://docs.redivis.com/api/client-libraries/redivis-js/reference/workflow.md) instance.                       |

## Examples

```javascript
import redivis from 'redivis';

const organization = redivis.organization('demo');
// await organization.listDatasets(), organization.dataset('iris_species'), etc...

const dataset = organization.dataset('iris_species');
const table = dataset.table('iris');
// await table.toRowsArray(), etc...

const query = redivis.query(`
  SELECT *
  FROM demo.iris_species.iris
  WHERE SepalLengthCm > 5
`);
// await query.toRowsArray(), etc...
```

## Errors

All errors thrown by this library are instances of `redivis.errors.RedivisError`. Subclasses of `RedivisError` can be used to handle errors around specific events. See [redivis.errors](https://docs.redivis.com/api/client-libraries/redivis-js/reference/redivis/redivis.errors.md) for full details.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.redivis.com/api/client-libraries/redivis-js/reference/redivis.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
