Introduction

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

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.
Tickets: Create, search, and update tickets; change status, assign teammates, and react to webhooks.

Getting Started

To use the Oration AI API, you’ll need:

An API key (x-api-key)
A workspace identifier: either x-workspace-slug or x-workspace-id (one is required; you do not need both)

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"
}

You can send x-workspace-slug instead of x-workspace-id when you know your workspace slug:

{
  "x-api-key": "your-api-key-here",
  "x-workspace-slug": "your-workspace-slug-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
Automate tickets and subscribe to ticket webhooks
Handle API responses and errors

Create conversations

Start AI voice or chat conversations from your backend.

Search tickets

Filter and paginate tickets with the query builder.

We’re excited to see what you’ll build with Oration AI!

API Documentation

Conversations

Jobs

Customers

Tickets

Welcome to Oration AI

Key Features

Getting Started

Base URL

Example Request

What’s Next?

Create conversations

Search tickets

​Welcome to Oration AI

​Key Features

​Getting Started

​Base URL

​Example Request

​What’s Next?

Create conversations

Search tickets

Welcome to Oration AI

Key Features

Getting Started

Base URL

Example Request

What’s Next?