@cognigy/rest-api-client/README.md

Cognigy REST-Client

Typescript / Javascript library to interaction with the `Cognigy.AI 4` RESTful API.

# Installing
```
npm i @cognigy/rest-api-client
```

# Usage
Once the client has been installed into your Typescript / Javascript project, you have to require the client and create a new instance from it:

**Typescript**
```typescript
import { RestAPIClient } from "@cognigy/rest-api-client";

const client = new RestAPIClient({
	baseUrl: "<api-hostname-cognigy-ai-installation>"
});
```

**Javascript (Node.JS)**
```javascript
const { RestAPIClient } = require("@cognigy/rest-api-client");

const client = new RestAPIClient({
	baseUrl: "<api-hostname-cognigy-ai-installation>"
});
```

## Authentication
In order to authenticate your client, you have to use the `setCredentials` function. Our client supports multiple ways to authenticate, such as:
- API-key
- Basic auth
- OAuth 2

The following example shows how you can use a long-lived `API key` to authenticate and authorize:

**Typescript / Javascript (Node.JS)**
```typescript
client.setCredentials({
	type: "ApiKey",
	apiKey: "<your-api-key>"
});
```

## Making your first call
Let's assume that you have the permissions to create a new `agent / project` within Cognigy.AI and that you are using an API-key to authenticate and authorize calls. This is the minimal example which you can use to create a new virtual agent within Cognigy.AI:

**Typescript / Javascript (Node.JS)**
```typescript
const project = await client.createProject({
	locale: "en-US",
	name: "My new agent"
});
```

This will create the new virtual agent project and return it.