tommulder commited on
Commit
3ebae8a
Β·
1 Parent(s): e2988e6

Remove duplicate 'Accessing the API' section and consolidate into Quick Start

Browse files
Files changed (1) hide show
  1. README.md +9 -31
README.md CHANGED
@@ -44,7 +44,6 @@ This Hugging Face Space provides a production-ready API for detecting and classi
44
  - [Python Client](#python-client)
45
  - [JavaScript Client](#javascript-client)
46
  - [🚨 Error Handling](#-error-handling)
47
- - [Accessing the API](#accessing-the-api)
48
  - [🎯 Test Results Summary](#-test-results-summary)
49
  - [πŸ”’ Security & Privacy](#-security--privacy)
50
  - [πŸ“Š Monitoring](#-monitoring)
@@ -75,11 +74,17 @@ This Hugging Face Space provides a production-ready API for detecting and classi
75
 
76
  ## πŸš€ Quick Start
77
 
 
 
 
 
 
 
78
  ### Image Detection
79
 
80
  ```bash
81
  curl -X POST "https://algoryn-yolo-e-idcard.hf.space/v1/id/detect" \
82
- -F "file=@document.jpg" \
83
  -F "min_confidence=0.5" \
84
  -F "return_crops=false"
85
  ```
@@ -88,10 +93,10 @@ curl -X POST "https://algoryn-yolo-e-idcard.hf.space/v1/id/detect" \
88
 
89
  ```bash
90
  curl -X POST "https://algoryn-yolo-e-idcard.hf.space/v1/id/detect-video" \
91
- -F "file=@document_video.mp4" \
92
  -F "min_confidence=0.5" \
93
  -F "sample_fps=2.0" \
94
- -F "max_detections=5" \
95
  -F "return_crops=false"
96
  ```
97
 
@@ -342,33 +347,6 @@ Error responses include detailed error messages:
342
  }
343
  ```
344
 
345
- ## Accessing the API
346
-
347
- **Health check**
348
-
349
- ```bash
350
- curl https://algoryn-yolo-e-idcard.hf.space/health
351
- ```
352
-
353
- **Image detection**
354
-
355
- ```bash
356
- curl -X POST "https://algoryn-yolo-e-idcard.hf.space/v1/id/detect" \
357
- -F "file=@your_image.jpg" \
358
- -F "min_confidence=0.5" \
359
- -F "return_crops=false"
360
- ```
361
-
362
- **Video Detection**
363
-
364
- ```bash
365
- curl -X POST "https://algoryn-yolo-e-idcard.hf.space/v1/id/detect-video" \
366
- -F "file=@your_video.mp4" \
367
- -F "min_confidence=0.5" \
368
- -F "sample_fps=2.0" \
369
- -F "max_detections=10" \
370
- -F "return_crops=false"
371
- ```
372
 
373
  ## 🎯 Test Results Summary
374
 
 
44
  - [Python Client](#python-client)
45
  - [JavaScript Client](#javascript-client)
46
  - [🚨 Error Handling](#-error-handling)
 
47
  - [🎯 Test Results Summary](#-test-results-summary)
48
  - [πŸ”’ Security & Privacy](#-security--privacy)
49
  - [πŸ“Š Monitoring](#-monitoring)
 
74
 
75
  ## πŸš€ Quick Start
76
 
77
+ ### Health Check
78
+
79
+ ```bash
80
+ curl https://algoryn-yolo-e-idcard.hf.space/health
81
+ ```
82
+
83
  ### Image Detection
84
 
85
  ```bash
86
  curl -X POST "https://algoryn-yolo-e-idcard.hf.space/v1/id/detect" \
87
+ -F "file=@your_image.jpg" \
88
  -F "min_confidence=0.5" \
89
  -F "return_crops=false"
90
  ```
 
93
 
94
  ```bash
95
  curl -X POST "https://algoryn-yolo-e-idcard.hf.space/v1/id/detect-video" \
96
+ -F "file=@your_video.mp4" \
97
  -F "min_confidence=0.5" \
98
  -F "sample_fps=2.0" \
99
+ -F "max_detections=10" \
100
  -F "return_crops=false"
101
  ```
102
 
 
347
  }
348
  ```
349
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
350
 
351
  ## 🎯 Test Results Summary
352