Skip to content

Commit 5d4f927

Browse files
committed
readme update endpoints
1 parent 3088968 commit 5d4f927

1 file changed

Lines changed: 12 additions & 1 deletion

File tree

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,15 @@ The API will provide endpoints for generating PDFs on the fly and returning them
1919

2020
#### From an URL
2121

22-
Endpoint: `/from-url?url=<URL of the page we want to convert to PDF>`
22+
Endpoint: `GET /from-url?url=`
23+
24+
Parameters:
25+
- `url`: URL of the page we want to convert to PDF.
26+
27+
Returns the rendered PDF from the provided URL, or a JSON with an error message and status.
28+
29+
#### Health status
30+
31+
Endpoint: `GET /health`
32+
33+
Returns the current status in JSON. Status code may be 200 (active) or 503 (not ready).

0 commit comments

Comments
 (0)