# recastai

> Recast.AI official SDK in NodeJs

Latest version **4.0.0** (published 2018-08-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install recastai
pnpm add recastai
yarn add recastai
bun add recastai
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.0.0 |
| Published | 2018-08-10 |
| First published | 2016-05-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 304.8 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| Author | Jerome Houdan |
| Maintainers | recastai |
| Keywords | recastai |

## Links

- npm: https://www.npmjs.com/package/recastai
- Repository: https://github.com/RecastAI/SDK-NodeJs
- Homepage: https://github.com/RecastAI/SDK-NodeJs#readme
- Issues: https://github.com/RecastAI/SDK-NodeJs/issues
- npm.io page: https://npm.io/package/recastai

## Dependencies (9)

- [chai](https://npm.io/package/chai.md) ^4.1.2
- [nock](https://npm.io/package/nock.md) ^8.0.0
- [mocha](https://npm.io/package/mocha.md) ^5.1.0
- [lodash](https://npm.io/package/lodash.md) ^4.12.0
- [form-data](https://npm.io/package/form-data.md) ^1.0.1
- [superagent](https://npm.io/package/superagent.md) ^3.8.2
- [babel-runtime](https://npm.io/package/babel-runtime.md) ^6.22.0
- [superagent-proxy](https://npm.io/package/superagent-proxy.md) ^1.0.3
- [superagent-promise](https://npm.io/package/superagent-promise.md) ^1.1.0

## Recent versions

- 4.0.0 (latest) — 2018-08-10
- 3.7.0 — 2017-11-29
- 3.6.0 — 2017-10-20
- 3.5.0 — 2017-10-17
- 3.4.1 — 2017-05-18
- 3.4.0 — 2017-05-17
- 3.3.1 — 2017-04-21
- 3.3.0 — 2017-04-20
- 3.2.0 — 2017-04-11
- 3.1.2 — 2017-04-04
- 3.1.1 — 2017-03-30
- 3.1.0 — 2017-03-30
- 3.0.0 — 2017-03-30
- 2.3.0 — 2016-10-24
- 2.2.1 — 2016-10-11
- … 17 more at https://npm.io/package/recastai/versions

## README

<p align="center">
  <img src="misc/logo2.png" />
</p>

| [Installation](#installation) | [Sample Projects](#sample-projects) | [Resources]( #resources) | [Getting Started on Recast.AI]( #getting-started-with-recastai) | [License](#license) |
|---|---|---|---|---|
<div>
<a href="https://slack.recast.ai/">💬 Questions / Comments? Join the discussion on our community Slack channel!</a>
</div>

# Recast.AI - SDK Node.js
Recast.AI official SDK in Node.js

## Synospis

This module is a wrapper around the [Recast.AI](https://recast.ai/) [API](https://man.recast.ai/) API, and allows you to:
* [Analyse your text](https://github.com/RecastAI/SDK-NodeJS/wiki/Analyse-text)
* [Manage your conversation](https://github.com/RecastAI/SDK-NodeJS/wiki/Manage-your-conversation)
* [Receive and send messages](https://github.com/RecastAI/SDK-NodeJS/wiki/Receive-and-send-messages)

## Installation

Install the package using npm, as shown below:
```bash
npm install --save recastai
```

You can now use the SDK in your code.

#### ES5

Using the entire SDK:
```js
var recastai = require('recastai').default

var client = new recastai('YOUR_TOKEN')
```

Extracting one single API:
```js
var recastai = require('recastai').default

var converse = new recastai.converse('YOUR_TOKEN')
```

#### ES6

Using the entire SDK:
```js
import recastai from 'recastai'

const client = new recastai('YOUR_TOKEN')
```

Extracting one single API:
```js
import { converse } from 'recastai'

const clientConverse = new converse('YOUR_TOKEN')
```

## Sample projects

Check out our [NodeJS starter-kit](https://github.com/RecastAI/starter-NodeJS) for a usage example of the SDK.

## Resources
* [Bot Builder Guide](https://recast.ai/docs): Best practices and tips to use the Recast.AI platform 
* [API Documentation](https://man.recast.ai/)
* [Your first bot](https://blog.recast.ai/build-your-first-bot-with-recast-ai/) - Build your first bot with Bot Builder
* [Advanced chatbot tutorial(Moviebot)](https://recast.ai/blog/nodejs-chatbot-movie-bot/) - Overview of how to get started building your bot's server

## Author

Jérôme Houdan, jerome.houdan@recast.ai

You can follow us on Twitter at [@recastai](https://twitter.com/recastai) for updates and releases.

## Getting started with Recast.AI

We build products to help enterprises and developers have a better understanding of user inputs.

-   **NLP API**: a unique API for text processing, and augmented training.
-   **Bot Building Tools**: all you need to create smart bots powered by Recast.AI's NLP API. Design even the most complex conversation flow, use all rich messaging formats and connect to external APIs and services.
-   **Bot Connector API**: standardizes the messaging format across all channels, letting you connect your bots to any channel in minutes.

Learn more about:

| [API Documentation](https://recast.ai/docs/api-reference/) | [Discover the platform](https://recast.ai/docs/create-your-bot) | [First bot tutorial](https://recast.ai/blog/build-your-first-bot-with-recast-ai/) | [Advanced NodeJS tutorial](https://recast.ai/blog/nodejs-chatbot-movie-bot/) | [Advanced Python tutorial](https://recast.ai/blog/python-cryptobot/) |
|---|---|---|---|---|

## License

Copyright (c) [2018] [Recast.AI](https://recast.ai)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

---
_Source: https://npm.io/package/recastai · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._