Skip to content

Latest commit

 

History

History
52 lines (39 loc) · 1.5 KB

README.md

File metadata and controls

52 lines (39 loc) · 1.5 KB
Raw

DeepZoom API

CodeFactor

Pyramiding

This application is an asynchronous endpoint for creating deep zoom image file formats for images, for use with EBrains related software. Main dependencies are asyncio, aiofiles, aiohttp and fastapi.

API Endpoints

  • GET /deepzoom/health - Service health status
  • POST /deepzoom - Submit image processing task
  • GET /deepzoom/status/{task_id} - Check task status

Usage

{
    "path" : "str",
    "target_path" : "str",
    "token" : "str"
}

Files paths should be submitted individually, for each file you will be assigned a task_id. You can query your tasks status with the status endpoint.

sequenceDiagram
    participant Client
    participant API
    participant TaskManager
    participant TaskStore
    participant Storage
    participant Bucket

    Client->>API: POST /deepzoom
    API->>TaskManager: Create new task
    TaskManager->>TaskStore: Store task details
    API-->>Client: Return task_id
    
    Note over TaskManager: Async Processing
    Bucket->>TaskManager: Download image
    TaskManager->>Storage: Create DeepZoom
    TaskManager->>Storage: Zip files
    TaskManager->>Bucket: Upload result
    TaskManager->>TaskStore: Update status

    Client->>API: GET /deepzoom/status/{task_id}
    API->>TaskStore: Get task status
    API-->>Client: Return task details
Loading