raia
  • Welcome to raia v2
  • Why use raia
  • Core Features of raia
  • Multi-Agent Architecture
  • Launching an AI Agent
    • Step-by-Step Guide
  • AI Training
    • Setup of Instructions
    • Documents for Training
    • Setup of Knowledge Base
  • AI Agent Skills
  • Setup of Skills
    • Live Chat
    • SMS
    • Email
    • Voice
    • Scoring
    • Webhooks
    • API
    • Live Chat SDK
    • Functions
    • Memory
  • AI Agent Packs
  • Multi-Level Access & Agent Security
  • Setup of Access Control
  • Integration & Workflow
    • n8n Node
  • Monitoring & Reporting
  • API Documentation
  • Sample AI Agent Roles
    • AI Sales Agent
    • AI Support Agent
    • AI Content Writer
    • AI Project Manager
  • Copilot
    • Copilot vs Chat GPT
    • How it works
    • Admin Mode
    • Human in the Loop
    • Human Feedback
  • OpenAI Integration
Powered by GitBook
On this page

API Documentation

PreviousMonitoring & ReportingNextSample AI Agent Roles

Last updated 22 days ago

The API Documentation can be .

For OpenAPI specifications you can . OpenAPI is a widely used, industry-standard format for describing HTTP APIs. It was previously known as Swagger and is now maintained by the OpenAPI Initiative. OpenAPI documents provide a machine-readable and human-friendly way to define and understand REST APIs, enabling developers to design, build, and consume APIs more effectively.

Each Agent has an API Key which you generated under the API Skill when editing the Agent,

Pass the API Key via the header as Agent-Secret-Key

Example: Conversations Start

curl -X POST https://api.raia2.com/external/conversations/start \
  -H "Content-Type: application/json" \
  -H "Agent-Secret-Key: XXXXXXXXXX" \
  -d '{
    "firstName": "Greg",
    "lastName": "Giglio",
    "channel": "sms",
    "context": "You are talking with mortgage lead Greg Giglio. Their email is XXXXXXXX Their phone is XXXXXXX. They previously spoke with Andrew S. Russell at RCG Mortgage. You are reconnecting with this opportunity to see if they are in the market for a mortgage.",
    "source": "CRM",
    "fkId": "12345",
    "fkUserId": "123456789", 
    "email": "demo@demo.com",
    "phoneNumber": "+14567890101", 
    "smsIntroduction": "Hi, Greg. It's Mindy"
  }'

found here
view here