Rosepetal API Documentation

Welcome to the Rosepetal API documentation. This API provides endpoints for managing computer vision datasets, images, and monitoring sessions.

Overview

The Rosepetal API is built with Firebase and provides the following main functionalities:

• Dataset Management: Read and query dataset information
• Image Operations: Retrieve and analyze images
• Session Monitoring: Track monitoring sessions and real-time data

Base URL

All API endpoints are relative to your Firebase project's Cloud Functions URL:

https://your-region-your-project.cloudfunctions.net/api/

Authentication

The API uses Firebase Authentication. Include your authentication token in the request headers:

Authorization: Bearer <your-firebase-token>

Quick Start

1. Datasets - Learn how to query datasets and their metadata
2. Images - Understand image retrieval and analysis endpoints
3. Sessions - Monitor real-time sessions and data flows

API Structure

Resource	Description
/dataset/	Dataset information and CSV generation
/image/	Image operations and analysis
/monitor/	Session monitoring and control

Response Format

All API responses follow this standard format:

{
  "data": {
    "error": false,
    "result": "response data or success message"
  }
}

Error responses include additional error information:

{
  "data": {
    "error": true,
    "result": "Error description"
  }
}

Rate Limits

• Standard endpoints: 1000 requests per minute
• Heavy operations (CSV generation, ZIP downloads): 10 requests per minute