API Reference Overview

All API requests require authentication using an API key. Include your API key in the X-API-Key header:

curl -H "X-API-Key: YOUR_API_KEY" https://api.synvo.ai/endpoint

API Endpoints

Context Management

Manage your documents, files, and directories:

• Create Directory - Create a virtual directory
• List File - List directory contents
• Upload File - Upload a file
• Download File - Download a file by ID
• Update File - Move or rename files
• Delete File - Delete a file by ID
• Get File Thumbnail - Get file thumbnails
• Get File Status - Check file processing status

Context Generation Layer

Search and query functionality:

• Search File - AI-powered file search
• Get Context - Submit queries to the AI
• Get File Metadata By ID
• Get File Metadata By File Path
• Get User Profile
• Get User Events

Session & Feedback Management

Manage conversation session histories:

• List History - List all session histories by user
• Get History - Get message history for a conversation session
• Delete History - Delete a session history
• Like Message - Like an AI response
• Dislike Message - Dislike an AI response
• Get Message Feedback - Get feedback status
• Delete Message Feedback - Remove feedback

Interactive Documentation

Each endpoint page includes:

• Detailed descriptions of parameters and responses
• Code examples in multiple languages (cURL, Python, JavaScript)
• Interactive testing capabilities
• Response schemas and examples

Authentication

All endpoints require authentication using an API key. You can obtain an API key from your account settings or create one using the Create API Key endpoint.

Base URL

The API base URL is: https://api.synvo.ai

Rate Limits

API requests are subject to rate limiting. Please refer to your account dashboard for current limits and usage.