Aıon

Documentation

Datasets API Reference

Create, organize, and export datasets from batch processing results

Dataset Management

Datasets allow you to organize and export results from batch processing operations. Create datasets from completed batches to preserve results, enable sharing, and facilitate analysis and reporting workflows.

Dataset Management

POST/api/v2/datasets

Create a new dataset from batch results. Returns 201 Created.

Request

{
  "batch_id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Safety Equipment Dataset Q1 2024",
  "description": "Workplace safety equipment detection results",
  "format_config": {
    "csv_delimiter": ",",
    "include_timestamps": true
  }
}


// Parameters:
// - batch_id: UUID of the completed batch (required)
// - name: Dataset name (required)
// - description: Optional description
// - format_config: Optional format-specific configuration

Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Safety Equipment Dataset Q1 2024",
  "description": "Workplace safety equipment detection results",
  "batch_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "pending",
  "created_at": "2025-01-15T10:30:00Z",
  "updated_at": "2025-01-15T10:30:00Z",
  "batch_status": "completed",
  "total_items": 500,
  "successful_items": 487,
  "export_count": 0,
  "supported_formats": ["csv", "coco", "yolo", "pascal_voc"],
  "latest_export": null
}
GET/api/v2/datasets

List all datasets with optional filtering

Request

// Query parameters:
?status=ready     // Optional: pending | processing | ready | failed
&limit=100        // Optional: max results (default 100)
&offset=0         // Optional: pagination offset (default 0)

Response

{
  "datasets": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Safety Equipment Dataset Q1 2024",
      "description": "Workplace safety equipment detection results",
      "batch_id": "550e8400-e29b-41d4-a716-446655440000",
      "status": "ready",
      "created_at": "2025-01-15T10:30:00Z",
      "updated_at": "2025-01-20T15:00:00Z",
      "batch_status": "completed",
      "total_items": 500,
      "successful_items": 487,
      "export_count": 3,
      "supported_formats": ["csv", "coco", "yolo", "pascal_voc"],
      "latest_export": {
        "export_id": "export_001",
        "format": "csv",
        "created_at": "2025-01-20T15:00:00Z"
      }
    }
  ],
  "total_count": 1,
  "limit": 100,
  "offset": 0,
  "has_more": false
}
GET/api/v2/datasets/{dataset_id}

Get detailed dataset information

Response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Safety Equipment Dataset Q1 2024",
  "description": "Workplace safety equipment detection results",
  "batch_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "ready",
  "created_at": "2025-01-15T10:30:00Z",
  "updated_at": "2025-01-20T15:00:00Z",
  "batch_status": "completed",
  "total_items": 500,
  "successful_items": 487,
  "export_count": 3,
  "supported_formats": ["csv", "coco", "yolo", "pascal_voc"],
  "latest_export": {
    "export_id": "export_003",
    "format": "csv",
    "status": "completed",
    "created_at": "2025-01-20T15:00:00Z",
    "file_size_bytes": 245678
  }
}
GET/api/v2/datasets/statistics/summary

Get aggregated dataset statistics. Accepts ?days=30 query parameter.

Response

{
  "dataset_statistics": {
    "total_datasets": 15,
    "avg_items_per_dataset": 500.0,
    "total_items": 7500,
    "by_status": {
      "ready": 12,
      "pending": 1,
      "processing": 2
    }
  },
  "export_statistics": {
    "total_exports": 45,
    "total_data_volume": 125000000,
    "by_format": {
      "csv": { "count": 25, "total_size": 75000000, "avg_export_time_seconds": 2.5 },
      "coco": { "count": 15, "total_size": 40000000, "avg_export_time_seconds": 4.1 },
      "yolo": { "count": 5, "total_size": 10000000, "avg_export_time_seconds": 1.8 }
    }
  },
  "popular_formats": [
    { "format": "csv", "usage_count": 25 },
    { "format": "coco", "usage_count": 15 },
    { "format": "yolo", "usage_count": 5 }
  ],
  "period": {
    "since": "2025-01-07T00:00:00Z",
    "until": "2025-02-07T00:00:00Z"
  }
}

Dataset Export

POST/api/v2/datasets/{dataset_id}/export

Export dataset to various formats

Request

{
  "format": "csv",
  "options": {
    "delimiter": ","
  },
  "include_failed_items": false
}


// Parameters:
// - format: "csv" | "coco" | "yolo" | "pascal_voc" (required)
// - options: Optional format-specific settings (e.g. CSV delimiter)
// - include_failed_items: Include failed batch items (default false)

Response

{
  "export_id": "550e8400-e29b-41d4-a716-446655440000",
  "dataset_id": "660f9500-e29b-41d4-a716-446655440000",
  "format": "csv",
  "status": "completed",
  "record_count": 487,
  "content": null,
  "file_path": "/exports/dataset_550e8400.csv",
  "download_url": "https://api.aionvision.tech/exports/dataset_550e8400.csv",
  "file_size_bytes": 245678,
  "content_type": "text/csv",
  "exported_at": "2025-01-15T10:30:00Z"
}

Related

Batch Processing Guide

Creating batches for datasets

Data Export Reference

Exporting processing history