This page will help you get started with Ora API 🌊
Welcome
The Ora API will allow you to plug into the same functionality exposed via https://ora.ai. The API reference shows all of the available endpoints, the request parameters, responses, and even allows you to try executing requests.
API Concepts
There are a couple different concepts that might help understanding how to navigate the API:
Chatbots
A chatbot is an entity through which users can send and receive messages. The way in which chatbots interact with users is defined by a variety of factors such as system prompt, history allowance, and model configuration.
Model Configuration
The specific configuration related to a given chatbot, such as the underlying provider and model combination (e.g. OpenAI + GPT-3.5-turbo, Anthropic + Claude Instant, etc), model parameters (e.g. temperature, logit bias, etc), and more.
Saved chatbots
Saved chatbots relate users and chatbots.
Conversations
A conversation is a set of messages between a single user and a chatbot.
Shared conversations
Shared conversations are publicly visible subsets of a conversation.
Profiles
A profile is additional information about a user.
Keys
A key is UUID formatted string and can be used to authenticate requests to the Ora API. More details are available in the Authentication section below.
Authentication
We use API tokens to authenticate requests. API Keys should be included in the headers of all requests like this:
{
"authorization": "Bearer <YOUR_API_KEY>"
}
Get an API Key
To obtain an API key, go to the developer settings on the Ora website https://ora.ai/settings/developer. At the moment, you will need a subscription to get started.
Questions or Issues
Join us on Discord!