@cognigy/rest-api-client
    TypeScript icon, indicating that this package has built-in type declarations

    0.11.0 • Public • Published

    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

    import { RestAPIClient } from "@cognigy/rest-api-client";
    
    const client = new RestAPIClient({
    	baseUrl: "<api-hostname-cognigy-ai-installation>"
    });

    Javascript (Node.JS)

    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)

    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)

    const project = await client.createProject({
    	locale: "en-US",
    	name: "My new agent"
    });

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

    Install

    npm i @cognigy/rest-api-client

    DownloadsWeekly Downloads

    95

    Version

    0.11.0

    License

    Cognigy Proprietary License

    Unpacked Size

    1.26 MB

    Total Files

    849

    Last publish

    Collaborators

    • akirilyuk
    • monty0157
    • mayrbenjamin92
    • pedily
    • mastasky