Heyoo API Reference - Introduction

Heyoo’s API is now generally available.

Base URL

Heyoo’s API is built on REST principles and is served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported. The Base URL for all API endpoints is:

Terminal

https://app.heyoo.ai/api

Authentication

Authentication to Heyoo’s API is performed via the Authorization header with a Bearer token. To authenticate, you need to include the Authorization header with the word Bearer followed by your API key in your requests like so:

Terminal

Authorization: Bearer <Your-Token>

Learn more about how to get your API key.

Response Codes

The API returns standard HTTP response codes to indicate the success or failure of an API request. Here are a few examples:

Code	Description
`200`	The request was successful.
`400`	The request was invalid or cannot be served.
`401`	The request requires user authentication.
`403`	The server understood the request, but refuses to authorize it.
`404`	The requested resource could not be found.
`429`	Too many requests.
`500`	The server encountered an unexpected condition which prevented it from fulfilling the request.

Caveats

Heyoo’s API is currently in public beta and is subject to change. However, we will do our best to keep breaking changes to a minimum.

​Base URL

​Authentication

​Response Codes

​Caveats

Base URL

Authentication

Response Codes

Caveats