Skip to content

python-client.md

Latest commit

 

History

History
51 lines (36 loc) · 957 Bytes

python-client.md

File metadata and controls

51 lines (36 loc) · 957 Bytes
Raw

Python Client

A simple urllib3 client is available at examples/python_client.py.

Install the Python dependency:

python3 -m pip install urllib3

Submit an image upload and wait for the final result:

python3 examples/python_client.py upload /path/to/image.png

If API key authentication is enabled:

python3 examples/python_client.py \
  --api-key replace-with-a-long-random-secret \
  upload /path/to/image.png

Submit a server-side image path:

python3 examples/python_client.py path /path/to/image.png

Use another task prompt:

python3 examples/python_client.py \
  --task-prompt 'OCR with Region' \
  upload /path/to/image.png

Send the final job result to a webhook:

python3 examples/python_client.py \
  --webhook-url https://example.com/florence-webhook \
  upload /path/to/image.png

Fetch an existing job:

python3 examples/python_client.py job <job-id>