npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@genie-ai/genie-router-plugin-api-http

v2.0.0

Published

A genie-router plugin that provides a generic HTTP API for external clients.

Downloads

16

Readme

genie-router-plugin-api-http

A genie-router plugin that provides a generic HTTP API for external clients.

This is a plugin for the https://github.com/matueranet/genie-router project. It adds a HTTP endpoint to which external clients can send messages and receive output.

Configuration

Update the plugins block in the genie-router configuration and add the key api-http, which should be an object. This will enable the plugin. http should be enabled in the genie-router configuration.

This plugin supports 3 optional configuration parameters:

  • endpoint, the HTTP endpoint to listen to (defaults /api/message)
  • accessToken, requires that the requests are using an accessToken (Default is disabled).
  • timeout, the maximum of milliseconds the process should waits for the invoked brain to respond (defaults to 5000 = 5 seconds).

Example

"api-http": {
  "endpoint": "/api/message",
  "timeout": 5000,
  "accessToken": "protection-enabled"
}

Authorization

If the accessToken attribute is set, each request should include a Authorization: Bearer [accessToken] header. Else a 401 HTTP response is returned.

Requests / responses

The request should have be a JSON object, with at least an input attribute. You can optionally include a metadata attribute which will be returned in the response.

{
  "input": "Hello genie!",
  "metadata": {
    "internal-request-id": 5
  }
}

If you add the attribute userId and/or sessionId in the request metadata this will be mapped to the internal userId and sessionId in genie-router, where they can be used by other plugins.

The responses will contain a unique identifier for each request, in the id attribute.

Valid response

{
  "id": "110ec58a-a0f2-4ac4-8393-c866d813b8d1",
  "message": "How may I help you, master?",
  "metadata": {
    "internal-request-id": 5
  }
}

Errors

{
  "id": "110ec58a-a0f2-4ac4-8393-c866d813b8d1",
  "error": "Timeout contacting brain."
}