O
Oliver

Getting Started with Oliver Chat API

This guide will walk you through the steps to integrate with the Oliver Chat API and help you get up and running quickly.

Important: Before using the Oliver Chat API in a production environment, ensure you've reviewed our compliance requirements, especially if you're handling financial data.

Step 1: Register for an API Key

To use the Oliver Chat API, you need to obtain an API key. If you don't already have one, you can get it by:

  1. Signing up at https://oliverchat.com/register
  2. Going to your account dashboard
  3. Navigating to "API Keys" section
  4. Clicking "Generate New API Key"

Note: Keep your API key secure. Do not share it or expose it in client-side code.

Step 2: Make Your First API Request

Let's start by making a simple request to check if your API key is working correctly:

Endpoint

GET https://api.oliverchat.com/v1/system/status

Headers

Authorization: Bearer YOUR_API_KEY
Accept: application/json

Example Response

{
  "success": true,
  "data": {
    "status": "operational",
    "version": "1.0.0",
    "services": {
      "ai": "operational",
      "search": "operational",
      "rag": "operational",
      "compliance": "operational"
    }
  },
  "message": "System is operational"
}

Step 3: Create a Simple Chat Interaction

Now let's try sending a message to Oliver and getting a response:

Endpoint

POST https://api.oliverchat.com/v1/chat/messages

Headers

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
Accept: application/json

Request Body

{
  "message": "Hello, I'd like to learn about investment strategies.",
  "chat_id": null,  // null creates a new chat
  "rag_containers": []  // optional RAG container IDs
}

Example Response

{
  "success": true,
  "data": {
    "chat_id": "c123456789",
    "message_id": "m987654321",
    "response": "Hello! I'd be happy to discuss investment strategies with you. There are several approaches depending on your goals, risk tolerance, and time horizon...",
    "created_at": "2025-03-11T14:30:45Z"
  },
  "message": "Message sent successfully"
}

Pro Tip: For a more natural experience with real-time responses, use our streaming endpoint. See the Streaming documentation for details.

Step 4: Explore Advanced Features

Now that you've completed a basic integration, you can explore more advanced features:

Client Libraries

To make integration easier, we offer client libraries in several programming languages:

JavaScript/Node.js

npm install oliver-chat-api

Python

pip install oliver-chat-api

PHP

composer require oliver-chat/api

Next Steps

Now that you're familiar with the basics, here are some recommended next steps:

Continue to Authentication Back to Overview