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

Installing

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

Development

Executing e2e tests

In order to execute the e2e tests located in src/spec/aiAgentV2.spec.ts, ensure that you have the following two ENV variables defined:

- REST_API_CLIENT_E2E_TESTS_API_BASE_URL - it should point to a Cognigy.AI environments RESTful API, example: https://api-benni-test.cognigy.dev
- REST_API_CLIENT_E2E_TESTS_API_KEY - it needs to contain a Cognigy.AI RESTful API-key

You can run the test-suite using the following command:

`
REST_API_CLIENT_E2E_TESTS_API_BASE_URL= \
REST_API_CLIENT_E2E_TESTS_API_KEY= \
npm run test:aiAgentsV2
`

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: ""
});
`

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

const client = new RestAPIClient({
baseUrl: ""
});
`

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: ""
});
`

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.