Xytext NPM | npm.io

xytext

xytext is a Node.js client library for interacting with the Xytext API. It provides a straightforward way to make requests to the Xytext API and process the responses efficiently. This package aims to facilitate the integration of Xytext API functionalities into Node.js applications.

Installation

Install xytext using npm:

npm install xytext

Usage

To use xytext, you need to have your Xytext API credentials: FUNC_ID, STAGE, and AUTH_TOKEN. These credentials are required to authenticate your requests.

Basic Example

Here's a basic example of how to use xytext:

const Xytext = require('xytext');

async function exampleUsage() {
    const funcId = "your_func_id";
    const stage = "your_stage";
    const authToken = "your_auth_token";
    const timeout = 900;

    const xt = new Xytext(funcId, stage, authToken, timeout);
    try {
        const response = await xt.invoke("Your input text here");
        console.log(response.result);
    } catch (error) {
        console.error("Error:", error.message);
    }
}

exampleUsage();

API Reference

Xytext

This is the primary class used to interact with the Xytext API.

Constructor

new Xytext(funcId, stage, authToken, timeout)

Parameters:

funcId (String): The function ID for the Xytext API.
stage (String): The stage of the API environment ("staging", "prod").
authToken (String): Your authorization token for the Xytext API.
timeout (Integer): The timeout for the API request in seconds. Default is 900 seconds (15 minutes).