Skip to main content

​
API Reference

Welcome to the Rippletide API documentation. This API allows you to manage your agents, knowledge base, and interact with your conversational AI agents.

​
Authentication

All API requests require an API key in the header: 
x-api-key: your-api-key-here

​
Base URL

https://agent.rippletide.com/api/sdk

​
Getting Started

  1. Get an API Key: Create an account on Eval Platform and go to Settings to get your API key
  2. Create an Agent: Use the /agent endpoint to create your first agent
  3. Add Knowledge: Use the /q-and-a endpoint to add Q&A pairs to your agent
  4. Start Chatting: Use the /chat/{agent_id} endpoint to interact with your agent
For more detailed guides, see: