Skip to main content

​
Welcome to Oration AI

Oration AI provides a powerful API for creating and managing AI-powered conversations across various communication channels. Our API enables you to integrate advanced conversational AI capabilities into your applications, supporting chat, telephony, and web interfaces.

​
Key Features

Currently, Oration AI APIs only support creating conversations.
  • Create conversations: Easily initiate single or multiple AI-driven conversations with a single API call.
  • Get conversation details: Get the latest conversation status and details for any conversation.

​
Getting Started

To use the Oration AI API, you’ll need:
  1. An API Key
  2. A Workspace ID
These credentials should be included in the headers of your API requests: 
{
  "x-api-key": "your-api-key-here",
  "x-workspace-id": "your-workspace-id-here"
}

​
Base URL

All API requests should be made to: 
https://www.oration.ai/api/v2

​
Example Request

Here’s a simple example of creating a conversation using cURL: 
curl --request POST \
  --url https://www.oration.ai/api/v2/conversations \
  --header 'x-api-key: your-api-key-here' \
  --header 'x-workspace-id: your-workspace-id-here' \
  --data '{
  "conversations": [
    {
      "agentId": "<agent-uuid>",
      "conversationType": "telephony",
      "toPhoneNumber": "+1234567890",
      "dynamicVariables": {
        "name": "John Doe"
      }
    }
  ]
}'

​
What’s Next?

Explore our API endpoints to learn how to:
  • Create and manage conversations
  • Work with different conversation types
  • Handle API responses and errors
We’re excited to see what you’ll build with Oration AI!