For AI agents: visit https://developers.happeo.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
HappeoHappeo
HomeGuidesAPI Reference
v0.1

AppAdmin PanelHappeo
API Reference
AppAdmin Panel
v0.1

Introduction

  • Basics
  • Concepts
  • Authentication
    • OAuth 2.0
      • Creating OAuth app
      • Authorizing users
      • Using token in API calls
      • User management
    • System Accounts
      • Suspending a system account
      • Revoking an api key
      • Creating an api key
      • Creating a system account
  • Errors
  • Pagination
  • Rate limits & Guidelines
  • API missing?

Happeo Channels API

  • 🏪Channels
    • List channelsget
    • Retrieve a channelget
    • List channel membersget

Happeo Posts API

  • ✉️Posts
    • List postsget
    • Create a postpost
    • Get a postget
    • Update a postput
    • Patch a postpatch
    • Delete a postdel

Happeo Users API

  • 👥Users
    • List usersget
    • Get one userget
    • License a userpost
    • Unlicense a userpost

Search API

  • 🔍Search [BETA]
    • AI Powered keyword searchget
    • AI-powered search with streaming responseget
  • 🌐Search Data
    • Principal Groupsget
    • Principal Usersget
    • Index Groupsget
    • Index Pagesget
    • Index Channelsget
    • Index Commentsget
    • Index Postsget

Happeo Images API

  • 🌄Images
    • Get Image metadataget

Custom Widgets

  • Basics

WidgetSDK

  • Basics

Agents

  • Chat
    • Start a new discussion or return existing onepost
    • List discussions or get by agentId/contextIdget
    • Get a discussion by IDget
    • Delete a discussiondel
    • Continue a discussion with a new messagepost
    • Get a discussion entryget
    • Delete a discussion entrydel
    • Edit a discussion entrypatch
    • Retry a discussion entrypost
    • Get a specific tool taskget
    • Update a tool task statusput
    • Continue conversation with tool task updatepost
  • Agents
    • List all agentsget
    • Get an agent by IDget

Happeo Pages API

  • Page Groups
    • List page groupsget
    • Retrieve a page groupget
  • Pages
    • Retrieve a pageget
Powered by 

Basics

WidgetSDK is a resource that you can utilise with Custom Component Widgets. For full documentation, please check the widgetSDK Github page and Wiki:

  • widgetSDK
  • widgetSDK wiki
  • Examples on how to use

Updated over 1 year ago


Basics
Chat

Updated over 1 year ago


Basics
Chat