Skip to content

Commit 93eb0ca

Browse files
committed
docs: Update readme to use v1
- Update curl command to use the V1 API. As it is now, it fails since it's still using v1alpha. - Update the API UI image that was showing Swagger (not available anymore in Docling Serve) and replace it with screenshot from the new FastAPI-based UI. Signed-off-by: Thomas Vitale <ThomasVitale@users.noreply.github.com>
1 parent 4c7207b commit 93eb0ca

File tree

3 files changed

+3
-2
lines changed

3 files changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ The server is available at
3636
- API <http://127.0.0.1:5001>
3737
- API documentation <http://127.0.0.1:5001/docs>
3838
- UI playground <http://127.0.0.1:5001/ui>
39-
![swagger.png](img/swagger.png)
39+
40+
![API documentation](img/fastapi-ui.png)
4041

4142
Try it out with a simple conversion:
4243

@@ -46,7 +47,7 @@ curl -X 'POST' \
4647
-H 'accept: application/json' \
4748
-H 'Content-Type: application/json' \
4849
-d '{
49-
"http_sources": [{"url": "https://arxiv.org/pdf/2501.17887"}]
50+
"sources": [{"kind": "http", "url": "https://arxiv.org/pdf/2501.17887"}]
5051
}'
5152
```
5253

img/fastapi-ui.png

226 KB
Loading

img/swagger.png

-23.9 KB
Binary file not shown.

0 commit comments

Comments
 (0)