# carter-js

## V2 is out now! See the documentation [here](https://lazylyrics.gitbook.io/carter-js-v2/)!

## Prerequisites

In order to use `carter-js` you'll need to sign up to sign up to [CarterAPI](https://www.carterapi.com/) and create an agent. CarterAPI has excellent documentation.

## Installation

*`` `npm install carter-js` ``*

## The Carter Object

The main component of `carter-js` is the `Carter` object. This object provides a set of methods to interact with your carter agent, create useful skills, track the conversation history and analyse your agent's response times.

```javascript
import { Carter } from 'carter-js'

const carter = new Carter(apiKey)
```

It is important to remember to use the `new` keyword in order to create an instance of the Carter object. Pass in the apiKey of your specific agent - remember to keep this secret while developing and in production as this will allow anyone access to your agent.