klevze/vision
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs: add X-API-Key header to curl examples

Browse Source
This commit is contained in:
Gregor Klevže
2026-03-21 09:22:29 +01:00
parent 3b300ab3b4
commit 788e193c8a
1 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@@ -28,14 +28,14 @@ curl -H "X-API-Key: <your-api-key>" https://vision.klevze.net/health
### With URL
```bash
curl -X POST https://vision.klevze.net/analyze/all \
curl -H "X-API-Key: <your-api-key>" -X POST https://vision.klevze.net/analyze/all \
-H "Content-Type: application/json" \
-d '{"url":"https://files.skinbase.org/img/aa/bb/cc/md.webp","limit":5}'
```
### With file upload (multipart)
```bash
curl -X POST https://vision.klevze.net/analyze/all/file \
curl -H "X-API-Key: <your-api-key>" -X POST https://vision.klevze.net/analyze/all/file \
-F "file=@/path/to/image.webp" \
-F "limit=5"
```
@@ -44,26 +44,26 @@ curl -X POST https://vision.klevze.net/analyze/all/file \
### CLIP tags
```bash
curl -X POST https://vision.klevze.net/analyze/clip -H "Content-Type: application/json" \
curl -H "X-API-Key: <your-api-key>" -X POST https://vision.klevze.net/analyze/clip -H "Content-Type: application/json" \
-d '{"url":"https://files.skinbase.org/img/aa/bb/cc/md.webp","limit":5}'
```
### CLIP tags (file)
```bash
curl -X POST https://vision.klevze.net/analyze/clip/file \
curl -H "X-API-Key: <your-api-key>" -X POST https://vision.klevze.net/analyze/clip/file \
-F "file=@/path/to/image.webp" \
-F "limit=5"
```
### BLIP caption
```bash
curl -X POST https://vision.klevze.net/analyze/blip -H "Content-Type: application/json" \
curl -H "X-API-Key: <your-api-key>" -X POST https://vision.klevze.net/analyze/blip -H "Content-Type: application/json" \
-d '{"url":"https://files.skinbase.org/img/aa/bb/cc/md.webp","variants":3}'
```
### BLIP caption (file)
```bash
curl -X POST https://vision.klevze.net/analyze/blip/file \
curl -H "X-API-Key: <your-api-key>" -X POST https://vision.klevze.net/analyze/blip/file \
-F "file=@/path/to/image.webp" \
-F "variants=3" \
-F "max_length=60"
@@ -71,13 +71,13 @@ curl -X POST https://vision.klevze.net/analyze/blip/file \
### YOLO detect
```bash
curl -X POST https://vision.klevze.net/analyze/yolo -H "Content-Type: application/json" \
curl -H "X-API-Key: <your-api-key>" -X POST https://vision.klevze.net/analyze/yolo -H "Content-Type: application/json" \
-d '{"url":"https://files.skinbase.org/img/aa/bb/cc/md.webp","conf":0.25}'
```
### YOLO detect (file)
```bash
curl -X POST https://vision.klevze.net/analyze/yolo/file \
curl -H "X-API-Key: <your-api-key>" -X POST https://vision.klevze.net/analyze/yolo/file \
-F "file=@/path/to/image.webp" \
-F "conf=0.25"
```
@@ -86,14 +86,14 @@ curl -X POST https://vision.klevze.net/analyze/yolo/file \
### Store image embedding by URL
```bash
curl -X POST https://vision.klevze.net/vectors/upsert \
curl -H "X-API-Key: <your-api-key>" -X POST https://vision.klevze.net/vectors/upsert \
-H "Content-Type: application/json" \
-d '{"url":"https://files.skinbase.org/img/aa/bb/cc/md.webp","id":"img-001","metadata":{"category":"wallpaper"}}'
```
### Store image embedding by file upload
```bash
curl -X POST https://vision.klevze.net/vectors/upsert/file \
curl -H "X-API-Key: <your-api-key>" -X POST https://vision.klevze.net/vectors/upsert/file \
-F "file=@/path/to/image.webp" \
-F 'id=img-002' \
-F 'metadata_json={"category":"photo"}'
@@ -101,31 +101,31 @@ curl -X POST https://vision.klevze.net/vectors/upsert/file \
### Search similar images by URL
```bash
curl -X POST https://vision.klevze.net/vectors/search \
curl -H "X-API-Key: <your-api-key>" -X POST https://vision.klevze.net/vectors/search \
-H "Content-Type: application/json" \
-d '{"url":"https://files.skinbase.org/img/aa/bb/cc/md.webp","limit":5}'
```
### Search similar images by file upload
```bash
curl -X POST https://vision.klevze.net/vectors/search/file \
curl -H "X-API-Key: <your-api-key>" -X POST https://vision.klevze.net/vectors/search/file \
-F "file=@/path/to/image.webp" \
-F "limit=5"
```
### List collections
```bash
curl https://vision.klevze.net/vectors/collections
curl -H "X-API-Key: <your-api-key>" https://vision.klevze.net/vectors/collections
```
### Get collection info
```bash
curl https://vision.klevze.net/vectors/collections/images
curl -H "X-API-Key: <your-api-key>" https://vision.klevze.net/vectors/collections/images
```
### Delete points
```bash
curl -X POST https://vision.klevze.net/vectors/delete \
curl -H "X-API-Key: <your-api-key>" -X POST https://vision.klevze.net/vectors/delete \
-H "Content-Type: application/json" \
-d '{"ids":["img-001","img-002"]}'
```