The NLAPI Docs
  • Agent_List
  • Authentication
  • Devii
  • Documentation
  • Guides
  • Portal
  • Pricing
  • Upcoming Roadmap
  • Schemas
  • NLAPI Training Data and Calls Documentation
Powered by GitBook
On this page

Guides

PreviousDocumentationNextPortal

Last updated 4 months ago

These are walkthroughs/guides on the core concepts of the NLAPI.

If you'd like to contribute to this list or create a walkthrough to share, you can earn free NLAPI credits! For more information, email jase@jasekraft.com.

Complete REST API Setup and Walkthrough

This guide shows you how to get started with the NLAPI by setting up an account, creating your endpoint to interact with the NLAPI, and how to display that information in your UI. The guide is broken up into stages that take you through the main core concepts of the NLAPI. Each stage is on a separate branch (stage-1 -> stage-n) and is accompanied by a video explanation and documentation.

You will learn:

  • How to implement a chat widget in your app that can interact (query and mutate) user data.

  • How the NLAPI only allows users to see their own data.

  • Best practices for setting up your API to be conversationally focused.

  • Use React Query to automatically refresh data on screen when manipulated through chat.

  • How to integrate your app into Slack.

  • Use context to make your chat experience 'smarter'.

  • Help the user navigate your app based on their requests.

  • And more!

Check it out here:

https://github.com/jase-k/nlapi-guide-openapi